SCR_ToggleHandbrakeAction Class Reference

Inheritance diagram for SCR_ToggleHandbrakeAction:

Protected Member Functions
override bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
override bool	CanBePerformedScript (IEntity user)
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
override bool	GetActionNameScript (out string outName)

Protected Attributes
ref array< int >	m_aDefinedCompartmentSectionsOnly
ref array< int >	m_aExcludeDefinedCompartmentSections
const LocalizedString	CONTROLLED_BY_DRIVER = "#AR-UserAction_ControlledByDriver"
const LocalizedString	OCCUPIED_BY_ENEMY = "#AR-UserAction_SeatHostile"

Detailed Description

Definition at line 1 of file SCR_ToggleHandbrakeAction.c.

Member Function Documentation

CanBePerformedScript()

override bool SCR_ToggleHandbrakeAction::CanBePerformedScript ( IEntity user )

inlineprotected

Definition at line 37 of file SCR_ToggleHandbrakeAction.c.

CanBeShownScript()

override bool SCR_ToggleHandbrakeAction::CanBeShownScript ( IEntity user )

inlineprotected

Can this entity be shown in the UI by the provided user entity?

Definition at line 14 of file SCR_ToggleHandbrakeAction.c.

GetActionNameScript()

override bool SCR_ToggleHandbrakeAction::GetActionNameScript ( out string outName )

inlineprotected

If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called. If not overridden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Definition at line 112 of file SCR_ToggleHandbrakeAction.c.

PerformAction()

override void SCR_ToggleHandbrakeAction::PerformAction ( IEntity pOwnerEntity, IEntity pUserEntity )

inlineprotected

Called when someone tries to perform the action, user entity is typically character.

Definition at line 79 of file SCR_ToggleHandbrakeAction.c.

Member Data Documentation

CONTROLLED_BY_DRIVER

const LocalizedString SCR_ToggleHandbrakeAction::CONTROLLED_BY_DRIVER = "#AR-UserAction_ControlledByDriver"

protected

Definition at line 9 of file SCR_ToggleHandbrakeAction.c.

m_aDefinedCompartmentSectionsOnly

ref array<int> SCR_ToggleHandbrakeAction::m_aDefinedCompartmentSectionsOnly

protected

Definition at line 4 of file SCR_ToggleHandbrakeAction.c.

m_aExcludeDefinedCompartmentSections

ref array<int> SCR_ToggleHandbrakeAction::m_aExcludeDefinedCompartmentSections

protected

Definition at line 7 of file SCR_ToggleHandbrakeAction.c.

OCCUPIED_BY_ENEMY

const LocalizedString SCR_ToggleHandbrakeAction::OCCUPIED_BY_ENEMY = "#AR-UserAction_SeatHostile"

protected

Definition at line 10 of file SCR_ToggleHandbrakeAction.c.

---

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

• scripts/Game/UserActions/SCR_ToggleHandbrakeAction.c