Renderer/src/main/java/electrosphere/game/data/item/Item.java

package electrosphere.game.data.item;

import electrosphere.game.data.common.CommonEntityType;

/**
 * Data on a given item
 */
public class Item extends CommonEntityType {

    //the idle animation for the item
    String idleAnim;
    //the path for the icon texture for this item
    String iconPath;
    //weapon data for this item if it is an item
    WeaponData weaponData;
    //The data defining how this item is equipped
    EquipData equipData;

    /**
     * The audio data for the item
     */
    ItemAudio itemAudio;

    /**
     * A hook that should fire client-side when the player uses this as their primary item
     */
    String clientSidePrimary;

    /**
     * A hook that should fire client-side when the player uses this as their primary item
     */
    String clientSideSecondary;

    /**
     * The block data for this item
     */
    ItemBlockData itemBlockData;

    /**
     * the idle animation for the item
     * @return
     */
    public String getIdleAnim(){
        return idleAnim;
    }
    
    /**
     * the path for the icon texture for this item
     * @return
     */
    public String getIconPath(){
        return iconPath;
    }

    /**
     * weapon data for this item if it is an item
     * @return
     */
    public WeaponData getWeaponData(){
        return weaponData;
    }

    /**
     * Gets the equip data for the item type
     * @return The equip data
     */
    public EquipData getEquipData(){
        return equipData;
    }

    /**
     * Gets the item audio data
     * @return The audio data if specified, null otherwise
     */
    public ItemAudio getItemAudio(){
        return itemAudio;
    }
    
    /**
     * Gets the client side primary hook to fire
     * @return The hook
     */
    public String getClientSidePrimary(){
        return clientSidePrimary;
    }

    /**
     * Gets the client side secondary hook to fire
     * @return The hook
     */
    public String getClientSideSecondary(){
        return clientSideSecondary;
    }

    /**
     * Gets the block data for the item
     * @return THe block data
     */
    public ItemBlockData getItemBlockData(){
        return this.itemBlockData;
    }

}