LightUserAction Class Reference

Inheritance diagram for LightUserAction:

Protected Member Functions
override bool	CanBePerformedScript (IEntity user)
override bool	CanBroadcastScript ()
override bool	CanBeShownScript (IEntity user)
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
override bool	GetActionNameScript (out string outName)
bool	GetLightAudioPos (out vector pos)
void	PlaySound (IEntity ownerEntity, bool lightsState)

Protected Attributes
ELightType	m_eLightType
	Type of action instead of 8 different classes.
int	m_iLightSide
	Side of turn signals.
bool	m_bInteriorOnly
	Will only be shown if user is in vehicle?
bool	m_bPilotOnly
	Will action be available for entities seated in pilot compartment only?
bool	m_bPilotUncapableOverride
LocalizedString	m_sBlockedByPilotText
ref array< int >	m_aDefinedCompartmentSectionsOnly
ref array< int >	m_aExcludeDefinedCompartmentSections

Detailed Description

Definition at line 1 of file LightUserAction.c.

Member Function Documentation

CanBePerformedScript()

override bool LightUserAction::CanBePerformedScript ( IEntity user )

inlineprotected

Definition at line 32 of file LightUserAction.c.

CanBeShownScript()

override bool LightUserAction::CanBeShownScript ( IEntity user )

inlineprotected

Definition at line 55 of file LightUserAction.c.

CanBroadcastScript()

override bool LightUserAction::CanBroadcastScript ( )

inlineprotected

Definition at line 49 of file LightUserAction.c.

GetActionNameScript()

override bool LightUserAction::GetActionNameScript ( out string outName )

inlineprotected

Definition at line 102 of file LightUserAction.c.

GetLightAudioPos()

bool LightUserAction::GetLightAudioPos ( out vector pos )

inlineprotected

Definition at line 120 of file LightUserAction.c.

PerformAction()

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

inlineprotected

Definition at line 69 of file LightUserAction.c.

PlaySound()

void LightUserAction::PlaySound ( IEntity ownerEntity, bool lightsState )

inlineprotected

Definition at line 135 of file LightUserAction.c.

Member Data Documentation

m_aDefinedCompartmentSectionsOnly

ref array<int> LightUserAction::m_aDefinedCompartmentSectionsOnly

protected

Definition at line 26 of file LightUserAction.c.

m_aExcludeDefinedCompartmentSections

ref array<int> LightUserAction::m_aExcludeDefinedCompartmentSections

protected

Definition at line 29 of file LightUserAction.c.

m_bInteriorOnly

bool LightUserAction::m_bInteriorOnly

protected

Will only be shown if user is in vehicle?

Definition at line 13 of file LightUserAction.c.

m_bPilotOnly

bool LightUserAction::m_bPilotOnly

protected

Will action be available for entities seated in pilot compartment only?

Definition at line 17 of file LightUserAction.c.

m_bPilotUncapableOverride

bool LightUserAction::m_bPilotUncapableOverride

protected

Definition at line 20 of file LightUserAction.c.

m_eLightType

ELightType LightUserAction::m_eLightType

protected

Type of action instead of 8 different classes.

Definition at line 5 of file LightUserAction.c.

m_iLightSide

int LightUserAction::m_iLightSide

protected

Side of turn signals.

Definition at line 9 of file LightUserAction.c.

m_sBlockedByPilotText

LocalizedString LightUserAction::m_sBlockedByPilotText

protected

Definition at line 23 of file LightUserAction.c.

---

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

• scripts/GameCode/UserAction/LightUserAction.c