SCR_ChangeComparmentAction Class Reference

Inheritance diagram for SCR_ChangeComparmentAction:

Protected Member Functions
override bool	CanBeShownScript (IEntity user)
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
override int	GetRelevantDoorIndex (IEntity caller)
BaseCompartmentSlot	GetFreeCompartmentSlot ()
PilotCompartmentSlot	GetPilotCompartmentSlot ()

Protected Attributes
bool	m_bUsePilotCompartment
string	m_sCompartmentSlotName
ChimeraCharacter	m_Character
BaseCompartmentSlot	m_NonOccupiedSlot

Detailed Description

Definition at line 1 of file SCR_ChangeComparmentAction.c.

Member Function Documentation

CanBeShownScript()

override bool SCR_ChangeComparmentAction::CanBeShownScript ( IEntity user )

inlineprotected

Definition at line 15 of file SCR_ChangeComparmentAction.c.

GetFreeCompartmentSlot()

BaseCompartmentSlot SCR_ChangeComparmentAction::GetFreeCompartmentSlot ( )

inlineprotected

Check the defined Compartment for any free slots

Returns

BaseCompartmentSlot if free slot was found, null otherwise

Definition at line 91 of file SCR_ChangeComparmentAction.c.

GetPilotCompartmentSlot()

PilotCompartmentSlot SCR_ChangeComparmentAction::GetPilotCompartmentSlot ( )

inlineprotected

Get the Pilot compartment

Returns

PilotCompartmentSlot if player sits in the pilot slot of the vehicle, null otherwise

Definition at line 142 of file SCR_ChangeComparmentAction.c.

GetRelevantDoorIndex()

override int SCR_ChangeComparmentAction::GetRelevantDoorIndex ( IEntity caller )

inlineprotected

Definition at line 63 of file SCR_ChangeComparmentAction.c.

PerformAction()

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

inlineprotected

Definition at line 39 of file SCR_ChangeComparmentAction.c.

Member Data Documentation

m_bUsePilotCompartment

bool SCR_ChangeComparmentAction::m_bUsePilotCompartment

protected

Definition at line 4 of file SCR_ChangeComparmentAction.c.

m_Character

ChimeraCharacter SCR_ChangeComparmentAction::m_Character

protected

Definition at line 9 of file SCR_ChangeComparmentAction.c.

m_NonOccupiedSlot

BaseCompartmentSlot SCR_ChangeComparmentAction::m_NonOccupiedSlot

protected

Definition at line 12 of file SCR_ChangeComparmentAction.c.

m_sCompartmentSlotName

string SCR_ChangeComparmentAction::m_sCompartmentSlotName

protected

Definition at line 7 of file SCR_ChangeComparmentAction.c.

---

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

• scripts/Game/UserActions/SCR_ChangeComparmentAction.c