001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package net.tridentsdk.entity.vehicle;
019
020import net.tridentsdk.base.BlockSnapshot;
021import net.tridentsdk.entity.Entity;
022
023/**
024 * Represents the generic Minecart
025 *
026 * @author TridentSDK Team
027 */
028public interface MinecartBase extends Entity {
029    /**
030     * Represents this Minecart's display tile, in the form of a BlockState
031     *
032     * @return the display tile of this Minecart
033     */
034    BlockSnapshot displayTitle();
035
036    /**
037     * Set this Minecart's display tile to the specified block state
038     *
039     * @param blockState the state to set this to
040     */
041    void setDisplayTile(BlockSnapshot blockState);
042
043    /**
044     * Get the offset for this Minecart's display tile
045     *
046     * @return the offset for this Minecart's display tile
047     */
048    int titleOffset();
049
050    /**
051     * Set the offset for this Minecart's display tile
052     *
053     * @param offset the offset to set
054     */
055    void setDisplayTileOffset(int offset);
056
057    /**
058     * Gets the custom name of this Minecart
059     *
060     * @return the custom name of this Minecart
061     */
062    String name();
063
064    /**
065     * Sets the custom name of this Minecart
066     *
067     * @param name the new value of the custom name
068     */
069    void setName(String name);
070}