Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_BaseRadialCommand Interface Reference
Inheritance diagram for SCR_BaseRadialCommand:
SCR_BaseGroupCommand SCR_ContinuousLoiterCommand SCR_EmoteBaseCommand SCR_LookAtGroupCommand SCR_RecruitAIGroupCommand SCR_RemoveAIGroupCommand SCR_SetCombatModeGroupCommand SCR_StopMovementGroupCommand SCR_WaypointGroupCommand SCR_CharacterEntityWaypointGroupCommand SCR_ContextGetIngroupCommand SCR_FollowGroupCommand SCR_GestureGroupCommand SCR_GetINtoSelectedVehicleGroupCommand SCR_GetOutGroupCommand SCR_PatrolGroupCommand

Public Member Functions

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 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)
 
LocalizedString GetCannotPerformReason ()
 

Protected Member Functions

void SetCannotPerformReason (LocalizedString newReason)
 

Protected Attributes

string m_sCommandName
 
string m_sCommandDisplayName
 
ResourceName m_sImageset
 
string m_sIconName
 
SCR_ECharacterRank m_eRequiredRank
 
LocalizedString m_sCannotPerformReason
 

Static Protected Attributes

static const LocalizedString CANNOT_PERFORM_RANK_TOO_LOW = "#AR-Commanding_CannotPefrorm_RankTooLow"
 

Member Function Documentation

◆ CanBePerformed()

bool SCR_BaseRadialCommand.CanBePerformed ( notnull SCR_ChimeraCharacter user)

◆ CanBeShown()

◆ CanBeShownInCurrentLifeState()

bool SCR_BaseRadialCommand.CanBeShownInCurrentLifeState ( )

Implemented in SCR_BaseGroupCommand.

◆ CanRoleShow()

bool SCR_BaseRadialCommand.CanRoleShow ( )

Implemented in SCR_BaseGroupCommand.

◆ CanShowOnMap()

bool SCR_BaseRadialCommand.CanShowOnMap ( )

Implemented in SCR_BaseGroupCommand.

◆ Execute()

bool SCR_BaseRadialCommand.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

Implemented in SCR_CharacterEntityWaypointGroupCommand, SCR_ContextGetIngroupCommand, SCR_ContinuousLoiterCommand, SCR_EmoteBaseCommand, SCR_FollowGroupCommand, SCR_GestureGroupCommand, SCR_GetINtoSelectedVehicleGroupCommand, SCR_GetOutGroupCommand, SCR_LookAtGroupCommand, SCR_PatrolGroupCommand, SCR_RecruitAIGroupCommand, SCR_RemoveAIGroupCommand, SCR_SetCombatModeGroupCommand, SCR_StopMovementGroupCommand, and SCR_WaypointGroupCommand.

◆ GetCannotPerformReason()

LocalizedString SCR_BaseRadialCommand.GetCannotPerformReason ( )

◆ GetCommandDisplayName()

string SCR_BaseRadialCommand.GetCommandDisplayName ( )

◆ GetCommandName()

string SCR_BaseRadialCommand.GetCommandName ( )

◆ GetIconImageset()

ResourceName SCR_BaseRadialCommand.GetIconImageset ( )

◆ GetIconName()

string SCR_BaseRadialCommand.GetIconName ( )

◆ SetCannotPerformReason()

void SCR_BaseRadialCommand.SetCannotPerformReason ( LocalizedString newReason)
protected

◆ VisualizeCommand()

void SCR_BaseRadialCommand.VisualizeCommand ( vector targetPosition)

Implemented in SCR_BaseGroupCommand.

◆ VisualizeCommandPreview()

void SCR_BaseRadialCommand.VisualizeCommandPreview ( vector targetPosition)

Implemented in SCR_BaseGroupCommand.

Member Data Documentation

◆ CANNOT_PERFORM_RANK_TOO_LOW

const LocalizedString SCR_BaseRadialCommand.CANNOT_PERFORM_RANK_TOO_LOW = "#AR-Commanding_CannotPefrorm_RankTooLow"
staticprotected

◆ m_eRequiredRank

SCR_ECharacterRank SCR_BaseRadialCommand.m_eRequiredRank
protected

◆ m_sCannotPerformReason

LocalizedString SCR_BaseRadialCommand.m_sCannotPerformReason
protected

◆ m_sCommandDisplayName

string SCR_BaseRadialCommand.m_sCommandDisplayName
protected

◆ m_sCommandName

string SCR_BaseRadialCommand.m_sCommandName
protected

◆ m_sIconName

string SCR_BaseRadialCommand.m_sIconName
protected

◆ m_sImageset

ResourceName SCR_BaseRadialCommand.m_sImageset
protected

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