Inheritance diagram for SCR_CompartmentAccessComponent:

Protected Member Functions
ScriptInvoker	GetOnCompartmentEntered (bool createNew=true)
ScriptInvoker	GetOnCompartmentLeft (bool createNew=true)
OnPlayerEnterCompartment	GetOnPlayerCompartmentEnter (bool createNew=true)
OnPlayerExitCompartment	GetOnPlayerCompartmentExit (bool createNew=true)
void	OnCompartmentEntered (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
void	ToggleTurretFireModeControlls (notnull BaseCompartmentSlot slot, bool entered)
SCR_FireModeManagerComponent	GetControlledFireModeManager ()
void	OnCompartmentLeft (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
BaseCompartmentSlot	FindFreeAndAccessibleCompartment (IEntity vehicle, ECompartmentType compartmentType, BaseCompartmentSlot customSlot=null)
bool	MoveInVehicle (IEntity vehicle, ECompartmentType compartmentType, bool performWhenPaused=false, BaseCompartmentSlot customSlot=null)
void	MoveInVehicleOwner (RplId slotEntityID, int slotID, bool performWhenPaused)
bool	MoveInVehicleAny (IEntity vehicle)
void	AskOwnerToGetOutFromVehicle (EGetOutType type, int doorInfoIndex, ECloseDoorAfterActions closeDoor, bool performWhenPaused, bool ejectOnTheSpot=false)
void	GetOutOwner (EGetOutType type, int doorInfoIndex, ECloseDoorAfterActions closeDoor, bool performWhenPaused, bool ejectOnTheSpot)
IEntity	GetVehicle ()
IEntity	GetVehicle (out int compartmentID)
void	~SCR_CompartmentAccessComponent ()

Static Protected Member Functions
static ECompartmentType	GetCompartmentType (notnull BaseCompartmentSlot compartment)

Protected Attributes
ref OnPlayerEnterCompartment	m_OnPlayerEnterCompartment
ref OnPlayerExitCompartment	m_OnPlayerExitCompartment
SCR_FireModeManagerComponent	m_TurretFireModeManager
const int	WAIT_FOR_VEHICLE_MAX_TRIES = 10

Static Protected Attributes
static int	s_iWaitForVehicleTries = 0

Detailed Description

Definition at line 15 of file SCR_CompartmentAccessComponent.c.

Constructor & Destructor Documentation

◆ ~SCR_CompartmentAccessComponent()

void SCR_CompartmentAccessComponent::~SCR_CompartmentAccessComponent ( )

inlineprotected

Definition at line 396 of file SCR_CompartmentAccessComponent.c.

Member Function Documentation

◆ AskOwnerToGetOutFromVehicle()

void SCR_CompartmentAccessComponent::AskOwnerToGetOutFromVehicle	(	EGetOutType	type,
		int	doorInfoIndex,
		ECloseDoorAfterActions	closeDoor,
		bool	performWhenPaused,
		bool	ejectOnTheSpot = false )

inlineprotected

Method used to ask the owner to leave the compartment

Parameters

[in]	type	how player should get out of the vehicle
[in]	doorInfoIndex	through which door player will try to get out
[in]	closeDoor	should player close the door when he leaves the vehicle
[in]	performWhenPaused
[in]	ejectOnTheSpot	if character should be ejected on the position where he currently is

Definition at line 340 of file SCR_CompartmentAccessComponent.c.

◆ FindFreeAndAccessibleCompartment()

BaseCompartmentSlot SCR_CompartmentAccessComponent::FindFreeAndAccessibleCompartment	(	IEntity	vehicle,
		ECompartmentType	compartmentType,
		BaseCompartmentSlot	customSlot = null )

inlineprotected

Find a compartment that is marked as accessible and not occupied by anyone.

Parameters

vehicle	Target vehicle
compartmentType	Type of compartment

Returns: Compartment, null if none was found

Definition at line 198 of file SCR_CompartmentAccessComponent.c.

◆ GetCompartmentType()

ECompartmentType SCR_CompartmentAccessComponent::GetCompartmentType ( notnull BaseCompartmentSlot compartment )

inlinestaticprotected

Get type of a compartment.

Parameters

compartment Queried compartment

Returns: Compartment type, or -1 if invalid

Definition at line 415 of file SCR_CompartmentAccessComponent.c.

◆ GetControlledFireModeManager()

SCR_FireModeManagerComponent SCR_CompartmentAccessComponent::GetControlledFireModeManager ( )

inlineprotected

Definition at line 148 of file SCR_CompartmentAccessComponent.c.

◆ GetOnCompartmentEntered()

ScriptInvoker SCR_CompartmentAccessComponent::GetOnCompartmentEntered ( bool createNew = true )

inlineprotected

Definition at line 30 of file SCR_CompartmentAccessComponent.c.

◆ GetOnCompartmentLeft()

ScriptInvoker SCR_CompartmentAccessComponent::GetOnCompartmentLeft ( bool createNew = true )

inlineprotected

Definition at line 38 of file SCR_CompartmentAccessComponent.c.

◆ GetOnPlayerCompartmentEnter()

OnPlayerEnterCompartment SCR_CompartmentAccessComponent::GetOnPlayerCompartmentEnter ( bool createNew = true )

inlineprotected

Definition at line 46 of file SCR_CompartmentAccessComponent.c.

◆ GetOnPlayerCompartmentExit()

OnPlayerExitCompartment SCR_CompartmentAccessComponent::GetOnPlayerCompartmentExit ( bool createNew = true )

inlineprotected

Definition at line 55 of file SCR_CompartmentAccessComponent.c.

◆ GetOutOwner()

void SCR_CompartmentAccessComponent::GetOutOwner	(	EGetOutType	type,
		int	doorInfoIndex,
		ECloseDoorAfterActions	closeDoor,
		bool	performWhenPaused,
		bool	ejectOnTheSpot )

inlineprotected

Replicated method executed by the owner of the character in order to get out of the vehicle

Parameters

[in]	type	how player should get out of the vehicle
[in]	doorInfoIndex	through which door player will try to get out
[in]	closeDoor	should player close the door when he leaves the vehicle
[in]	performWhenPaused
[in]	ejectOnTheSpot	if character should be ejected on the position where he currently is

Definition at line 356 of file SCR_CompartmentAccessComponent.c.

◆ GetVehicle() [1/2]

IEntity SCR_CompartmentAccessComponent::GetVehicle ( )

inlineprotected

Get vehicle this entity is in. Works even when the entity is not directly in the vehicle, but in one of its child entities (e.g., turrets) Use this function when you specifically need pointer to the vehicle. If you want to simply check if a character is in a vehicle, use IsInCompartment()!

Returns: Vehicle, null when not in any compartment

Definition at line 381 of file SCR_CompartmentAccessComponent.c.

◆ GetVehicle() [2/2]

IEntity SCR_CompartmentAccessComponent::GetVehicle ( out int compartmentID )

inlineprotected

Definition at line 388 of file SCR_CompartmentAccessComponent.c.

◆ MoveInVehicle()

bool SCR_CompartmentAccessComponent::MoveInVehicle	(	IEntity	vehicle,
		ECompartmentType	compartmentType,
		bool	performWhenPaused = false,
		BaseCompartmentSlot	customSlot = null )

inlineprotected

Move in vehicle to specified slot type. When executed on server while the character is owned by a client, this function will send the request there.

Parameters

vehicle	Target vehicle
compartmentType	Type of compartment

Returns: True if the request was successful

Definition at line 257 of file SCR_CompartmentAccessComponent.c.

◆ MoveInVehicleAny()

bool SCR_CompartmentAccessComponent::MoveInVehicleAny ( IEntity vehicle )

inlineprotected

Move in vehicle to any available slot. When executed on server while the character is owned by a client, this function will send the request there.

Parameters

vehicle Target vehicle

Returns: True if the request was successful

Definition at line 315 of file SCR_CompartmentAccessComponent.c.

◆ MoveInVehicleOwner()

void SCR_CompartmentAccessComponent::MoveInVehicleOwner	(	RplId	slotEntityID,
		int	slotID,
		bool	performWhenPaused )

inlineprotected

Definition at line 281 of file SCR_CompartmentAccessComponent.c.

◆ OnCompartmentEntered()

void SCR_CompartmentAccessComponent::OnCompartmentEntered	(	IEntity	targetEntity,
		BaseCompartmentManagerComponent	manager,
		int	mgrID,
		int	slotID,
		bool	move )

inlineprotected

Definition at line 64 of file SCR_CompartmentAccessComponent.c.

◆ OnCompartmentLeft()

void SCR_CompartmentAccessComponent::OnCompartmentLeft	(	IEntity	targetEntity,
		BaseCompartmentManagerComponent	manager,
		int	mgrID,
		int	slotID,
		bool	move )

inlineprotected

Definition at line 154 of file SCR_CompartmentAccessComponent.c.

◆ OnLifeStateChanged()

void SCR_CompartmentAccessComponent::OnLifeStateChanged	(	ECharacterLifeState	previousLifeState,
		ECharacterLifeState	newLifeState )

inlineprotected

Definition at line 179 of file SCR_CompartmentAccessComponent.c.

◆ ToggleTurretFireModeControlls()

void SCR_CompartmentAccessComponent::ToggleTurretFireModeControlls	(	notnull BaseCompartmentSlot	slot,
		bool	entered )

inlineprotected

Updates the inputs for fire mode manager of a turret

Parameters

[in]	slot	for which this should be exectued
[in]	entered

Definition at line 96 of file SCR_CompartmentAccessComponent.c.

Member Data Documentation

◆ m_OnPlayerEnterCompartment

ref OnPlayerEnterCompartment SCR_CompartmentAccessComponent::m_OnPlayerEnterCompartment

protected

Definition at line 21 of file SCR_CompartmentAccessComponent.c.

◆ m_OnPlayerExitCompartment

ref OnPlayerExitCompartment SCR_CompartmentAccessComponent::m_OnPlayerExitCompartment

protected

Definition at line 22 of file SCR_CompartmentAccessComponent.c.

◆ m_TurretFireModeManager

SCR_FireModeManagerComponent SCR_CompartmentAccessComponent::m_TurretFireModeManager

protected

Definition at line 24 of file SCR_CompartmentAccessComponent.c.

◆ s_iWaitForVehicleTries

int SCR_CompartmentAccessComponent::s_iWaitForVehicleTries = 0

staticprotected

Definition at line 27 of file SCR_CompartmentAccessComponent.c.

◆ WAIT_FOR_VEHICLE_MAX_TRIES

const int SCR_CompartmentAccessComponent::WAIT_FOR_VEHICLE_MAX_TRIES = 10

protected

Definition at line 26 of file SCR_CompartmentAccessComponent.c.

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

scripts/Game/Vehicle/SCR_CompartmentAccessComponent.c

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~SCR_CompartmentAccessComponent()

Member Function Documentation

◆ AskOwnerToGetOutFromVehicle()

◆ FindFreeAndAccessibleCompartment()

◆ GetCompartmentType()

◆ GetControlledFireModeManager()

◆ GetOnCompartmentEntered()

◆ GetOnCompartmentLeft()

◆ GetOnPlayerCompartmentEnter()

◆ GetOnPlayerCompartmentExit()

◆ GetOutOwner()

◆ GetVehicle() [1/2]

◆ GetVehicle() [2/2]

◆ MoveInVehicle()

◆ MoveInVehicleAny()

◆ MoveInVehicleOwner()

◆ OnCompartmentEntered()

◆ OnCompartmentLeft()

◆ OnLifeStateChanged()

◆ ToggleTurretFireModeControlls()

Member Data Documentation

◆ m_OnPlayerEnterCompartment

◆ m_OnPlayerExitCompartment

◆ m_TurretFireModeManager

◆ s_iWaitForVehicleTries

◆ WAIT_FOR_VEHICLE_MAX_TRIES