SCR_BaseRadialCommand.c

Go to the documentation of this file.

[BaseContainerProps("", "Entry of one command"), SCR_BaseGroupCommandTitleField("m_sCommandName")]
class SCR_BaseRadialCommand
{
    [Attribute("", UIWidgets.EditBox, "Unique name of the command")]
    protected string m_sCommandName;
    
    [Attribute("{2EFEA2AF1F38E7F0}UI/Textures/Icons/icons_wrapperUI-64.imageset", UIWidgets.ResourceNamePicker, "Imageset source for display icon" )]
    protected ResourceName m_sImageset;
    
    [Attribute("", UIWidgets.EditBox, "Name of the icon associated to the command, taken from appropriate imageset set in the radial menu" )]
    protected string m_sIconName;
    
    //------------------------------------------------------------------------------------------------
    // Returns true if the command was executed succesfully, false otherwise.
    bool Execute(IEntity cursorTarget, IEntity target, vector targetPosition, int playerID, bool isClient)
    {
        return true;
    }
    
    //------------------------------------------------------------------------------------------------
    string GetIconName()
    {
        return m_sIconName;
    }
    
    //------------------------------------------------------------------------------------------------
    ResourceName GetIconImageset()
    {
        return m_sImageset;
    }
        
    //------------------------------------------------------------------------------------------------
    string GetCommandName()
    {
        return m_sCommandName;
    }
            
    //------------------------------------------------------------------------------------------------
    bool CanRoleShow()
    {
        return true;
    }
    
    //------------------------------------------------------------------------------------------------
    bool CanBeShownInCurrentLifeState()
    {
        return true;
    }
    
    //------------------------------------------------------------------------------------------------
    bool CanBeShown()
    {
        return true;
    }
    
    //------------------------------------------------------------------------------------------------
    bool CanShowOnMap()
    {
        return true;
    }
    
    //------------------------------------------------------------------------------------------------
    bool CanBePerformed()
    {
        return true;
    }
}