Data Structures
class	SCR_EditableVehicleComponentClass

Functions
int	GetPlayerCountInVehicle ()

protected void	OnFactionUpdate (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)

protected void	OnDestroyed (IEntity owner)

override Faction	GetFaction ()

override ScriptInvoker	GetOnUIRefresh ()

override SCR_EditableEntityComponent	GetAIGroup ()

override SCR_EditableEntityComponent	GetAIEntity ()

override int	GetPlayerID ()

void	UpdatePlayerCountInVehicle ()

override int	GetCrew (out notnull array< CompartmentAccessComponent > crewCompartmentAccess, bool ignorePlayers=true)

protected void	PlayerTeleportedFeedback ()
	Add feedback to players that they are teleported when inside of the vehicle. More...

override void	SetTransform (vector transform[4], bool changedByUser=false)

bool	CanOccupyVehicleWithCharacters (array< ECompartmentType > compartmentTypes, bool checkHasDefaultOccupantsData, int playerID, bool checkEditorBudget=true, bool checkOccupyingFaction=true, bool checkForFreeCompartments=true, bool checkForFreeDefaultCompartments=false)

protected bool	HasEnoughBudgetForDefaultOccupants (array< ECompartmentType > compartmentTypes, int playerID, EEditorMode editorMode, out bool noFreeDefaultCompartments)

void	OccupyVehicleWithDefaultCharacters (notnull array< ECompartmentType > compartmentTypes)

SCR_BaseCompartmentManagerComponent	GetCompartmentManager ()

override SCR_EditableEntityComponent	EOnEditorPlace (out SCR_EditableEntityComponent parent, SCR_EditableEntityComponent recipient, EEditorPlacingFlags flags, bool isQueue, int playerID=0)

override void	EOnPhysicsActive (IEntity owner, bool activeState)

override void	OnPostInit (IEntity owner)
	Editable Mine. More...

void	~SCR_EditableVehicleComponent ()

Variables
SCR_EditableVehicleComponentClass	m_CompartmentManager
	Special configuration for editable wehicle. More...

protected SCR_VehicleFactionAffiliationComponent	m_VehicleFactionAffiliation

protected ref ScriptInvoker	m_OnUIRefresh

protected int	m_iPlayersInVehicle

Function Documentation

◆ CanOccupyVehicleWithCharacters()

bool CanOccupyVehicleWithCharacters	(	array< ECompartmentType >	compartmentTypes,
		bool	checkHasDefaultOccupantsData,
		int	playerID,
		bool	checkEditorBudget = `true`,
		bool	checkOccupyingFaction = `true`,
		bool	checkForFreeCompartments = `true`,
		bool	checkForFreeDefaultCompartments = `false`
	)

Check if vehicle can spawn characters (Of vehicle Faction) in the vehicle. Cannot spawn characters in vehicle if occupied by another faction that is hostile

Parameters

[in]	compartmentTypes	Given compartment types that need to be checked if can be filled.
[in]	checkHasDefaultOccupantsData
[in]	playerID	If server player ID must be given of the player that wans to check if can occupy, if client no ID needs to be given
[in]	checkEditorBudget	If true will check if characters to spawn are within budget. Function will return false if there isn't enough budget
[in]	checkOccupyingFaction	If true function will check if the faction of the vehicle is null (empty) or the same/friendly to the static faction as given in the editableUIInfo. Function will return false if faction is hostile or neutral
[in]	checkForFreeCompartments	If true will check if there are compartments free for the given compartments types. Function will return false if there are no free compartments of given type
[in]	checkForFreeDefaultCompartments

Returns: Will return true if a character can be spawned in at least one compartment

Definition at line 225 of file SCR_EditableVehicleComponent.c.

◆ EOnEditorPlace()

override SCR_EditableEntityComponent EOnEditorPlace	(	out SCR_EditableEntityComponent	parent,
		SCR_EditableEntityComponent	recipient,
		EEditorPlacingFlags	flags,
		bool	isQueue,
		int	playerID = `0`
	)

Definition at line 330 of file SCR_EditableVehicleComponent.c.

◆ EOnPhysicsActive()

override void EOnPhysicsActive	(	IEntity	owner,
		bool	activeState
	)

Definition at line 371 of file SCR_EditableVehicleComponent.c.

◆ GetAIEntity()

override SCR_EditableEntityComponent GetAIEntity ( )

Definition at line 78 of file SCR_EditableVehicleComponent.c.

◆ GetAIGroup()

override SCR_EditableEntityComponent GetAIGroup ( )

Definition at line 61 of file SCR_EditableVehicleComponent.c.

◆ GetCompartmentManager()

SCR_BaseCompartmentManagerComponent GetCompartmentManager ( )

Get Compartment manager of vehicle

Returns: Compartment manager

Definition at line 324 of file SCR_EditableVehicleComponent.c.

◆ GetCrew()

override int GetCrew	(	out notnull array< CompartmentAccessComponent >	crewCompartmentAccess,
		bool	ignorePlayers = `true`
	)

Definition at line 154 of file SCR_EditableVehicleComponent.c.

◆ GetFaction()

override Faction GetFaction ( )

Definition at line 39 of file SCR_EditableVehicleComponent.c.

◆ GetOnUIRefresh()

override ScriptInvoker GetOnUIRefresh ( )

Definition at line 52 of file SCR_EditableVehicleComponent.c.

◆ GetPlayerCountInVehicle()

int GetPlayerCountInVehicle ( )

Returns

Definition at line 19 of file SCR_EditableVehicleComponent.c.

◆ GetPlayerID()

override int GetPlayerID ( )

Definition at line 95 of file SCR_EditableVehicleComponent.c.

◆ HasEnoughBudgetForDefaultOccupants()

protected bool HasEnoughBudgetForDefaultOccupants	(	array< ECompartmentType >	compartmentTypes,
		int	playerID,
		EEditorMode	editorMode,
		out bool	noFreeDefaultCompartments
	)