SCR_EmoteBaseCommand Interface Reference

Inheritance diagram for SCR_EmoteBaseCommand:

Public Member Functions
override bool	Execute (IEntity cursorTarget, IEntity target, vector targetPosition, int playerID, bool isClient)
	method that will be executed when the command is selected in the menu This method is right now broadcaasted to all clients, so if the command is intended only for specific clients, it needs to be filtered inside
override bool	CanBePerformed (notnull SCR_ChimeraCharacter user)
	Returns true if user (player) of the command can issue the command.
Public Member Functions inherited from SCR_BaseRadialCommand
void	VisualizeCommand (vector targetPosition)
void	VisualizeCommandPreview (vector targetPosition)
string	GetIconName ()
string	GetCommandDisplayName ()
ResourceName	GetIconImageset ()
string	GetCommandName ()
bool	CanRoleShow ()
bool	CanBeShownInCurrentLifeState ()
bool	CanBeShown ()
bool	CanShowOnMap ()
bool	CanBeExecuted (notnull IEntity target)
	Returns true if target of the command - typically cursortarget - can execute the command.
LocalizedString	GetCannotExecuteReason ()
LocalizedString	GetCannotPerformReason ()

Protected Attributes
bool	m_bUnequipItems
int	m_iGestureID
ref array< ref ECharacterStance >	m_aAllowedStances
Protected Attributes inherited from SCR_BaseRadialCommand
string	m_sCommandName
string	m_sCommandDisplayName
ResourceName	m_sImageset
string	m_sIconName
SCR_ECharacterRank	m_eRequiredRank
LocalizedString	m_sCannotPerformReason
LocalizedString	m_sCannotExecuteReason

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseRadialCommand
void	SetCannotExecuteReason (LocalizedString newReason)
void	SetCannotPerformReason (LocalizedString newReason)
Static Protected Attributes inherited from SCR_BaseRadialCommand
static const LocalizedString	CANNOT_PERFORM_RANK_TOO_LOW = "#AR-Commanding_CannotPefrorm_RankTooLow"
static const LocalizedString	CANNOT_EXECUTE_SOLDIER_NA = "#AR-Commanding_CannotExecute_SoldierNotAvailable"

Member Function Documentation

CanBePerformed()

override bool SCR_EmoteBaseCommand.CanBePerformed

(

notnull SCR_ChimeraCharacter

user

)

Returns true if user (player) of the command can issue the command.

Parameters

[in]

user

- the commander's chimera character

Implements SCR_BaseRadialCommand.

Execute()

override bool SCR_EmoteBaseCommand.Execute	(	IEntity	cursorTarget,
		IEntity	target,
		vector	targetPosition,
		int	playerID,
		bool	isClient )

method that will be executed when the command is selected in the menu This method is right now broadcaasted to all clients, so if the command is intended only for specific clients, it needs to be filtered inside

Implements SCR_BaseRadialCommand.

Member Data Documentation

m_aAllowedStances

ref array<ref ECharacterStance> SCR_EmoteBaseCommand.m_aAllowedStances

protected

m_bUnequipItems

bool SCR_EmoteBaseCommand.m_bUnequipItems

protected

m_iGestureID

int SCR_EmoteBaseCommand.m_iGestureID

protected

---

The documentation for this interface was generated from the following file:

• Game/Commanding/Commands/SCR_EmoteBaseCommand.c