SCR_BaseRadialCommand Interface Reference

Inheritance diagram for SCR_BaseRadialCommand:

Public Member Functions
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
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	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 Member Functions
void	SetCannotExecuteReason (LocalizedString newReason)
void	SetCannotPerformReason (LocalizedString newReason)

Protected Attributes
string	m_sCommandName
string	m_sCommandDisplayName
ResourceName	m_sImageset
string	m_sIconName
SCR_ECharacterRank	m_eRequiredRank
LocalizedString	m_sCannotPerformReason
LocalizedString	m_sCannotExecuteReason

Static Protected Attributes
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

CanBeExecuted()

bool SCR_BaseRadialCommand.CanBeExecuted

(

notnull IEntity

target

)

Returns true if target of the command - typically cursortarget - can execute the command.

Parameters

[in]

target

entity, that should execute the command

CanBePerformed()

bool SCR_BaseRadialCommand.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

Implemented in SCR_ContinuousLoiterCommand, SCR_EmoteBaseCommand, and SCR_SetRallyPointCommand.

CanBeShown()

bool SCR_BaseRadialCommand.CanBeShown

(

)

Implemented in SCR_GetINtoSelectedVehicleGroupCommand, SCR_LookAtGroupCommand, SCR_RecruitAIGroupCommand, SCR_RemoveAIGroupCommand, SCR_SetCombatModeGroupCommand, SCR_SetRallyPointCommand, SCR_StopMovementGroupCommand, and SCR_WaypointGroupCommand.

CanBeShownInCurrentLifeState()

bool SCR_BaseRadialCommand.CanBeShownInCurrentLifeState

(

)

Implemented in SCR_BaseGroupCommand.

CanRoleShow()

bool SCR_BaseRadialCommand.CanRoleShow

(

)

Implemented in SCR_BaseGroupCommand, and SCR_SetRallyPointCommand.

CanShowOnMap()

bool SCR_BaseRadialCommand.CanShowOnMap

(

)

Implemented in SCR_BaseGroupCommand, SCR_SetRallyPointCommand, and SCR_WaypointGroupCommand.

Execute()

bool SCR_BaseRadialCommand.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

Implemented in SCR_CharacterEntityWaypointGroupCommand, SCR_ContextGetIngroupCommand, SCR_ContinuousLoiterCommand, SCR_EmoteBaseCommand, SCR_FollowGroupCommand, SCR_GestureGroupCommand, SCR_GetINtoSelectedVehicleGroupCommand, SCR_GetOutGroupCommand, SCR_LookAtGroupCommand, SCR_PatrolGroupCommand, SCR_RecruitAIGroupCommand, SCR_RemoveAIGroupCommand, SCR_SetCombatModeGroupCommand, SCR_SetRallyPointCommand, SCR_StopMovementGroupCommand, and SCR_WaypointGroupCommand.

GetCannotExecuteReason()

LocalizedString SCR_BaseRadialCommand.GetCannotExecuteReason

(

)

GetCannotPerformReason()

LocalizedString SCR_BaseRadialCommand.GetCannotPerformReason

(

)

GetCommandDisplayName()

string SCR_BaseRadialCommand.GetCommandDisplayName

(

)

GetCommandName()

string SCR_BaseRadialCommand.GetCommandName

(

)

GetIconImageset()

ResourceName SCR_BaseRadialCommand.GetIconImageset

(

)

GetIconName()

string SCR_BaseRadialCommand.GetIconName

(

)

SetCannotExecuteReason()

void SCR_BaseRadialCommand.SetCannotExecuteReason ( LocalizedString newReason )

protected

SetCannotPerformReason()

void SCR_BaseRadialCommand.SetCannotPerformReason ( LocalizedString newReason )

protected

VisualizeCommand()

void SCR_BaseRadialCommand.VisualizeCommand

(

vector

targetPosition

)

Implemented in SCR_BaseGroupCommand.

VisualizeCommandPreview()

void SCR_BaseRadialCommand.VisualizeCommandPreview

(

vector

targetPosition

)

Implemented in SCR_BaseGroupCommand.

Member Data Documentation

CANNOT_EXECUTE_SOLDIER_NA

const LocalizedString SCR_BaseRadialCommand.CANNOT_EXECUTE_SOLDIER_NA = "#AR-Commanding_CannotExecute_SoldierNotAvailable"

staticprotected

CANNOT_PERFORM_RANK_TOO_LOW

const LocalizedString SCR_BaseRadialCommand.CANNOT_PERFORM_RANK_TOO_LOW = "#AR-Commanding_CannotPefrorm_RankTooLow"

staticprotected

m_eRequiredRank

SCR_ECharacterRank SCR_BaseRadialCommand.m_eRequiredRank

protected

m_sCannotExecuteReason

LocalizedString SCR_BaseRadialCommand.m_sCannotExecuteReason

protected

m_sCannotPerformReason

LocalizedString SCR_BaseRadialCommand.m_sCannotPerformReason

protected

m_sCommandDisplayName

string SCR_BaseRadialCommand.m_sCommandDisplayName

protected

m_sCommandName

string SCR_BaseRadialCommand.m_sCommandName

protected

m_sIconName

string SCR_BaseRadialCommand.m_sIconName

protected

m_sImageset

ResourceName SCR_BaseRadialCommand.m_sImageset

protected

---

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

• Game/Commanding/Commands/SCR_BaseRadialCommand.c