SCR_SetRallyPointCommand Interface Reference

Inheritance diagram for SCR_SetRallyPointCommand:

Public Member Functions
override bool	CanRoleShow ()
override bool	CanBeShown ()
override bool	CanShowOnMap ()
void	OnMapOpen (MapConfiguration config)
void	OnMapClose (MapConfiguration config)
void	OnRadialMenuInit ()
void	OnRadialMenuEntryAdded (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry)
void	OnMapRadialMenuOpen ()
override bool	CanBePerformed (notnull SCR_ChimeraCharacter user)
	Returns true if user (player) of the command can issue the command.
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
void	SCR_SetRallyPointCommand ()
	constructor
void	~SCR_SetRallyPointCommand ()
	destructor
Public Member Functions inherited from SCR_BaseRadialCommand
void	VisualizeCommand (vector targetPosition)
void	VisualizeCommandPreview (vector targetPosition)
string	GetIconName ()
string	GetCommandDisplayName ()
ResourceName	GetIconImageset ()
string	GetCommandName ()
bool	CanBeShownInCurrentLifeState ()
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	OnBaseHovered (SCR_CampaignMilitaryBaseComponent base)
SCR_SelectionMenuEntry	FindCommandEntry (SCR_RadialMenu mapRadialMenu)
SCR_SelectionMenuEntry	FindCommandEntryInCategory (SCR_SelectionMenuCategoryEntry category)
bool	SetRadialMenuEntryEnabled ()
Protected Member Functions inherited from SCR_BaseRadialCommand
void	SetCannotExecuteReason (LocalizedString newReason)
void	SetCannotPerformReason (LocalizedString newReason)

Protected Attributes
string	m_sAssignRallyPointCommandString
string	m_sUnassignRallyPointCommandString
string	m_sNoBaseSelectedString
SCR_CampaignMilitaryBaseComponent	m_HoveredBase
SCR_CampaignMilitaryBaseComponent	m_CurrentHoveredBase
ref SCR_SelectionMenuEntry	m_RadialMenuEntry
SCR_PlayerControllerGroupComponent	m_PlayerControllerGroupComponent
MapConfiguration	m_MapConfig
bool	m_bAssign
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
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"

Constructor & Destructor Documentation

SCR_SetRallyPointCommand()

void SCR_SetRallyPointCommand.SCR_SetRallyPointCommand

(

)

constructor

~SCR_SetRallyPointCommand()

void SCR_SetRallyPointCommand.~SCR_SetRallyPointCommand

(

)

destructor

Member Function Documentation

CanBePerformed()

override bool SCR_SetRallyPointCommand.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.

CanBeShown()

override bool SCR_SetRallyPointCommand.CanBeShown

(

)

Implements SCR_BaseRadialCommand.

CanRoleShow()

override bool SCR_SetRallyPointCommand.CanRoleShow

(

)

Implements SCR_BaseRadialCommand.

CanShowOnMap()

override bool SCR_SetRallyPointCommand.CanShowOnMap

(

)

Implements SCR_BaseRadialCommand.

Execute()

override bool SCR_SetRallyPointCommand.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.

FindCommandEntry()

SCR_SelectionMenuEntry SCR_SetRallyPointCommand.FindCommandEntry ( SCR_RadialMenu mapRadialMenu )

protected

FindCommandEntryInCategory()

SCR_SelectionMenuEntry SCR_SetRallyPointCommand.FindCommandEntryInCategory ( SCR_SelectionMenuCategoryEntry category )

protected

OnBaseHovered()

void SCR_SetRallyPointCommand.OnBaseHovered ( SCR_CampaignMilitaryBaseComponent base )

protected

OnMapClose()

void SCR_SetRallyPointCommand.OnMapClose

(

MapConfiguration

config

)

OnMapOpen()

void SCR_SetRallyPointCommand.OnMapOpen

(

MapConfiguration

config

)

OnMapRadialMenuOpen()

void SCR_SetRallyPointCommand.OnMapRadialMenuOpen

(

)

OnRadialMenuEntryAdded()

void SCR_SetRallyPointCommand.OnRadialMenuEntryAdded	(	SCR_SelectionMenu	menu,
		SCR_SelectionMenuEntry	entry )

OnRadialMenuInit()

void SCR_SetRallyPointCommand.OnRadialMenuInit

(

)

SetRadialMenuEntryEnabled()

bool SCR_SetRallyPointCommand.SetRadialMenuEntryEnabled ( )

protected

Member Data Documentation

m_bAssign

bool SCR_SetRallyPointCommand.m_bAssign

protected

m_CurrentHoveredBase

SCR_CampaignMilitaryBaseComponent SCR_SetRallyPointCommand.m_CurrentHoveredBase

protected

m_HoveredBase

SCR_CampaignMilitaryBaseComponent SCR_SetRallyPointCommand.m_HoveredBase

protected

m_MapConfig

MapConfiguration SCR_SetRallyPointCommand.m_MapConfig

protected

m_PlayerControllerGroupComponent

SCR_PlayerControllerGroupComponent SCR_SetRallyPointCommand.m_PlayerControllerGroupComponent

protected

m_RadialMenuEntry

ref SCR_SelectionMenuEntry SCR_SetRallyPointCommand.m_RadialMenuEntry

protected

m_sAssignRallyPointCommandString

string SCR_SetRallyPointCommand.m_sAssignRallyPointCommandString

protected

m_sNoBaseSelectedString

string SCR_SetRallyPointCommand.m_sNoBaseSelectedString

protected

m_sUnassignRallyPointCommandString

string SCR_SetRallyPointCommand.m_sUnassignRallyPointCommandString

protected

---

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

• Game/Commanding/Commands/SCR_SetRallyPointCommand.c