Inheritance diagram for SCR_EditableCharacterComponent:

[legend]

Public Member Functions
void	SetIsPlayerPending (int playerId)

bool	GetIsPlayerPending ()

AIAgent	GetAgent ()
	Get AI agent of the character.

ScriptInvoker	GetOnCharacterMovedInVehicle ()
	Get event called when character is moved in the vehicle by GM and systems Called only on server.

ScriptInvokerEntity	GetOnDestroyed ()
	Get event called when character destroyed.

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

bool	IsPlayerOrPossessed ()
	Check if character is Player or Possessed by a player.

override bool	Delete (bool changedByUser=false, bool updateNavmesh=true)
	Delete this editable entity.

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

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.

override SCR_EditableEntityComponent	SetParentEntity (SCR_EditableEntityComponent parentEntity, bool changedByUser=false)
	Set parent of the entity.

override void	ForceVehicleCompartments (notnull array< ECompartmentType > forceVehicleCompartments)
	Authority Only, forces entities such as Character and Group to place characters into a specific vehicle position.

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

override void	SetTransform (vector transform[4], bool changedByUser=false)
	Update entity's transformation and broadcast the changes to all clients.

override int	GetPlayerID ()
	Get player controlling this entity.

override Faction	GetFaction ()
	Get entity's faction.

override ScriptInvoker	GetOnUIRefresh ()
	Get event called when GUI should refresh entity's GUI, i.e., update faction color and call events in GUI widgets.

override SCR_EditableEntityComponent	GetAIGroup ()
	Get entity's AI group.

override SCR_EditableEntityComponent	GetAIEntity ()
	Get entity which represents this entity as AI.

override SCR_EditableEntityComponent	GetVehicle ()
	Get vehicle the entity's in.

override int	GetCrew (out notnull array< CompartmentAccessComponent > crewCompartmentAccess, bool ignorePlayers=true)
	Get crew of vehicle or if in a vehicle get self.

void	AddUsableVehicle (IEntity vehicle)
	Add useable vehicle to group which registers the vehicle to the group.

void	RemoveUsableVehicle (IEntity vehicle, bool checkIfVehicleStillUsed=true)
	Remove useable vehicle from group which unregisters the vehicle from the group.

override float	GetMaxDrawDistanceSq ()
	Get squared maximum distance in which this entity is drawn in editor (e.g., with an icon).

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)
	Event called on server when the entity is placed in the editor.

override void	EOnEditorSessionLoad (SCR_EditableEntityComponent parent)
	Event called on server when the session is being loaded by SCR_EditableEntityStruct.

override bool	Serialize (out SCR_EditableEntityComponent outTarget=null, out int outTargetIndex=-1, out EEditableEntitySaveFlag outSaveFlags=0)
	Check if the entity can be serialized during session saving managed by SCR_EditableEntityStruct.

override void	Deserialize (SCR_EditableEntityComponent target, int targetValue)
	Deserialise the entity based on given params.

override void	OnPostInit (IEntity owner)

void	~SCR_EditableCharacterComponent ()

Public Member Functions inherited from SCR_EditableEntityComponent
string	GetDisplayName ()
	Get entity name from info component.

ResourceName	GetPrefab (bool shorten=false)
	Get entity prefab.

SCR_EditableEntityComponentClass	GetEditableEntityData (IEntity owner=null)
	Get prefab data of this editable entity.

EEditableEntityType	GetEntityType (IEntity owner=null)
	Get entity type.

SCR_EditableEntityInteraction	GetEntityInteraction (IEntity owner=null)
	Get entity interaction rules of this entity.

SCR_UIInfo	GetInfo (IEntity owner=null)
	Get information about the entity.

ScriptInvokerEntity	GetOnDeleted ()
	Get event called when entity is deleted.

void	SetInfoInstance (SCR_UIInfo info)
	Set information about the entity on entity instance, locally on this machine.

bool	IsReplicated (out RplId replicationID=-1)
	Check component's replication.

bool	Serialize (out SCR_EditableEntityComponent outTarget=null, out int outTargetIndex=-1, out EEditableEntitySaveFlag outSaveFlags=0)
	Check if the entity can be serialized during session saving managed by SCR_EditableEntityStruct.

void	Deserialize (SCR_EditableEntityComponent target, int targetValue)
	Deserialise the entity based on given params.

GenericEntity	GetOwnerScripted ()

bool	GetPos (out vector pos)
	Get position representing the entity.

vector	GetIconPos ()
	Get icon offset.

bool	GetTransform (out vector outTransform[4])
	Get world transformation matrix of editable entity.

bool	GetLocalTransform (out vector outTransform[4])
	Get local transformation matrix of editable entity.

int	GetPlayerID ()
	Get player controlling this entity.

Faction	GetFaction ()
	Get entity's faction.

ScriptInvoker	GetOnUIRefresh ()
	Get event called when GUI should refresh entity's GUI, i.e., update faction color and call events in GUI widgets.

ScriptInvoker	GetOnUIReset ()
	Get event called when GUI should reset widgets that are used for entity visualization.

SCR_EditableEntityComponent	GetAIGroup ()
	Get entity's AI group.

SCR_EditableEntityComponent	GetAIEntity ()
	Get entity which represents this entity as AI.

SCR_EditableEntityComponent	GetVehicle ()
	Get vehicle the entity's in.

int	GetCrew (out notnull array< CompartmentAccessComponent > crewCompartmentAccess, bool ignorePlayers=true)
	Get crew of vehicle or if in a vehicle get self.

float	GetHealth ()
	Get entity health.

bool	CanDestroy ()

bool	IsDestroyed ()
	Check if the entity is destroyed.

void	SetStatic (bool isStatic)
	Set entity as static.

bool	GetStatic ()
	Check if the entity is marked as static.

void	UpdateStaticPos ()
	Update static cached position.

void	SetHierarchyAsDirtyInParents ()
	Mark hierarchy in all parents of the entity as dirty, i.e., modified by user.

void	SetHierarchyAsDirty ()
	Mark entity hierarchy as dirty, i.e., modified by user.

void	SetTransformWithChildren (vector transform[4])
	Update transformation of the entity and all its editor children and broadcast the changes to all clients.

void	SetTransform (vector transform[4], bool changedByUser=false)
	Update entity's transformation and broadcast the changes to all clients.

bool	Destroy ()
	Kill/destroy this editable entity.

bool	Delete (bool changedByUser=false, bool updateNavmesh=false)
	Delete this editable entity.

RplId	GetOwnerRplId ()

float	GetMaxDrawDistanceSq ()
	Get squared maximum distance in which this entity is drawn in editor (e.g., with an icon).

void	SetMaxDrawDistance (float maxDrawDistance)
	Set maximum distance in which this entity is drawn in editor (e.g., with an icon).

bool	GetEntityBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets, IEntity owner=null)
	Get entity budget costs.

bool	GetEntityChildrenBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets, IEntity owner=null)
	Get entity budget costs including cost of children (for groups/compositions)

bool	GetEntityAndChildrenBudgetCost (out notnull array< ref SCR_EntityBudgetValue > outBudgets, IEntity owner=null)
	Get budgets for both, entity and it's children.

bool	CanDuplicate (out notnull set< SCR_EditableEntityComponent > outRecipients)
	Can entity be duplicated by editor and which recipients should be passed to the duplicated entity Overridden by other EditableEntityComponents.

void	ForceVehicleCompartments (notnull array< ECompartmentType > forceVehicleCompartments)
	Authority Only, forces entities such as Character and Group to place characters into a specific vehicle position.

void	OnCreatedServer (notnull SCR_PlacingEditorComponent placedEditorComponent)

bool	HasEntityState (EEditableEntityState state)
	Check if given entity state is active.

EEditableEntityState	GetEntityStates ()
	Check bit array with all currently active states.

void	SetEntityState (EEditableEntityState state, bool toSet)
	Set value of an entity state.

void	ResetEntityStates ()
	Reset all entity states.

bool	HasEntityFlag (EEditableEntityFlag flag)
	Check if a flag is active.

EEditableEntityFlag	GetEntityFlags ()
	Get entity flags.

void	SetEntityFlag (EEditableEntityFlag flag, bool toSet)
	Set entity flag.

void	CopyEntityFlags (EEditableEntityFlag flags)
	Override the Entity flags.

string	GetLogText (string prefix="")

void	Log (string prefix="", bool onlyDirect=false, LogLevel logLevel=LogLevel.DEBUG)
	Print out entity information.

void	Log (string prefix, EEditableEntityAccessKey accessKey)
	Print out the entity and all its descendants which are compatible with given key.

void	LogAccessKey ()
	Print out entity's access key.

SCR_EditableEntityComponent	EOnEditorPlace (out SCR_EditableEntityComponent parent, SCR_EditableEntityComponent recipient, EEditorPlacingFlags flags, bool isQueue, int playerID=0)
	Event called on server when the entity is placed in the editor.

void	EOnEditorSessionLoad (SCR_EditableEntityComponent parent)
	Event called on server when the session is being loaded by SCR_EditableEntityStruct.

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

override void	OnDelete (IEntity owner)

override void	OnPostInit (IEntity owner)

void	SCR_EditableEntityComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

void	Attach (notnull SCR_EditableEntityComponent attachable)
	Add the received attachable waypoint to the attached entities (runs on parent)

void	Detach (notnull SCR_EditableEntityComponent attachable)
	Removes the received attachable waypoint from the attached entities (runs on parent)

set< SCR_EditableEntityComponent >	GetAttachedEntities ()
	Returns attached entities of self.

bool	IsAttachable ()
	Returns if current entity is attachable.

bool	IsAttached ()
	Returns if current entity is attached.

SCR_EditableEntityComponent	GetAttachedTo ()
	Returns current entity which this editable task is attached to.

bool	CanSetParent (SCR_EditableEntityComponent parentEntity)
	Check if the entity can be moved to intended parent.

void	RestoreParentEntity ()
	Add the entity to its previous parent after it was unregistered using RemoveParentEntity() Allowed only on server.

void	RemoveParentEntity ()
	Remove entity from its parent.

SCR_EditableEntityComponent	GetParentEntity ()
	Get parent entity.

void	GetParentEntities (out notnull array< SCR_EditableEntityComponent > entities)
	Get hierarchy of all parent entities, all the way to the root.

bool	IsChildOf (SCR_EditableEntityComponent entity)
	Check if the entity is in hierarchy of given entity.

set< SCR_EditableEntityComponent >	GetChildrenRef ()
	Get direct reference to entity's immediate children.

void	GetChildren (out notnull set< SCR_EditableEntityComponent > entities, bool onlyDirect=false, bool skipIgnored=false)
	Get child entities.

void	GetChildren (out notnull set< SCR_EditableEntityComponent > entities, bool onlyDirect, EEditableEntityAccessKey accessKey)
	Get child entities with compatible key.

int	GetChildrenCount (bool onlyDirect=false)
	Get number of child entities.

SCR_EditableEntityComponent	GetChild (int index)
	Get child on given index.

bool	IsLayer ()
	Check if the entity is also a layer, i.e., has some child entities.

bool	CanEnterLayer (SCR_LayersEditorComponent layersManager=null, bool toExtreme=false)
	Checks if can enter layer.

bool	IsRegistered ()
	Check if the entity is registered.

void	SetVisible (bool show)
	Set entity visibility.

void	EnableVisibilityReplication (bool enable)

bool	CanReplicateVisibility ()

void	OnRplVisibilityChanged ()

bool	GetVisibleSelf ()
	Check visibility setting of the entity.

bool	GetVisibleInHierarchy ()
	Check visibility setting of the entity in hierarchy (e.g., if an entity is set as visible, but its parent is not, false will be returned).

void	AddAccessKey (EEditableEntityAccessKey accessKey)
	Add access key.

void	RemoveAccessKey (EEditableEntityAccessKey accessKey)
	Remove access key.

void	ClearAccessKeys ()
	Clear all access keys.

EEditableEntityAccessKey	GetAccessKey ()
	Get entity's access key.

bool	HasAccessSelf (EEditableEntityAccessKey accessKey)
	Check access key of the entity.

bool	HasAccessInHierarchy (EEditableEntityAccessKey accessKey)
	Check acces keys of the entity in hierarchy (e.g., if an entity is compatible, but its parent is not, false will be returned).

bool	HasAccessSelf ()
	Check access key of the entity compared to those defined in SCR_AccessKeysEditorComponent.

bool	HasAccessInHierarchy ()
	Check access key of the entity in hierarchy (e.g., if an entity is compatible, but its parent is not, false will be returned).

Protected Member Functions
bool	IsPlayer (IEntity owner=null)

bool	IsLocalPlayerOwner ()

void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)

override void	SetTransformOwner (vector transform[4])

void	PlayerTeleportedFeedback (bool isLongFade)

void	UpdateCompartment (IEntity newParent)

void	WaitForCompartmentUpdate (IEntity newParent)

void	GetOutVehicleOwner (RplId slotEntityID, vector transform[4])

Protected Member Functions inherited from SCR_EditableEntityComponent
bool	IsServer ()

bool	CanRpc ()

void	SetTransformOwner (vector transform[4])

void	SetTransformBroadcast (vector transform[4])

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

void	SetParentEntityBroadcast (SCR_EditableEntityComponent parentEntity, SCR_EditableEntityComponent parentEntityPrev, bool changedByUser=false, bool isAutoRegistration=false)

void	SetParentEntityBroadcastReceive (RplId parentEntityID, RplId parentEntityPrevID, bool changedByUser)

void	OnRegistrationChanged (bool toRegister)

EEditableEntityRegister	GetAutoRegister ()

void	Register ()

void	Unregister (IEntity owner=null)

void	AddToParent (SCR_EditableEntityComponent parentEntity, bool changedByUser)

void	RemoveFromParent (SCR_EditableEntityComponent parentEntity, bool changedByUser)

void	AddChild (SCR_EditableEntityComponent entity)

void	RemoveChild (SCR_EditableEntityComponent entity)

void	UpdateGameHierarchy (IEntity parent, IEntity child, bool toAdd)

void	OnChildEntityChanged (SCR_EditableEntityComponent child, bool isAdded)

void	SetEntityStateInChildren (IEntity owner, EEditableEntityState state, bool toSet, out array< Managed > components=null)

void	OnVisibilityChanged ()

void	OnAccessKeyChanged (EEditableEntityAccessKey accessKey)

void	Refresh ()

RplComponent	GetRplComponent ()

bool	ValidateType ()

Protected Attributes
AIAgent	m_Agent

AIControlComponent	m_AgentControlComponent

float	m_fPlayerDrawDistance

ref ScriptInvoker	m_OnUIRefresh = new ScriptInvoker()

ref ScriptInvoker	Event_OnCharacterMovedInVehicle = new ScriptInvoker()

ref ScriptInvokerEntity	m_OnDestroyed

int	m_inDeadPlayerID

bool	m_bIsPlayerPending

bool	m_bShouldRecalculateDrawDistance

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

Protected Attributes inherited from SCR_EditableEntityComponent
EEditableEntityRegister	m_bAutoRegister

vector	m_vIconPos

bool	m_bEnabledVisibilityReplication

bool	m_bVisible

bool	m_bStatic

float	m_fMaxDrawDistance

EEditableEntityAccessKey	m_AccessKey

EEditableEntityFlag	m_Flags

SCR_EditableEntityComponent	m_ParentEntity

GenericEntity	m_Owner

EEditableEntityState	m_EntityState

SCR_UIInfo	m_UIInfoInstance

ref set< SCR_EditableEntityComponent >	m_Entities

vector	m_vStaticPos

int	m_iIconBoneIndex = -1

ref ScriptInvokerEntity	m_OnDeleted

ref set< SCR_EditableEntityComponent >	m_aAttachedEntities

Additional Inherited Members
Static Public Member Functions inherited from SCR_EditableEntityComponent
static SCR_EditableEntityComponent	GetEditableEntity (IEntity owner)
	Get editable entity component on given entity.

Detailed Description

Special configuration for editable character.

Constructor & Destructor Documentation

◆ ~SCR_EditableCharacterComponent()

void SCR_EditableCharacterComponent.~SCR_EditableCharacterComponent ( )

Member Function Documentation

◆ AddUsableVehicle()

void SCR_EditableCharacterComponent.AddUsableVehicle ( IEntity vehicle )

Add useable vehicle to group which registers the vehicle to the group.

Call on server.

Parameters

vehicle

◆ CreateGroupForCharacter()

SCR_EditableEntityComponent SCR_EditableCharacterComponent.CreateGroupForCharacter ( )

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

Returns: the created group

◆ Delete()

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

Delete this editable entity.

Parameters

[in]	changedByUser	True when the change was initiated by user
[in]	updateNavmesh	True to update navmesh after the entity is deleted (set to false when deleting children of already deleted entity)

Returns: true if deleted

Implements SCR_EditableEntityComponent.

◆ Deserialize()

override void SCR_EditableCharacterComponent.Deserialize	(	SCR_EditableEntityComponent	target,
		int	targetValue
	)

Deserialise the entity based on given params.

Parameters

[in]	target	Entity to which this entity is attached to outside of hierarchy structure, e.g., character in a vehicle or waypoint on a target
[in]	targetIndex	Further specification of the target, e.g., crew position index in a vehicle

Implements SCR_EditableEntityComponent.

◆ EOnEditorPlace()

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

Event called on server when the entity is placed in the editor.

Parameters

[out]	parent	Editable entity in which the new one is being created (rewrite the variable the change the parent)
[in]	recipient	Entity that receives this editable entity (e.g., a group receiving a waypoint)
[in]	flags	Placing flags enabled by user
[in]	isQueue	true if the entity was placed in a queue (i.e., placing remains active)
[in]	playerID	ID of the player placing the entity.

Returns: Editable entity which is added to editor hieraechy (can be overloaded, e.g., to provide group after spawning a character)

Implements SCR_EditableEntityComponent.

◆ EOnEditorSessionLoad()

override void SCR_EditableCharacterComponent.EOnEditorSessionLoad ( SCR_EditableEntityComponent parent )

Event called on server when the session is being loaded by SCR_EditableEntityStruct.

Parameters

[in] parent Editable entity in which the new one is being created

Implements SCR_EditableEntityComponent.

◆ ForceVehicleCompartments()

override void SCR_EditableCharacterComponent.ForceVehicleCompartments ( notnull array< ECompartmentType > forceVehicleCompartments )

Authority Only, forces entities such as Character and Group to place characters into a specific vehicle position.

Parameters

[in] forceVehicleCompartments compartment types to force for entity

Implements SCR_EditableEntityComponent.

◆ GetAgent()

AIAgent SCR_EditableCharacterComponent.GetAgent ( )

Get AI agent of the character.

Returns: AI agent on server, null on clients

◆ GetAIEntity()

override SCR_EditableEntityComponent SCR_EditableCharacterComponent.GetAIEntity ( )

Get entity which represents this entity as AI.

Returns: Editable entity

Implements SCR_EditableEntityComponent.

◆ GetAIGroup()

override SCR_EditableEntityComponent SCR_EditableCharacterComponent.GetAIGroup ( )

Get entity's AI group.

Returns: Editable entity of the group

Implements SCR_EditableEntityComponent.

◆ GetCrew()

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

Get crew of vehicle or if in a vehicle get self.

Parameters

[out]	crewCompartmentAccess	an array of CompartmentAccessComponent of all crew memebers
[in]	ignorePlayers	will never return player CompartmentAccessComponent if true

Returns: count of crew members

Implements SCR_EditableEntityComponent.

◆ GetFaction()

override Faction SCR_EditableCharacterComponent.GetFaction ( )

Get entity's faction.

Returns: Faction

Implements SCR_EditableEntityComponent.

◆ GetIsPlayerPending()

bool SCR_EditableCharacterComponent.GetIsPlayerPending ( )

Returns

◆ GetMaxDrawDistanceSq()

override float SCR_EditableCharacterComponent.GetMaxDrawDistanceSq ( )

Get squared maximum distance in which this entity is drawn in editor (e.g., with an icon).

Returns: Squared distance in metres

Implements SCR_EditableEntityComponent.

◆ GetOnCharacterMovedInVehicle()

ScriptInvoker SCR_EditableCharacterComponent.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

◆ GetOnDestroyed()

ScriptInvokerEntity SCR_EditableCharacterComponent.GetOnDestroyed ( )

Get event called when character destroyed.

Returns: Script invoker

◆ GetOnUIRefresh()

override ScriptInvoker SCR_EditableCharacterComponent.GetOnUIRefresh ( )

Get event called when GUI should refresh entity's GUI, i.e., update faction color and call events in GUI widgets.

To be overridden by inherited classes.

Returns: Script invoker

Implements SCR_EditableEntityComponent.

◆ GetOutVehicleOwner()

void SCR_EditableCharacterComponent.GetOutVehicleOwner	(	RplId	slotEntityID,
		vector	transform[4]
	)

protected

◆ GetPlayerID()

override int SCR_EditableCharacterComponent.GetPlayerID ( )

Get player controlling this entity.

Returns: Player ID

Implements SCR_EditableEntityComponent.

◆ GetVehicle()

override SCR_EditableEntityComponent SCR_EditableCharacterComponent.GetVehicle ( )

Get vehicle the entity's in.

Returns: Editable entity of the vehicle

Implements SCR_EditableEntityComponent.

◆ IsLocalPlayerOwner()

bool SCR_EditableCharacterComponent.IsLocalPlayerOwner ( )

protected

◆ IsPlayer()

bool SCR_EditableCharacterComponent.IsPlayer ( IEntity owner = null )

protected

◆ IsPlayerOrPossessed()

bool SCR_EditableCharacterComponent.IsPlayerOrPossessed ( )

Check if character is Player or Possessed by a player.

Returns: true if controlled by player

◆ OnFactionChanged()

void SCR_EditableCharacterComponent.OnFactionChanged ( )

Called by SCR_EditableGroupComponent when faction is changed.

◆ OnLifeStateChanged()

void SCR_EditableCharacterComponent.OnLifeStateChanged	(	ECharacterLifeState	previousLifeState,
		ECharacterLifeState	newLifeState
	)

protected

◆ OnParentEntityChanged()

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

Implements SCR_EditableEntityComponent.

◆ OnPlayerCharacterEnterCompartment()

void SCR_EditableCharacterComponent.OnPlayerCharacterEnterCompartment ( IEntity compartmentEntity )

Parameters

[in] compartmentEntity

◆ OnPlayerCharacterExitCompartment()

void SCR_EditableCharacterComponent.OnPlayerCharacterExitCompartment ( IEntity compartmentEntity )

Parameters

[in] compartmentEntity

◆ OnPostInit()

override void SCR_EditableCharacterComponent.OnPostInit ( IEntity owner )

Implements SCR_EditableEntityComponent.

◆ PlayerTeleportedByParentFeedback()

void SCR_EditableCharacterComponent.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

◆ PlayerTeleportedFeedback()

void SCR_EditableCharacterComponent.PlayerTeleportedFeedback ( bool isLongFade )

protected

◆ RemoveUsableVehicle()

void SCR_EditableCharacterComponent.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

◆ Serialize()

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

Check if the entity can be serialized during session saving managed by SCR_EditableEntityStruct.

Parameters

[out]	target	Entity to which this entity is attached to outside of hierarchy structure, e.g., character in a vehicle or waypoint on a target
[out]	targetIndex	Further specification of the target, e.g., crew position index in a vehicle
[out]	isDestroyed	Variable to be set to true if the entity is destroyed

Returns: true if it can be serialized

Implements SCR_EditableEntityComponent.

◆ SetIsPlayerPending()

void SCR_EditableCharacterComponent.SetIsPlayerPending ( int playerId )

Parameters

[in] playerId

◆ SetParentEntity()

override SCR_EditableEntityComponent SCR_EditableCharacterComponent.SetParentEntity	(	SCR_EditableEntityComponent	parentEntity,
		bool	changedByUser = `false`
	)

Set parent of the entity.

When placed inside a parent, the entity will inherit some of its settings, like access key or visibility settings. Changing it is allowed only on server.

Parameters

[in]	parentEntity	New parent. When null, the entity will be moved to the root.
[in]	changedByUser	True when the change was initiated by user

Returns: New parent (in case it changes inside)

Implements SCR_EditableEntityComponent.

◆ SetTransform()

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

Update entity's transformation and broadcast the changes to all clients.

Parameters

[in]	transform	Target transformation
[in]	changedByUser	True when the change was initiated by user

Implements SCR_EditableEntityComponent.

◆ SetTransformOwner()

override void SCR_EditableCharacterComponent.SetTransformOwner ( vector transform[4] )

protected

Implements SCR_EditableEntityComponent.

◆ UpdateCompartment()

void SCR_EditableCharacterComponent.UpdateCompartment ( IEntity newParent )

protected

◆ WaitForCompartmentUpdate()

void SCR_EditableCharacterComponent.WaitForCompartmentUpdate ( IEntity newParent )

protected

Member Data Documentation

◆ Event_OnCharacterMovedInVehicle

ref ScriptInvoker SCR_EditableCharacterComponent.Event_OnCharacterMovedInVehicle = new ScriptInvoker()

protected

◆ m_aForceVehicleCompartments

ref array<ECompartmentType> SCR_EditableCharacterComponent.m_aForceVehicleCompartments

protected

Authority only, Allows character to be forced into a specific vehicle position and will delete it if failed.

◆ m_Agent

AIAgent SCR_EditableCharacterComponent.m_Agent

protected

◆ m_AgentControlComponent

AIControlComponent SCR_EditableCharacterComponent.m_AgentControlComponent

protected

◆ m_bIsPlayerPending

bool SCR_EditableCharacterComponent.m_bIsPlayerPending

protected

◆ m_bShouldRecalculateDrawDistance

bool SCR_EditableCharacterComponent.m_bShouldRecalculateDrawDistance

protected

◆ m_fPlayerDrawDistance

float SCR_EditableCharacterComponent.m_fPlayerDrawDistance

protected

◆ m_inDeadPlayerID

int SCR_EditableCharacterComponent.m_inDeadPlayerID

protected

◆ m_OnDestroyed

ref ScriptInvokerEntity SCR_EditableCharacterComponent.m_OnDestroyed

protected

◆ m_OnUIRefresh

ref ScriptInvoker SCR_EditableCharacterComponent.m_OnUIRefresh = new ScriptInvoker()

protected

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

Game/Editor/Components/EditableEntity/SCR_EditableCharacterComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~SCR_EditableCharacterComponent()

Member Function Documentation

◆ AddUsableVehicle()

◆ CreateGroupForCharacter()

◆ Delete()

◆ Deserialize()

◆ EOnEditorPlace()

◆ EOnEditorSessionLoad()

◆ ForceVehicleCompartments()

◆ GetAgent()

◆ GetAIEntity()

◆ GetAIGroup()

◆ GetCrew()

◆ GetFaction()

◆ GetIsPlayerPending()

◆ GetMaxDrawDistanceSq()

◆ GetOnCharacterMovedInVehicle()

◆ GetOnDestroyed()

◆ GetOnUIRefresh()

◆ GetOutVehicleOwner()

◆ GetPlayerID()

◆ GetVehicle()

◆ IsLocalPlayerOwner()

◆ IsPlayer()

◆ IsPlayerOrPossessed()

◆ OnFactionChanged()

◆ OnLifeStateChanged()

◆ OnParentEntityChanged()

◆ OnPlayerCharacterEnterCompartment()

◆ OnPlayerCharacterExitCompartment()

◆ OnPostInit()

◆ PlayerTeleportedByParentFeedback()

◆ PlayerTeleportedFeedback()

◆ RemoveUsableVehicle()

◆ Serialize()

◆ SetIsPlayerPending()

◆ SetParentEntity()

◆ SetTransform()

◆ SetTransformOwner()

◆ UpdateCompartment()

◆ WaitForCompartmentUpdate()

Member Data Documentation

◆ Event_OnCharacterMovedInVehicle

◆ m_aForceVehicleCompartments

◆ m_Agent

◆ m_AgentControlComponent

◆ m_bIsPlayerPending

◆ m_bShouldRecalculateDrawDistance

◆ m_fPlayerDrawDistance

◆ m_inDeadPlayerID

◆ m_OnDestroyed

◆ m_OnUIRefresh