SCR_VehicleActionBase Class Reference

Inheritance diagram for SCR_VehicleActionBase:

Protected Member Functions
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
override bool	CanBeShownScript (IEntity user)
override bool	CanBePerformedScript (IEntity user)
bool	GetState ()
	Current state of the feature.
void	SetState (bool enable)
	Script to change state of the feature.
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	By default toggle the current state of the interaction.
override bool	GetActionNameScript (out string outName)

Protected Attributes
bool	m_bIsToggle
	Should action behave as a toggle.
bool	m_bTargetState
	Target state of the action, ignored if toggle.
string	m_sActionStateOn
	Description of action to toggle on.
string	m_sActionStateOff
	Description of action to toggle off.
bool	m_bPilotOnly
	Available only for entities seated in pilot compartment.
bool	m_bInteriorOnly
	Available only for entities seated in a vehicle.
ref array< int >	m_aDefinedCompartmentSectionsOnly
ref array< int >	m_aExcludeDefinedCompartmentSections
CompartmentControllerComponent	m_VehicleController

Detailed Description

Definition at line 1 of file SCR_VehicleActionBase.c.

Member Function Documentation

CanBePerformedScript()

override bool SCR_VehicleActionBase::CanBePerformedScript ( IEntity user )

inlineprotected

Definition at line 93 of file SCR_VehicleActionBase.c.

CanBeShownScript()

override bool SCR_VehicleActionBase::CanBeShownScript ( IEntity user )

inlineprotected

Definition at line 44 of file SCR_VehicleActionBase.c.

GetActionNameScript()

override bool SCR_VehicleActionBase::GetActionNameScript ( out string outName )

inlineprotected

Definition at line 120 of file SCR_VehicleActionBase.c.

GetState()

bool SCR_VehicleActionBase::GetState ( )

inlineprotected

Current state of the feature.

Definition at line 100 of file SCR_VehicleActionBase.c.

Init()

override void SCR_VehicleActionBase::Init ( IEntity pOwnerEntity, GenericComponent pManagerComponent )

inlineprotected

Definition at line 36 of file SCR_VehicleActionBase.c.

PerformAction()

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

inlineprotected

By default toggle the current state of the interaction.

Definition at line 111 of file SCR_VehicleActionBase.c.

SetState()

void SCR_VehicleActionBase::SetState ( bool enable )

protected

Script to change state of the feature.

Member Data Documentation

m_aDefinedCompartmentSectionsOnly

ref array<int> SCR_VehicleActionBase::m_aDefinedCompartmentSectionsOnly

protected

Definition at line 28 of file SCR_VehicleActionBase.c.

m_aExcludeDefinedCompartmentSections

ref array<int> SCR_VehicleActionBase::m_aExcludeDefinedCompartmentSections

protected

Definition at line 31 of file SCR_VehicleActionBase.c.

m_bInteriorOnly

bool SCR_VehicleActionBase::m_bInteriorOnly

protected

Available only for entities seated in a vehicle.

Definition at line 25 of file SCR_VehicleActionBase.c.

m_bIsToggle

bool SCR_VehicleActionBase::m_bIsToggle

protected

Should action behave as a toggle.

Definition at line 5 of file SCR_VehicleActionBase.c.

m_bPilotOnly

bool SCR_VehicleActionBase::m_bPilotOnly

protected

Available only for entities seated in pilot compartment.

Definition at line 21 of file SCR_VehicleActionBase.c.

m_bTargetState

bool SCR_VehicleActionBase::m_bTargetState

protected

Target state of the action, ignored if toggle.

Definition at line 9 of file SCR_VehicleActionBase.c.

m_sActionStateOff

string SCR_VehicleActionBase::m_sActionStateOff

protected

Description of action to toggle off.

Definition at line 17 of file SCR_VehicleActionBase.c.

m_sActionStateOn

string SCR_VehicleActionBase::m_sActionStateOn

protected

Description of action to toggle on.

Definition at line 13 of file SCR_VehicleActionBase.c.

m_VehicleController

CompartmentControllerComponent SCR_VehicleActionBase::m_VehicleController

protected

Definition at line 33 of file SCR_VehicleActionBase.c.

---

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

• scripts/Game/UserActions/SCR_VehicleActionBase.c