Loading...
Searching...
No Matches
Public Member Functions | List of all members
SCR_RecruitAIGroupCommand Interface Reference
Inheritance diagram for SCR_RecruitAIGroupCommand:
SCR_BaseGroupCommand SCR_BaseRadialCommand

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
 
override bool CanBeExecuted (IEntity target)
 Returns true if target of the command - typically cursortarget - can execute the command.
 
override bool CanBeShown ()
 
- Public Member Functions inherited from SCR_BaseGroupCommand
override bool CanRoleShow ()
 
string GetSoundEventName ()
 
float GetSoundEventSeed ()
 
bool CanShowPreview ()
 
bool ShouldPlayAIResponse ()
 
override bool CanShowOnMap ()
 
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.
 
LocalizedString GetCannotExecuteReason ()
 
LocalizedString GetCannotPerformReason ()
 

Additional Inherited Members

- Protected Member Functions inherited from SCR_BaseRadialCommand
void SetCannotExecuteReason (LocalizedString newReason)
 
void SetCannotPerformReason (LocalizedString newReason)
 
- 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
 
- 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

◆ CanBeExecuted()

override bool SCR_RecruitAIGroupCommand.CanBeExecuted ( IEntity target)

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

Parameters
[in]targetentity, that should execute the command

Implements SCR_BaseRadialCommand.

◆ CanBeShown()

override bool SCR_RecruitAIGroupCommand.CanBeShown ( )

Implements SCR_BaseRadialCommand.

◆ Execute()

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

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