SCR_ArtilleryWaypointGroupCommand Interface Reference

Inheritance diagram for SCR_ArtilleryWaypointGroupCommand:

Public Member Functions
override bool	SetWaypointForAIGroup (IEntity target, vector targetPosition, int playerID)
void	SCR_ArtilleryWaypointGroupCommand ()
Public Member Functions inherited from SCR_WaypointGroupCommand
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	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 ()

Protected Member Functions
void	SpoofTargetPosition (inout vector targetPosition, notnull ChimeraCharacter character)
	Attempts to offset the target position by random value based on the configuration of this command.
Protected Member Functions inherited from SCR_BaseRadialCommand
void	SetCannotExecuteReason (LocalizedString newReason)
void	SetCannotPerformReason (LocalizedString newReason)

Protected Attributes
float	m_fPositionOffsetCloseDistance
float	m_fPositionOffsetFarDistance
float	m_fMaxPositionOffset
ref Curve	m_aMinPositionOffset
ref Curve	m_aMaxPositionOffset
Protected Attributes inherited from SCR_WaypointGroupCommand
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
Public Attributes inherited from SCR_WaypointGroupCommand
bool	m_bSetCombatMode
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_ArtilleryWaypointGroupCommand()

void SCR_ArtilleryWaypointGroupCommand.SCR_ArtilleryWaypointGroupCommand

(

)

Member Function Documentation

SetWaypointForAIGroup()

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

Implements SCR_WaypointGroupCommand.

SpoofTargetPosition()

void SCR_ArtilleryWaypointGroupCommand.SpoofTargetPosition ( inout vector targetPosition, notnull ChimeraCharacter character )

protected

Attempts to offset the target position by random value based on the configuration of this command.

Parameters

[in,out]	targetPosition	position that is going to be moddified
[in]	character	issued this command

Member Data Documentation

m_aMaxPositionOffset

ref Curve SCR_ArtilleryWaypointGroupCommand.m_aMaxPositionOffset

protected

m_aMinPositionOffset

ref Curve SCR_ArtilleryWaypointGroupCommand.m_aMinPositionOffset

protected

m_fMaxPositionOffset

float SCR_ArtilleryWaypointGroupCommand.m_fMaxPositionOffset

protected

m_fPositionOffsetCloseDistance

float SCR_ArtilleryWaypointGroupCommand.m_fPositionOffsetCloseDistance

protected

m_fPositionOffsetFarDistance

float SCR_ArtilleryWaypointGroupCommand.m_fPositionOffsetFarDistance

protected

---

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

• Game/Commanding/Commands/SCR_ArtilleryWaypointGroupCommand.c