CompartmentAccessComponent Interface Reference

Inheritance diagram for CompartmentAccessComponent:

Public Member Functions
proto external BaseCompartmentSlot	GetCompartment ()
	Returns the compartent we're in.
proto external BaseCompartmentSlot	FindFreeCompartment (IEntity targetEntity, ECompartmentType compartmentType, bool useReserved=true)
	Returns the first free compartment of a given type on.
proto external BaseCompartmentSlot	FindCompartmentReservedBy (IEntity targetEntity, IEntity reservedBy)
proto external bool	IsInCompartment ()
	Returns true if we're inside a compartment.
proto external bool	IsInCompartmentADS ()
	Returns true if we're inside a compartment with enabled ADS.
proto external bool	IsTargetVehicleAccessible (IEntity targetEntity)
	Returns true if.
proto external bool	GetInVehicle (IEntity vehicle, BaseCompartmentSlot compartment, bool forceTeleport, int doorInfoIndex, ECloseDoorAfterActions closeDoor, bool performWhenPaused)
proto external bool	GetOutVehicle (EGetOutType type, int doorInfoIndex, ECloseDoorAfterActions closeDoor, bool performWhenPaused)
proto external bool	GetOutVehicle_NoDoor (vector targetTransform[4], bool sendIntoRagdoll, bool performWhenPaused)
proto external void	KickFromVehicle (int doorInfoIndex)
proto external bool	OpenDoor (IEntity vehicle, ECharacterDoorAnimType doorAnimType, int doorInfoIndex)
proto external bool	CloseDoor (IEntity vehicle, ECharacterDoorAnimType doorAnimType, int doorInfoIndex)
proto external void	InterruptVehicleActionQueue (bool interruptCurrentAction, bool forced, bool replicate)
proto external bool	CanGetInVehicle (IEntity targetEntity)
	Returns true if.
proto external IEntity	GetOwner ()
	Returns the entity owning the component.
proto external bool	CanGetInVehicleViaDoor (IEntity targetEntity, BaseCompartmentManagerComponent compartmentManagerCompartment, int doorInfoIndex)
	Returns true if.
proto external bool	CanAccessDoor (IEntity targetEntity, BaseCompartmentManagerComponent compartmentManagerCompartment, int doorInfoIndex)
	Returns true if.
proto external bool	IsGettingIn ()
	Returns true while getting in.
proto external bool	IsGettingOut ()
	Returns true while getting out.
proto external bool	CanGetOutVehicle ()
	Returns true if compartment can be gotten out of.
proto external bool	CanGetOutVehicleViaDoor (int doorIndex)
	Returns true if compartment can be gotten out of via the door with index.
proto external bool	FindSuitableTeleportLocation (vector TR[4])
proto external bool	CanJumpOutVehicle ()
	Returns true if current compartment can be jumped from.
proto external bool	IsVehicleFlipped (float dotThreshold)
proto external bool	CompareSeatOutVectorAndGravity (float dotThreshold)
proto external void	SetActivePilotCompartment (BaseCompartmentSlot pilotCompartment)
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Static Public Member Functions
static proto IEntity	GetVehicleIn (IEntity entity)
	Returns the vehicle entity is in (root entity of whole hierarchy)

Protected Member Functions
void	OnCompartmentEntered (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
void	OnCompartmentLeft (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)

Member Function Documentation

CanAccessDoor()

proto external bool CompartmentAccessComponent.CanAccessDoor	(	IEntity	targetEntity,
		BaseCompartmentManagerComponent	compartmentManagerCompartment,
		int	doorInfoIndex
	)

Returns true if.

Parameters

doorIndex

can be closed/opened

CanGetInVehicle()

proto external bool CompartmentAccessComponent.CanGetInVehicle

(

IEntity

targetEntity

)

Returns true if.

Parameters

targetEntity

can be entered at this time

CanGetInVehicleViaDoor()

proto external bool CompartmentAccessComponent.CanGetInVehicleViaDoor	(	IEntity	targetEntity,
		BaseCompartmentManagerComponent	compartmentManagerCompartment,
		int	doorInfoIndex
	)

Returns true if.

Parameters

targetEntity

can be entered at this time

CanGetOutVehicle()

proto external bool CompartmentAccessComponent.CanGetOutVehicle

(

)

Returns true if compartment can be gotten out of.

CanGetOutVehicleViaDoor()

proto external bool CompartmentAccessComponent.CanGetOutVehicleViaDoor

(

int

doorIndex

)

Returns true if compartment can be gotten out of via the door with index.

Parameters

doorIndex

CanJumpOutVehicle()

proto external bool CompartmentAccessComponent.CanJumpOutVehicle

(

)

Returns true if current compartment can be jumped from.

CloseDoor()

proto external bool CompartmentAccessComponent.CloseDoor	(	IEntity	vehicle,
		ECharacterDoorAnimType	doorAnimType,
		int	doorInfoIndex
	)

CompareSeatOutVectorAndGravity()

proto external bool CompartmentAccessComponent.CompareSeatOutVectorAndGravity

(

float

dotThreshold

)

FindCompartmentReservedBy()

proto external BaseCompartmentSlot CompartmentAccessComponent.FindCompartmentReservedBy	(	IEntity	targetEntity,
		IEntity	reservedBy
	)

FindFreeCompartment()

proto external BaseCompartmentSlot CompartmentAccessComponent.FindFreeCompartment	(	IEntity	targetEntity,
		ECompartmentType	compartmentType,
		bool	useReserved = true
	)

Returns the first free compartment of a given type on.

Parameters

targetEntity

FindSuitableTeleportLocation()

proto external bool CompartmentAccessComponent.FindSuitableTeleportLocation

(

vector

TR[4]

)

GetCompartment()

proto external BaseCompartmentSlot CompartmentAccessComponent.GetCompartment

(

)

Returns the compartent we're in.

GetInVehicle()

proto external bool CompartmentAccessComponent.GetInVehicle	(	IEntity	vehicle,
		BaseCompartmentSlot	compartment,
		bool	forceTeleport,
		int	doorInfoIndex,
		ECloseDoorAfterActions	closeDoor,
		bool	performWhenPaused
	)

GetOutVehicle()

proto external bool CompartmentAccessComponent.GetOutVehicle	(	EGetOutType	type,
		int	doorInfoIndex,
		ECloseDoorAfterActions	closeDoor,
		bool	performWhenPaused
	)

GetOutVehicle_NoDoor()

proto external bool CompartmentAccessComponent.GetOutVehicle_NoDoor	(	vector	targetTransform[4],
		bool	sendIntoRagdoll,
		bool	performWhenPaused
	)

GetOwner()

proto external IEntity CompartmentAccessComponent.GetOwner

(

)

Returns the entity owning the component.

GetVehicleIn()

static proto IEntity CompartmentAccessComponent.GetVehicleIn ( IEntity  entity )

static

Returns the vehicle entity is in (root entity of whole hierarchy)

InterruptVehicleActionQueue()

proto external void CompartmentAccessComponent.InterruptVehicleActionQueue	(	bool	interruptCurrentAction,
		bool	forced,
		bool	replicate
	)

IsGettingIn()

proto external bool CompartmentAccessComponent.IsGettingIn

(

)

Returns true while getting in.

IsGettingOut()

proto external bool CompartmentAccessComponent.IsGettingOut

(

)

Returns true while getting out.

IsInCompartment()

proto external bool CompartmentAccessComponent.IsInCompartment

(

)

Returns true if we're inside a compartment.

IsInCompartmentADS()

proto external bool CompartmentAccessComponent.IsInCompartmentADS

(

)

Returns true if we're inside a compartment with enabled ADS.

IsTargetVehicleAccessible()

proto external bool CompartmentAccessComponent.IsTargetVehicleAccessible

(

IEntity

targetEntity

)

Returns true if.

Parameters

targetEntity

is accessible for getting in (e.g. not upside down)

IsVehicleFlipped()

proto external bool CompartmentAccessComponent.IsVehicleFlipped

(

float

dotThreshold

)

KickFromVehicle()

proto external void CompartmentAccessComponent.KickFromVehicle

(

int

doorInfoIndex

)

OnCompartmentEntered()

void CompartmentAccessComponent.OnCompartmentEntered ( IEntity  targetEntity, BaseCompartmentManagerComponent  manager, int  mgrID, int  slotID, bool  move  )

protected

Implemented in SCR_CompartmentAccessComponent.

OnCompartmentLeft()

void CompartmentAccessComponent.OnCompartmentLeft ( IEntity  targetEntity, BaseCompartmentManagerComponent  manager, int  mgrID, int  slotID, bool  move  )

protected

Implemented in SCR_CompartmentAccessComponent.

OpenDoor()

proto external bool CompartmentAccessComponent.OpenDoor	(	IEntity	vehicle,
		ECharacterDoorAnimType	doorAnimType,
		int	doorInfoIndex
	)

SetActivePilotCompartment()

proto external void CompartmentAccessComponent.SetActivePilotCompartment

(

BaseCompartmentSlot

pilotCompartment

)

---

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

• Game/generated/Components/CompartmentAccessComponent.c