SCR_BaseRadialCommand Class Reference

Inheritance diagram for SCR_BaseRadialCommand:

Protected Member Functions
bool	Execute (IEntity cursorTarget, IEntity target, vector targetPosition, int playerID, bool isClient)
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)
bool	CanBeExecuted (IEntity target)
void	SetCannotExecuteReason (LocalizedString newReason)
void	SetCannotPerformReason (LocalizedString newReason)
LocalizedString	GetCannotExecuteReason ()
LocalizedString	GetCannotPerformReason ()

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"

Detailed Description

Definition at line 2 of file SCR_BaseRadialCommand.c.

Member Function Documentation

CanBeExecuted()

bool SCR_BaseRadialCommand::CanBeExecuted ( IEntity target )

inlineprotected

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

Parameters

[in]

target

entity, that should execute the command

Definition at line 136 of file SCR_BaseRadialCommand.c.

CanBePerformed()

bool SCR_BaseRadialCommand::CanBePerformed ( notnull SCR_ChimeraCharacter user )

inlineprotected

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

Parameters

[in]

user

- the commander's chimera character

Definition at line 102 of file SCR_BaseRadialCommand.c.

CanBeShown()

bool SCR_BaseRadialCommand::CanBeShown ( )

inlineprotected

Definition at line 85 of file SCR_BaseRadialCommand.c.

CanBeShownInCurrentLifeState()

bool SCR_BaseRadialCommand::CanBeShownInCurrentLifeState ( )

inlineprotected

Definition at line 78 of file SCR_BaseRadialCommand.c.

CanRoleShow()

bool SCR_BaseRadialCommand::CanRoleShow ( )

inlineprotected

Definition at line 71 of file SCR_BaseRadialCommand.c.

CanShowOnMap()

bool SCR_BaseRadialCommand::CanShowOnMap ( )

inlineprotected

Definition at line 92 of file SCR_BaseRadialCommand.c.

Execute()

bool SCR_BaseRadialCommand::Execute ( IEntity cursorTarget, IEntity target, vector targetPosition, int playerID, bool isClient )

inlineprotected

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

Definition at line 30 of file SCR_BaseRadialCommand.c.

GetCannotExecuteReason()

LocalizedString SCR_BaseRadialCommand::GetCannotExecuteReason ( )

inlineprotected

Definition at line 154 of file SCR_BaseRadialCommand.c.

GetCannotPerformReason()

LocalizedString SCR_BaseRadialCommand::GetCannotPerformReason ( )

inlineprotected

Definition at line 160 of file SCR_BaseRadialCommand.c.

GetCommandDisplayName()

string SCR_BaseRadialCommand::GetCommandDisplayName ( )

inlineprotected

Definition at line 50 of file SCR_BaseRadialCommand.c.

GetCommandName()

string SCR_BaseRadialCommand::GetCommandName ( )

inlineprotected

Definition at line 64 of file SCR_BaseRadialCommand.c.

GetIconImageset()

ResourceName SCR_BaseRadialCommand::GetIconImageset ( )

inlineprotected

Definition at line 57 of file SCR_BaseRadialCommand.c.

GetIconName()

string SCR_BaseRadialCommand::GetIconName ( )

inlineprotected

Definition at line 43 of file SCR_BaseRadialCommand.c.

SetCannotExecuteReason()

void SCR_BaseRadialCommand::SetCannotExecuteReason ( LocalizedString newReason )

inlineprotected

Definition at line 142 of file SCR_BaseRadialCommand.c.

SetCannotPerformReason()

void SCR_BaseRadialCommand::SetCannotPerformReason ( LocalizedString newReason )

inlineprotected

Definition at line 148 of file SCR_BaseRadialCommand.c.

VisualizeCommand()

void SCR_BaseRadialCommand::VisualizeCommand ( vector targetPosition )

protected

VisualizeCommandPreview()

void SCR_BaseRadialCommand::VisualizeCommandPreview ( vector targetPosition )

protected

Member Data Documentation

CANNOT_EXECUTE_SOLDIER_NA

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

staticprotected

Definition at line 23 of file SCR_BaseRadialCommand.c.

CANNOT_PERFORM_RANK_TOO_LOW

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

staticprotected

Definition at line 22 of file SCR_BaseRadialCommand.c.

m_eRequiredRank

SCR_ECharacterRank SCR_BaseRadialCommand::m_eRequiredRank

protected

Definition at line 17 of file SCR_BaseRadialCommand.c.

m_sCannotExecuteReason

LocalizedString SCR_BaseRadialCommand::m_sCannotExecuteReason

protected

Definition at line 20 of file SCR_BaseRadialCommand.c.

m_sCannotPerformReason

LocalizedString SCR_BaseRadialCommand::m_sCannotPerformReason

protected

Definition at line 19 of file SCR_BaseRadialCommand.c.

m_sCommandDisplayName

string SCR_BaseRadialCommand::m_sCommandDisplayName

protected

Definition at line 8 of file SCR_BaseRadialCommand.c.

m_sCommandName

string SCR_BaseRadialCommand::m_sCommandName

protected

Definition at line 5 of file SCR_BaseRadialCommand.c.

m_sIconName

string SCR_BaseRadialCommand::m_sIconName

protected

Definition at line 14 of file SCR_BaseRadialCommand.c.

m_sImageset

ResourceName SCR_BaseRadialCommand::m_sImageset

protected

Definition at line 11 of file SCR_BaseRadialCommand.c.

---

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

• scripts/Game/Commanding/Commands/SCR_BaseRadialCommand.c