SCR_EditableCharacterComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_EditableCharacterComponentClass

Functions
void	SetIsPlayerPending (int playerId)
bool	GetIsPlayerPending ()
AIAgent	GetAgent ()
ScriptInvoker	GetOnCharacterMovedInVehicle ()
ScriptInvokerEntity	GetOnDestroyed ()
SCR_EditableEntityComponent	CreateGroupForCharacter ()
bool	IsPlayer (IEntity owner=null)
bool	IsLocalPlayerOwner ()
bool	IsPlayerOrPossessed ()
void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
override bool	Delete (bool changedByUser=false, bool updateNavmesh=true)
void	OnFactionChanged ()
	Called by SCR_EditableGroupComponent when faction is changed.
override void	SetTransformOwner (vector transform[4])
void	PlayerTeleportedFeedback (bool isLongFade)
void	PlayerTeleportedByParentFeedback (bool isLongFade)
void	UpdateCompartment (IEntity newParent)
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 bool	SetTransform (vector transform[4], bool changedByUser=false)
void	GetOutVehicleOwner (RplId slotEntityID, vector transform[4])
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 void	OnPostInit (IEntity owner)
	Editable Mine.
void	~SCR_EditableCharacterComponent ()

Variables
SCR_EditableCharacterComponentClass	m_Agent
	Special configuration for editable character.
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.

Function Documentation

AddUsableVehicle()

void AddUsableVehicle ( IEntity vehicle )

protected

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

Parameters

vehicle

Definition at line 599 of file SCR_EditableCharacterComponent.c.

CreateGroupForCharacter()

SCR_EditableEntityComponent CreateGroupForCharacter ( )

protected

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 )

protected

Definition at line 195 of file SCR_EditableCharacterComponent.c.

EOnEditorPlace()

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

protected

Definition at line 732 of file SCR_EditableCharacterComponent.c.

EOnEditorSessionLoad()

override void EOnEditorSessionLoad ( SCR_EditableEntityComponent parent )

protected

Definition at line 762 of file SCR_EditableCharacterComponent.c.

ForceVehicleCompartments()

override void ForceVehicleCompartments ( notnull array< ECompartmentType > forceVehicleCompartments )

protected

Definition at line 331 of file SCR_EditableCharacterComponent.c.

GetAgent()

AIAgent GetAgent ( )

protected

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 ( )

protected

Definition at line 563 of file SCR_EditableCharacterComponent.c.

GetAIGroup()

override SCR_EditableEntityComponent GetAIGroup ( )

protected

Definition at line 557 of file SCR_EditableCharacterComponent.c.

GetCrew()

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

protected

Definition at line 579 of file SCR_EditableCharacterComponent.c.

GetFaction()

override Faction GetFaction ( )

protected

Definition at line 524 of file SCR_EditableCharacterComponent.c.

GetIsPlayerPending()

bool GetIsPlayerPending ( )

protected

Returns

Definition at line 51 of file SCR_EditableCharacterComponent.c.

GetMaxDrawDistanceSq()

override float GetMaxDrawDistanceSq ( )

protected

Definition at line 692 of file SCR_EditableCharacterComponent.c.

GetOnCharacterMovedInVehicle()

ScriptInvoker GetOnCharacterMovedInVehicle ( )

protected

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 ( )

protected

Get event called when character destroyed

Returns

Script invoker

Definition at line 77 of file SCR_EditableCharacterComponent.c.

GetOnUIRefresh()

override ScriptInvoker GetOnUIRefresh ( )

protected

Definition at line 551 of file SCR_EditableCharacterComponent.c.

GetOutVehicleOwner()

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

protected

Definition at line 503 of file SCR_EditableCharacterComponent.c.

GetPlayerID()

override int GetPlayerID ( )

protected

Definition at line 515 of file SCR_EditableCharacterComponent.c.

GetVehicle()

override SCR_EditableEntityComponent GetVehicle ( )

protected

Definition at line 569 of file SCR_EditableCharacterComponent.c.

IsLocalPlayerOwner()

bool IsLocalPlayerOwner ( )

protected

Definition at line 161 of file SCR_EditableCharacterComponent.c.

IsPlayer()

bool IsPlayer ( IEntity owner = null )

protected

Definition at line 146 of file SCR_EditableCharacterComponent.c.

IsPlayerOrPossessed()

bool IsPlayerOrPossessed ( )

protected

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 ( )

protected

Called by SCR_EditableGroupComponent when faction is changed.

Definition at line 225 of file SCR_EditableCharacterComponent.c.

OnLifeStateChanged()

void OnLifeStateChanged ( ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState )

protected

Definition at line 180 of file SCR_EditableCharacterComponent.c.

OnParentEntityChanged()

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

protected

Definition at line 345 of file SCR_EditableCharacterComponent.c.

OnPlayerCharacterEnterCompartment()

void OnPlayerCharacterEnterCompartment ( IEntity compartmentEntity )

protected

Parameters

[in]

compartmentEntity

Definition at line 719 of file SCR_EditableCharacterComponent.c.

OnPlayerCharacterExitCompartment()

void OnPlayerCharacterExitCompartment ( IEntity compartmentEntity )

protected

Parameters

[in]

compartmentEntity

Definition at line 726 of file SCR_EditableCharacterComponent.c.

PlayerTeleportedByParentFeedback()

void PlayerTeleportedByParentFeedback ( bool isLongFade )

protected

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 274 of file SCR_EditableCharacterComponent.c.

PlayerTeleportedFeedback()

void PlayerTeleportedFeedback ( bool isLongFade )

protected

Definition at line 251 of file SCR_EditableCharacterComponent.c.

RemoveUsableVehicle()

void RemoveUsableVehicle ( IEntity vehicle, bool checkIfVehicleStillUsed = true )

protected

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 624 of file SCR_EditableCharacterComponent.c.

SetIsPlayerPending()

void SetIsPlayerPending ( int playerId )

protected

Parameters

[in]

playerId

Definition at line 38 of file SCR_EditableCharacterComponent.c.

SetParentEntity()

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

protected

Definition at line 304 of file SCR_EditableCharacterComponent.c.

SetTransform()

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

protected

Definition at line 471 of file SCR_EditableCharacterComponent.c.

SetTransformOwner()

override void SetTransformOwner ( vector transform[4] )

protected

Definition at line 242 of file SCR_EditableCharacterComponent.c.

UpdateCompartment()

void UpdateCompartment ( IEntity newParent )

protected

Definition at line 282 of file SCR_EditableCharacterComponent.c.

WaitForCompartmentUpdate()

void WaitForCompartmentUpdate ( IEntity newParent )

protected

Definition at line 293 of file SCR_EditableCharacterComponent.c.

~SCR_EditableCharacterComponent()

void ~SCR_EditableCharacterComponent ( )

protected

Definition at line 844 of file SCR_EditableCharacterComponent.c.

Variable Documentation

Event_OnCharacterMovedInVehicle

ref ScriptInvoker Event_OnCharacterMovedInVehicle = new ScriptInvoker()

protected

Definition at line 24 of file SCR_EditableCharacterComponent.c.

m_aForceVehicleCompartments

ref array<ECompartmentType> m_aForceVehicleCompartments

protected

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

Definition at line 34 of file SCR_EditableCharacterComponent.c.

m_AgentControlComponent

AIControlComponent m_AgentControlComponent

protected

Definition at line 21 of file SCR_EditableCharacterComponent.c.

m_bIsPlayerPending

bool m_bIsPlayerPending

protected

Definition at line 29 of file SCR_EditableCharacterComponent.c.

m_bShouldRecalculateDrawDistance

bool m_bShouldRecalculateDrawDistance

protected

Definition at line 31 of file SCR_EditableCharacterComponent.c.

m_fPlayerDrawDistance

float m_fPlayerDrawDistance

protected

Definition at line 22 of file SCR_EditableCharacterComponent.c.

m_inDeadPlayerID

int m_inDeadPlayerID

protected

Definition at line 26 of file SCR_EditableCharacterComponent.c.

m_OnDestroyed

ref ScriptInvokerEntity m_OnDestroyed

protected

Definition at line 25 of file SCR_EditableCharacterComponent.c.

m_OnUIRefresh

ref ScriptInvoker m_OnUIRefresh = new ScriptInvoker()

protected

Definition at line 23 of file SCR_EditableCharacterComponent.c.