SCR_WaypointGroupCommand Interface Reference

Inheritance diagram for SCR_WaypointGroupCommand:

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
bool	SetWaypointForAIGroup (IEntity target, vector targetPosition, int playerID)
void	SpawnWPVisualization (vector targetPosition, int playerID)
ResourceName	GetWaypointPrefab ()
void	SetWaypointPrefab (ResourceName wpPrefab)
bool	GetOverridePreviousCommands ()
void	SetOverridePreviousCommands (bool overridePrevious)
vector	GetTargetPosition (int playerID, vector targetPosition)
void	CheckPreviousWaypoints (SCR_AIGroup slaveGroup)
override bool	CanShowOnMap ()
override bool	CanBeShown ()
void	SetCombatMode (IEntity target, EAIGroupCombatMode combatMode)
Public Member Functions inherited from SCR_BaseGroupCommand
override bool	CanRoleShow ()
string	GetSoundEventName ()
float	GetSoundEventSeed ()
bool	CanShowPreview ()
bool	ShouldPlayAIResponse ()
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
string	GetIconName ()
string	GetCommandDisplayName ()
ResourceName	GetIconImageset ()
string	GetCommandName ()
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 ()

Public Attributes
bool	m_bSetCombatMode

Protected Attributes
ResourceName	m_sWaypointPrefab
bool	m_bOverridePreviousCommands
bool	m_bTargetSelf
bool	m_bForceCommand
float	m_fCompletionRadius
EAIGroupCombatMode	m_eCombatMode
ref SCR_BaseWaypointCommandHandler	m_WaypointCommandHandler
Protected Attributes inherited from SCR_BaseGroupCommand
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

CanBeShown()

override bool SCR_WaypointGroupCommand.CanBeShown

(

)

Implements SCR_BaseRadialCommand.

Implemented in SCR_GetINtoSelectedVehicleGroupCommand.

CanShowOnMap()

override bool SCR_WaypointGroupCommand.CanShowOnMap

(

)

Implements SCR_BaseGroupCommand.

CheckPreviousWaypoints()

void SCR_WaypointGroupCommand.CheckPreviousWaypoints

(

SCR_AIGroup

slaveGroup

)

Execute()

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

Implemented in SCR_CharacterEntityWaypointGroupCommand, SCR_ContextGetIngroupCommand, SCR_FollowGroupCommand, SCR_GestureGroupCommand, SCR_GetINtoSelectedVehicleGroupCommand, SCR_GetOutGroupCommand, and SCR_PatrolGroupCommand.

GetOverridePreviousCommands()

bool SCR_WaypointGroupCommand.GetOverridePreviousCommands

(

)

GetTargetPosition()

vector SCR_WaypointGroupCommand.GetTargetPosition	(	int	playerID,
		vector	targetPosition )

GetWaypointPrefab()

ResourceName SCR_WaypointGroupCommand.GetWaypointPrefab

(

)

SetCombatMode()

void SCR_WaypointGroupCommand.SetCombatMode	(	IEntity	target,
		EAIGroupCombatMode	combatMode )

SetOverridePreviousCommands()

void SCR_WaypointGroupCommand.SetOverridePreviousCommands

(

bool

overridePrevious

)

SetWaypointForAIGroup()

bool SCR_WaypointGroupCommand.SetWaypointForAIGroup	(	IEntity	target,
		vector	targetPosition,
		int	playerID )

Implemented in SCR_ArtilleryWaypointGroupCommand.

SetWaypointPrefab()

void SCR_WaypointGroupCommand.SetWaypointPrefab

(

ResourceName

wpPrefab

)

SpawnWPVisualization()

void SCR_WaypointGroupCommand.SpawnWPVisualization	(	vector	targetPosition,
		int	playerID )

Member Data Documentation

m_bForceCommand

bool SCR_WaypointGroupCommand.m_bForceCommand

protected

m_bOverridePreviousCommands

bool SCR_WaypointGroupCommand.m_bOverridePreviousCommands

protected

m_bSetCombatMode

bool SCR_WaypointGroupCommand.m_bSetCombatMode

m_bTargetSelf

bool SCR_WaypointGroupCommand.m_bTargetSelf

protected

m_eCombatMode

EAIGroupCombatMode SCR_WaypointGroupCommand.m_eCombatMode

protected

m_fCompletionRadius

float SCR_WaypointGroupCommand.m_fCompletionRadius

protected

m_sWaypointPrefab

ResourceName SCR_WaypointGroupCommand.m_sWaypointPrefab

protected

m_WaypointCommandHandler

ref SCR_BaseWaypointCommandHandler SCR_WaypointGroupCommand.m_WaypointCommandHandler

protected

---

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

• Game/Commanding/Commands/SCR_WaypointGroupCommand.c