SCR_BaseGroupCommand Interface Reference

Inheritance diagram for SCR_BaseGroupCommand:

Public Member Functions
override bool	CanRoleShow ()
string	GetSoundEventName ()
float	GetSoundEventSeed ()
bool	CanShowPreview ()
bool	ShouldPlayAIResponse ()
override bool	CanShowOnMap ()
int	GetCommandGestureID ()
SCR_ECommandVisualizationDuration	GetVisualizationDuration ()
override bool	CanBeShownInCurrentLifeState ()
override void	VisualizeCommand (vector targetPosition)
override void	VisualizeCommandPreview (vector targetPosition)
Public Member Functions inherited from SCR_BaseRadialCommand
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
string	GetIconName ()
string	GetCommandDisplayName ()
ResourceName	GetIconImageset ()
string	GetCommandName ()
bool	CanBeShown ()
bool	CanBePerformed (notnull SCR_ChimeraCharacter user)
	Returns true if user (player) of the command can issue the command.
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_bShowToLeader
bool	m_bShowToMember
bool	m_bShowOnMap
bool	m_bUsableWhileDead
bool	m_bUsableWhileUncouscious
int	m_iGestureID
string	m_sSoundEventName
float	m_fSoundEventSeed
bool	m_bShowPreview
bool	m_bPlayAIResponse
SCR_ECommandVisualizationDuration	m_eVisualizationDuration
ResourceName	m_sInfoDisplayConfig
Widget	m_wVisualizationWidget
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

CanBeShownInCurrentLifeState()

override bool SCR_BaseGroupCommand.CanBeShownInCurrentLifeState

(

)

Implements SCR_BaseRadialCommand.

CanRoleShow()

override bool SCR_BaseGroupCommand.CanRoleShow

(

)

Implements SCR_BaseRadialCommand.

CanShowOnMap()

override bool SCR_BaseGroupCommand.CanShowOnMap

(

)

Implements SCR_BaseRadialCommand.

Implemented in SCR_WaypointGroupCommand.

CanShowPreview()

bool SCR_BaseGroupCommand.CanShowPreview

(

)

GetCommandGestureID()

int SCR_BaseGroupCommand.GetCommandGestureID

(

)

GetSoundEventName()

string SCR_BaseGroupCommand.GetSoundEventName

(

)

GetSoundEventSeed()

float SCR_BaseGroupCommand.GetSoundEventSeed

(

)

GetVisualizationDuration()

SCR_ECommandVisualizationDuration SCR_BaseGroupCommand.GetVisualizationDuration

(

)

ShouldPlayAIResponse()

bool SCR_BaseGroupCommand.ShouldPlayAIResponse

(

)

VisualizeCommand()

override void SCR_BaseGroupCommand.VisualizeCommand

(

vector

targetPosition

)

Implements SCR_BaseRadialCommand.

VisualizeCommandPreview()

override void SCR_BaseGroupCommand.VisualizeCommandPreview

(

vector

targetPosition

)

Implements SCR_BaseRadialCommand.

Member Data Documentation

m_bPlayAIResponse

bool SCR_BaseGroupCommand.m_bPlayAIResponse

protected

m_bShowOnMap

bool SCR_BaseGroupCommand.m_bShowOnMap

protected

m_bShowPreview

bool SCR_BaseGroupCommand.m_bShowPreview

protected

m_bShowToLeader

bool SCR_BaseGroupCommand.m_bShowToLeader

protected

m_bShowToMember

bool SCR_BaseGroupCommand.m_bShowToMember

protected

m_bUsableWhileDead

bool SCR_BaseGroupCommand.m_bUsableWhileDead

protected

m_bUsableWhileUncouscious

bool SCR_BaseGroupCommand.m_bUsableWhileUncouscious

protected

m_eVisualizationDuration

SCR_ECommandVisualizationDuration SCR_BaseGroupCommand.m_eVisualizationDuration

protected

m_fSoundEventSeed

float SCR_BaseGroupCommand.m_fSoundEventSeed

protected

m_iGestureID

int SCR_BaseGroupCommand.m_iGestureID

protected

m_sInfoDisplayConfig

ResourceName SCR_BaseGroupCommand.m_sInfoDisplayConfig

protected

m_sSoundEventName

string SCR_BaseGroupCommand.m_sSoundEventName

protected

m_wVisualizationWidget

Widget SCR_BaseGroupCommand.m_wVisualizationWidget

protected

---

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

• Game/Commanding/Commands/SCR_BaseGroupCommand.c