BaseCompartmentSlot Class Reference

Inheritance diagram for BaseCompartmentSlot:

Protected Member Functions
override void	DebugDrawPosition ()
bool	IsCompartmentAccessible ()
void	SetCompartmentAccessible (bool val)
int	GetCompartmentSection ()
	Switching seats is allowed only between compartments with matching area.
bool	GetIsWaterTight ()
IEntity	GetVehicle ()
IEntity	GetVehicle (out int compartmentID)
bool	IsOccupied ()
void	DamageOccupant (float damage, EDamageType damageType, notnull Instigator instigator, bool damageWhileGetIn=true, bool damageWhileGetOut=true)
void	ScreenShakeOccupant (float damage)
void	KillOccupant (notnull Instigator instigator, bool eject=false, bool gettingIn=false, bool gettingOut=false)
bool	EjectOccupant (bool forceEject=false, bool ejectUnconsciously=false, out bool ejectedImmediately=false, bool ejectOnTheSpot=false)
SCR_DefaultOccupantData	GetDefaultOccupantData ()
ResourceName	GetDefaultOccupantPrefab (bool checkIfValid=true)
IEntity	SpawnDefaultCharacterInCompartment (inout AIGroup group, ResourceName groupPrefab="{000CD338713F2B5A}Prefabs/AI/Groups/Group_Base.et")
IEntity	SpawnCharacterInCompartment (ResourceName characterPrefab, inout AIGroup group, ResourceName groupPrefab="{000CD338713F2B5A}Prefabs/AI/Groups/Group_Base.et")
float	GetFreelookAimLimitOverrideDown ()
float	GetFreelookAimLimitOverrideUp ()
float	GetFreelookAimLimitOverrideLeft ()
float	GetFreelookAimLimitOverrideRight ()
vector	GetFreelookCameraNeckOffsetScale ()
float	GetFreelookCameraNeckFollowTraverse ()
float	GetRandomEjectionChance ()

Protected Attributes
int	m_iCompartmentSection
bool	m_bIsWaterTight
ref SCR_DefaultOccupantData	m_DefaultOccupantData
ref SCR_BaseScreenShakeData	m_ScreenShakeData
float	m_fFreelookAimLimitOverrideDown
float	m_fFreelookAimLimitOverrideUp
float	m_fFreelookAimLimitOverrideLeft
float	m_fFreelookAimLimitOverrideRight
vector	m_vFreelookCameraNeckOffsetScale
float	m_fFreelookCameraNeckFollowTraverse
float	m_fRandomEjectionChance
bool	m_bCompartmentAccessible = true

Static Protected Attributes
static const vector	SPAWN_IN_VEHICLE_OFFSET = Vector(0, 250, 0)

Detailed Description

Definition at line 1 of file BaseCompartmentSlot.c.

Member Function Documentation

DamageOccupant()

void BaseCompartmentSlot::DamageOccupant ( float damage, EDamageType damageType, notnull Instigator instigator, bool damageWhileGetIn = true, bool damageWhileGetOut = true )

inlineprotected

Definition at line 141 of file BaseCompartmentSlot.c.

DebugDrawPosition()

override void BaseCompartmentSlot::DebugDrawPosition ( )

inlineprotected

Definition at line 41 of file BaseCompartmentSlot.c.

EjectOccupant()

bool BaseCompartmentSlot::EjectOccupant ( bool forceEject = false, bool ejectUnconsciously = false, out bool ejectedImmediately = false, bool ejectOnTheSpot = false )

inlineprotected

Force eject occupant from this compartment

Parameters

[in]	forceEject	Force occupant out of compartment regardless of whether it makes sense realistically.
[in]	ejectUnconsciously	Force ejected character to be unconscious
[out]	ejectedImmediately	returns true if this client was capable of ejecting character that is in this compartment
[in]	ejectOnTheSpot	if character should be ejected in the position where he currently is

Returns

true if character was ejected

Definition at line 229 of file BaseCompartmentSlot.c.

GetCompartmentSection()

int BaseCompartmentSlot::GetCompartmentSection ( )

inlineprotected

Switching seats is allowed only between compartments with matching area.

Definition at line 65 of file BaseCompartmentSlot.c.

GetDefaultOccupantData()

SCR_DefaultOccupantData BaseCompartmentSlot::GetDefaultOccupantData ( )

inlineprotected

Get default occupent prefab data

Returns

Default occupant data

Definition at line 289 of file BaseCompartmentSlot.c.

GetDefaultOccupantPrefab()

ResourceName BaseCompartmentSlot::GetDefaultOccupantPrefab ( bool checkIfValid = true )

inlineprotected

Get default occupent prefab ResourceName

Returns

Default occupant prefab

Definition at line 299 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideDown()

float BaseCompartmentSlot::GetFreelookAimLimitOverrideDown ( )

inlineprotected

Definition at line 414 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideLeft()

float BaseCompartmentSlot::GetFreelookAimLimitOverrideLeft ( )

inlineprotected

Definition at line 426 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideRight()

float BaseCompartmentSlot::GetFreelookAimLimitOverrideRight ( )

inlineprotected

Definition at line 432 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideUp()

float BaseCompartmentSlot::GetFreelookAimLimitOverrideUp ( )

inlineprotected

Definition at line 420 of file BaseCompartmentSlot.c.

GetFreelookCameraNeckFollowTraverse()

float BaseCompartmentSlot::GetFreelookCameraNeckFollowTraverse ( )

inlineprotected

Definition at line 444 of file BaseCompartmentSlot.c.

GetFreelookCameraNeckOffsetScale()

vector BaseCompartmentSlot::GetFreelookCameraNeckOffsetScale ( )

inlineprotected

Definition at line 438 of file BaseCompartmentSlot.c.

GetIsWaterTight()

bool BaseCompartmentSlot::GetIsWaterTight ( )

inlineprotected

Definition at line 72 of file BaseCompartmentSlot.c.

GetRandomEjectionChance()

float BaseCompartmentSlot::GetRandomEjectionChance ( )

inlineprotected

Definition at line 450 of file BaseCompartmentSlot.c.

GetVehicle() [1/2]

IEntity BaseCompartmentSlot::GetVehicle ( )

inlineprotected

Get vehicle this slot belongs to. May differ from GetOwner() if the slot is placed in vehicle's child entity, e.g., truck's cargo frame.

Returns

Vehicle entity

Definition at line 83 of file BaseCompartmentSlot.c.

GetVehicle() [2/2]

IEntity BaseCompartmentSlot::GetVehicle ( out int compartmentID )

inlineprotected

Get vehicle this slot belongs to. May differ from GetOwner() if the slot is placed in vehicle's child entity, e.g., truck's cargo frame.

Parameters

[out]

compartmentID

Variable to be filled with ID of the compartment relative to the vehicle. May differ from GetCompartmentSlotID() which returns only ID within the entity the slot belong sto.

Returns

Vehicle entity

Definition at line 104 of file BaseCompartmentSlot.c.

IsCompartmentAccessible()

bool BaseCompartmentSlot::IsCompartmentAccessible ( )

inlineprotected

Definition at line 52 of file BaseCompartmentSlot.c.

IsOccupied()

bool BaseCompartmentSlot::IsOccupied ( )

inlineprotected

Get if compartment is occupied

Returns

returns true if occupied else returns false

Definition at line 135 of file BaseCompartmentSlot.c.

KillOccupant()

void BaseCompartmentSlot::KillOccupant ( notnull Instigator instigator, bool eject = false, bool gettingIn = false, bool gettingOut = false )

inlineprotected

Definition at line 189 of file BaseCompartmentSlot.c.

ScreenShakeOccupant()

void BaseCompartmentSlot::ScreenShakeOccupant ( float damage )

inlineprotected

Definition at line 165 of file BaseCompartmentSlot.c.

SetCompartmentAccessible()

void BaseCompartmentSlot::SetCompartmentAccessible ( bool val )

inlineprotected

Definition at line 58 of file BaseCompartmentSlot.c.

SpawnCharacterInCompartment()

IEntity BaseCompartmentSlot::SpawnCharacterInCompartment ( ResourceName characterPrefab, inout AIGroup group, ResourceName groupPrefab = "{000CD338713F2B5A}Prefabs/AI/Groups/Group_Base.et" )

inlineprotected

Spawn character within the compartment (Server only)

Parameters

	characterPrefab	Prefab to spawn in compartment
[in,out]	group	if Left empty it will create a new group and place the character in it and return it. Else it will place the character in the given group
	createGroupForCharacter	If a group should be created for the spawned character

Returns

Returns spawned character

Definition at line 328 of file BaseCompartmentSlot.c.

SpawnDefaultCharacterInCompartment()

IEntity BaseCompartmentSlot::SpawnDefaultCharacterInCompartment ( inout AIGroup group, ResourceName groupPrefab = "{000CD338713F2B5A}Prefabs/AI/Groups/Group_Base.et" )

inlineprotected

Spawn default character within the compartment (Server only) Default characters are defined on the CompartmentSlot

Parameters

[in,out]	group	if Left empty it will create a new group and place the character in it and return it. Else it will place the character in the given group
	groupPrefabGroup	prefab, Generally want to keep it as default value as faction and usch is set automaticly

Returns

Returns spawned character

Definition at line 315 of file BaseCompartmentSlot.c.

Member Data Documentation

m_bCompartmentAccessible

bool BaseCompartmentSlot::m_bCompartmentAccessible = true

protected

Definition at line 38 of file BaseCompartmentSlot.c.

m_bIsWaterTight

bool BaseCompartmentSlot::m_bIsWaterTight

protected

Definition at line 7 of file BaseCompartmentSlot.c.

m_DefaultOccupantData

ref SCR_DefaultOccupantData BaseCompartmentSlot::m_DefaultOccupantData

protected

Definition at line 10 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideDown

float BaseCompartmentSlot::m_fFreelookAimLimitOverrideDown

protected

Definition at line 16 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideLeft

float BaseCompartmentSlot::m_fFreelookAimLimitOverrideLeft

protected

Definition at line 22 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideRight

float BaseCompartmentSlot::m_fFreelookAimLimitOverrideRight

protected

Definition at line 25 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideUp

float BaseCompartmentSlot::m_fFreelookAimLimitOverrideUp

protected

Definition at line 19 of file BaseCompartmentSlot.c.

m_fFreelookCameraNeckFollowTraverse

float BaseCompartmentSlot::m_fFreelookCameraNeckFollowTraverse

protected

Definition at line 31 of file BaseCompartmentSlot.c.

m_fRandomEjectionChance

float BaseCompartmentSlot::m_fRandomEjectionChance

protected

Definition at line 34 of file BaseCompartmentSlot.c.

m_iCompartmentSection

int BaseCompartmentSlot::m_iCompartmentSection

protected

Definition at line 4 of file BaseCompartmentSlot.c.

m_ScreenShakeData

ref SCR_BaseScreenShakeData BaseCompartmentSlot::m_ScreenShakeData

protected

Definition at line 13 of file BaseCompartmentSlot.c.

m_vFreelookCameraNeckOffsetScale

vector BaseCompartmentSlot::m_vFreelookCameraNeckOffsetScale

protected

Definition at line 28 of file BaseCompartmentSlot.c.

SPAWN_IN_VEHICLE_OFFSET

const vector BaseCompartmentSlot::SPAWN_IN_VEHICLE_OFFSET = Vector(0, 250, 0)

staticprotected

Definition at line 36 of file BaseCompartmentSlot.c.

---

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

• scripts/GameCode/Vehicle/BaseCompartmentSlot.c