BaseCompartmentSlot.c File Reference

Go to the source code of this file.

Classes
class	BaseCompartmentSlot
class	SCR_BaseScreenShakeData

Functions
BaseCompartmentSlot ExtBaseCompartmentSlot	BaseContainerProps ()
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 ()
BaseCompartmentSlot ExtBaseCompartmentSlot	BaseContainerCustomTitleField ("m_sDefaultOccupantPrefab")

Variables
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

Function Documentation

BaseContainerCustomTitleField()

BaseCompartmentSlot ExtBaseCompartmentSlot BaseContainerCustomTitleField

(

"m_sDefaultOccupantPrefab"

)

Definition at line 456 of file BaseCompartmentSlot.c.

BaseContainerProps()

BaseCompartmentSlot ExtBaseCompartmentSlot BaseContainerProps

(

)

DamageOccupant()

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

protected

Definition at line 138 of file BaseCompartmentSlot.c.

DebugDrawPosition()

override void BaseContainerProps::DebugDrawPosition ( )

protected

Definition at line 38 of file BaseCompartmentSlot.c.

EjectOccupant()

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

protected

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 226 of file BaseCompartmentSlot.c.

GetCompartmentSection()

int BaseContainerProps::GetCompartmentSection ( )

protected

Switching seats is allowed only between compartments with matching area.

Definition at line 62 of file BaseCompartmentSlot.c.

GetDefaultOccupantData()

SCR_DefaultOccupantData BaseContainerProps::GetDefaultOccupantData ( )

protected

Get default occupent prefab data

Returns

Default occupant data

Definition at line 286 of file BaseCompartmentSlot.c.

GetDefaultOccupantPrefab()

ResourceName BaseContainerProps::GetDefaultOccupantPrefab ( bool checkIfValid = true )

protected

Get default occupent prefab ResourceName

Returns

Default occupant prefab

Definition at line 296 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideDown()

float BaseContainerProps::GetFreelookAimLimitOverrideDown ( )

protected

Definition at line 411 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideLeft()

float BaseContainerProps::GetFreelookAimLimitOverrideLeft ( )

protected

Definition at line 423 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideRight()

float BaseContainerProps::GetFreelookAimLimitOverrideRight ( )

protected

Definition at line 429 of file BaseCompartmentSlot.c.

GetFreelookAimLimitOverrideUp()

float BaseContainerProps::GetFreelookAimLimitOverrideUp ( )

protected

Definition at line 417 of file BaseCompartmentSlot.c.

GetFreelookCameraNeckFollowTraverse()

float BaseContainerProps::GetFreelookCameraNeckFollowTraverse ( )

protected

Definition at line 441 of file BaseCompartmentSlot.c.

GetFreelookCameraNeckOffsetScale()

vector BaseContainerProps::GetFreelookCameraNeckOffsetScale ( )

protected

Definition at line 435 of file BaseCompartmentSlot.c.

GetIsWaterTight()

bool BaseContainerProps::GetIsWaterTight ( )

protected

Definition at line 69 of file BaseCompartmentSlot.c.

GetRandomEjectionChance()

float BaseContainerProps::GetRandomEjectionChance ( )

protected

Definition at line 447 of file BaseCompartmentSlot.c.

GetVehicle() [1/2]

IEntity BaseContainerProps::GetVehicle ( )

protected

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 80 of file BaseCompartmentSlot.c.

GetVehicle() [2/2]

IEntity BaseContainerProps::GetVehicle ( out int compartmentID )

protected

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 101 of file BaseCompartmentSlot.c.

IsCompartmentAccessible()

bool BaseContainerProps::IsCompartmentAccessible ( )

protected

Definition at line 49 of file BaseCompartmentSlot.c.

IsOccupied()

bool BaseContainerProps::IsOccupied ( )

protected

Get if compartment is occupied

Returns

returns true if occupied else returns false

Definition at line 132 of file BaseCompartmentSlot.c.

KillOccupant()

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

protected

Definition at line 186 of file BaseCompartmentSlot.c.

ScreenShakeOccupant()

void BaseContainerProps::ScreenShakeOccupant ( float damage )

protected

Definition at line 162 of file BaseCompartmentSlot.c.

SetCompartmentAccessible()

void BaseContainerProps::SetCompartmentAccessible ( bool val )

protected

Definition at line 55 of file BaseCompartmentSlot.c.

SpawnCharacterInCompartment()

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

protected

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 325 of file BaseCompartmentSlot.c.

SpawnDefaultCharacterInCompartment()

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

protected

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 312 of file BaseCompartmentSlot.c.

Variable Documentation

m_bCompartmentAccessible

bool m_bCompartmentAccessible = true

protected

Definition at line 35 of file BaseCompartmentSlot.c.

m_bIsWaterTight

bool m_bIsWaterTight

protected

Definition at line 4 of file BaseCompartmentSlot.c.

m_DefaultOccupantData

ref SCR_DefaultOccupantData m_DefaultOccupantData

protected

Definition at line 7 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideDown

float m_fFreelookAimLimitOverrideDown

protected

Definition at line 13 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideLeft

float m_fFreelookAimLimitOverrideLeft

protected

Definition at line 19 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideRight

float m_fFreelookAimLimitOverrideRight

protected

Definition at line 22 of file BaseCompartmentSlot.c.

m_fFreelookAimLimitOverrideUp

float m_fFreelookAimLimitOverrideUp

protected

Definition at line 16 of file BaseCompartmentSlot.c.

m_fFreelookCameraNeckFollowTraverse

float m_fFreelookCameraNeckFollowTraverse

protected

Definition at line 28 of file BaseCompartmentSlot.c.

m_fRandomEjectionChance

float m_fRandomEjectionChance

protected

Definition at line 31 of file BaseCompartmentSlot.c.

m_iCompartmentSection

int m_iCompartmentSection

protected

Definition at line 1 of file BaseCompartmentSlot.c.

m_ScreenShakeData

ref SCR_BaseScreenShakeData m_ScreenShakeData

protected

Definition at line 10 of file BaseCompartmentSlot.c.

m_vFreelookCameraNeckOffsetScale

vector m_vFreelookCameraNeckOffsetScale

protected

Definition at line 25 of file BaseCompartmentSlot.c.