Data Structures
class	SCR_EditableCharacterComponentClass

Functions
void	SetIsPlayerPending (int playerId)

bool	GetIsPlayerPending ()

AIAgent	GetAgent ()

ScriptInvoker	GetOnCharacterMovedInVehicle ()

ScriptInvokerEntity	GetOnDestroyed ()

SCR_EditableEntityComponent	CreateGroupForCharacter ()

protected bool	IsPlayer (IEntity owner=null)

protected bool	IsLocalPlayerOwner ()

bool	IsPlayerOrPossessed ()

protected void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
	Will be called when the life state of the character changes. More...

override bool	Delete (bool changedByUser=false, bool updateNavmesh=true)

void	OnFactionChanged ()
	Called by SCR_EditableGroupComponent when faction is changed. More...

protected override void	SetTransformOwner (vector transform[4])

protected void	PlayerTeleportedFeedback (bool isLongFade)

void	PlayerTeleportedByParentFeedback (bool isLongFade)

protected void	UpdateCompartment (IEntity newParent)

protected void	WaitForCompartmentUpdate (IEntity newParent)

override SCR_EditableEntityComponent	SetParentEntity (SCR_EditableEntityComponent parentEntity, bool changedByUser=false)

override void	ForceVehicleCompartments (notnull array< ECompartmentType > forceVehicleCompartments)

override void	OnParentEntityChanged (SCR_EditableEntityComponent parentEntity, SCR_EditableEntityComponent parentEntityPrev, bool changedByUser)

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

override int	GetPlayerID ()

override Faction	GetFaction ()

override ScriptInvoker	GetOnUIRefresh ()

override SCR_EditableEntityComponent	GetAIGroup ()

override SCR_EditableEntityComponent	GetAIEntity ()

override SCR_EditableEntityComponent	GetVehicle ()

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

void	AddUsableVehicle (IEntity vehicle)

void	RemoveUsableVehicle (IEntity vehicle, bool checkIfVehicleStillUsed=true)

override float	GetMaxDrawDistanceSq ()

void	OnPlayerCharacterEnterCompartment (IEntity compartmentEntity)

void	OnPlayerCharacterExitCompartment (IEntity compartmentEntity)

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

override void	EOnEditorSessionLoad (SCR_EditableEntityComponent parent)

override bool	Serialize (out SCR_EditableEntityComponent outTarget=null, out int outTargetIndex=-1, out EEditableEntitySaveFlag outSaveFlags=0)

override void	Deserialize (SCR_EditableEntityComponent target, int targetValue)

override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...

void	~SCR_EditableCharacterComponent ()

Variables
SCR_EditableCharacterComponentClass	m_Agent
	Special configuration for editable character. More...

protected AIControlComponent	m_AgentControlComponent

protected float	m_fPlayerDrawDistance

protected ref ScriptInvoker	m_OnUIRefresh = new ScriptInvoker()

protected ref ScriptInvoker	Event_OnCharacterMovedInVehicle = new ScriptInvoker()

protected ref ScriptInvokerEntity	m_OnDestroyed

protected int	m_inDeadPlayerID

protected bool	m_bIsPlayerPending

protected bool	m_bShouldRecalculateDrawDistance

protected ref array< ECompartmentType >	m_aForceVehicleCompartments
	Authority only, Allows character to be forced into a specific vehicle position and will delete it if failed. More...

Function Documentation

◆ AddUsableVehicle()

void AddUsableVehicle ( IEntity vehicle )

Add useable vehicle to group which registers the vehicle to the group. Call on server.

Parameters

vehicle

Definition at line 568 of file SCR_EditableCharacterComponent.c.

◆ CreateGroupForCharacter()

SCR_EditableEntityComponent CreateGroupForCharacter ( )

Create a new group and add the character to the group (Server only)

Returns: the created group

Definition at line 88 of file SCR_EditableCharacterComponent.c.

◆ Delete()

override bool Delete	(	bool	changedByUser = `false`,
		bool	updateNavmesh = `true`
	)

Definition at line 195 of file SCR_EditableCharacterComponent.c.

◆ Deserialize()

override void Deserialize	(	SCR_EditableEntityComponent	target,
		int	targetValue
	)

Definition at line 758 of file SCR_EditableCharacterComponent.c.

◆ EOnEditorPlace()

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

Definition at line 698 of file SCR_EditableCharacterComponent.c.

◆ EOnEditorSessionLoad()

override void EOnEditorSessionLoad ( SCR_EditableEntityComponent parent )

Definition at line 728 of file SCR_EditableCharacterComponent.c.

◆ ForceVehicleCompartments()

override void ForceVehicleCompartments ( notnull array< ECompartmentType > forceVehicleCompartments )

Definition at line 316 of file SCR_EditableCharacterComponent.c.

◆ GetAgent()

AIAgent GetAgent ( )

Get AI agent of the character.

Returns: AI agent on server, null on clients

Definition at line 59 of file SCR_EditableCharacterComponent.c.

◆ GetAIEntity()

override SCR_EditableEntityComponent GetAIEntity ( )

Definition at line 532 of file SCR_EditableCharacterComponent.c.

◆ GetAIGroup()

override SCR_EditableEntityComponent GetAIGroup ( )

Definition at line 526 of file SCR_EditableCharacterComponent.c.

◆ GetCrew()

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

Definition at line 548 of file SCR_EditableCharacterComponent.c.

◆ GetFaction()

override Faction GetFaction ( )

Definition at line 493 of file SCR_EditableCharacterComponent.c.

◆ GetIsPlayerPending()

bool GetIsPlayerPending ( )

Returns

Definition at line 51 of file SCR_EditableCharacterComponent.c.

◆ GetMaxDrawDistanceSq()

override float GetMaxDrawDistanceSq ( )

Definition at line 658 of file SCR_EditableCharacterComponent.c.

◆ GetOnCharacterMovedInVehicle()

ScriptInvoker GetOnCharacterMovedInVehicle ( )

Get event called when character is moved in the vehicle by GM and systems Called only on server. Invoker params are: this character, IEntity vehicle. This is null if moving in vehicle failed

Returns: Script invoker

Definition at line 69 of file SCR_EditableCharacterComponent.c.

◆ GetOnDestroyed()

ScriptInvokerEntity GetOnDestroyed ( )

Get event called when character destroyed

Returns: Script invoker

Definition at line 77 of file SCR_EditableCharacterComponent.c.

◆ GetOnUIRefresh()

override ScriptInvoker GetOnUIRefresh ( )

Definition at line 520 of file SCR_EditableCharacterComponent.c.

◆ GetPlayerID()

override int GetPlayerID ( )

Definition at line 484 of file SCR_EditableCharacterComponent.c.

◆ GetVehicle()

override SCR_EditableEntityComponent GetVehicle ( )

Definition at line 538 of file SCR_EditableCharacterComponent.c.

◆ IsLocalPlayerOwner()

protected bool IsLocalPlayerOwner ( )

Definition at line 161 of file SCR_EditableCharacterComponent.c.

◆ IsPlayer()

protected bool IsPlayer ( IEntity owner = null )

Definition at line 146 of file SCR_EditableCharacterComponent.c.

◆ IsPlayerOrPossessed()

bool IsPlayerOrPossessed ( )

Check if character is Player or Possessed by a player

Returns: true if controlled by player

Definition at line 174 of file SCR_EditableCharacterComponent.c.

◆ OnFactionChanged()

void OnFactionChanged ( )

Called by SCR_EditableGroupComponent when faction is changed.

Definition at line 210 of file SCR_EditableCharacterComponent.c.

◆ OnParentEntityChanged()

override void OnParentEntityChanged	(	SCR_EditableEntityComponent	parentEntity,
		SCR_EditableEntityComponent	parentEntityPrev,
		bool	changedByUser
	)

Definition at line 330 of file SCR_EditableCharacterComponent.c.

◆ OnPlayerCharacterEnterCompartment()

void OnPlayerCharacterEnterCompartment ( IEntity compartmentEntity )

Parameters

[in] compartmentEntity

Definition at line 685 of file SCR_EditableCharacterComponent.c.

◆ OnPlayerCharacterExitCompartment()

void OnPlayerCharacterExitCompartment ( IEntity compartmentEntity )

Parameters

[in] compartmentEntity

Definition at line 692 of file SCR_EditableCharacterComponent.c.

◆ PlayerTeleportedByParentFeedback()

void PlayerTeleportedByParentFeedback ( bool isLongFade )

Called when character was moved by Parent (aka when in vehicle) Checks if player controlled and if Owned by local player. If true shows feedback

Definition at line 259 of file SCR_EditableCharacterComponent.c.

◆ PlayerTeleportedFeedback()

protected void PlayerTeleportedFeedback ( bool isLongFade )

Definition at line 236 of file SCR_EditableCharacterComponent.c.

◆ RemoveUsableVehicle()

void RemoveUsableVehicle	(	IEntity	vehicle,
		bool	checkIfVehicleStillUsed = `true`
	)

Remove useable vehicle from group which unregisters the vehicle from the group. Call on server. NOTE: If All characters of a group are told to exit the vehicle at the same time and checkIfVehicleStillUsed is true, then the function will think the vehicle is still in use by the group!

Parameters

vehicle	IEntity vehicle
checkIfVehicleStillUsed

Definition at line 593 of file SCR_EditableCharacterComponent.c.

◆ Serialize()

override bool Serialize	(	out SCR_EditableEntityComponent	outTarget = `null`,
		out int	outTargetIndex = `-1`,
		out EEditableEntitySaveFlag	outSaveFlags = `0`
	)