Inheritance diagram for SCR_EditableWaypointComponent:

[legend]

Public Member Functions
override SCR_EditableEntityComponent	GetAttachedTo ()
	Returns current entity which this editable task is attached to.

void	SetWaypointIndex (int index, bool isCurrent, SCR_EditableEntityComponent prevWaypoint)
	Assign order index of the waypoint and whether it's current or not.

int	GetWaypointIndex ()
	Get order index of the waypoint.

bool	IsCurrent ()
	Check if the waypoint is group's current waypoint.

SCR_EditableEntityComponent	GetPrevWaypoint ()
	Get previous waypoint.

override 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.

override Faction	GetFaction ()
	Get entity's faction.

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

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 void	SetTransformBroadcast (vector transform[4])

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

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

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	OnDelete (IEntity owner)

override bool	IsAttachable ()
	Returns if current entity is attachable.

override bool	IsAttached ()
	Returns if current entity is attached.

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

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.

void	SetAuthor (int playerID)
	Sets AuthorID (player that modified this entity last) in Session.

void	SetAuthor (SCR_EditableEntityAuthor author)
	Sets AuthorID (player that modified this entity last) from a Save.

SCR_EditableEntityAuthor	GetAuthor ()

string	GetAuthorUID ()
	Returns author UID.

string	GetAuthorPlatformID ()
	Returns author Platform ID.

int	GetAuthorPlayerID ()
	Returns author Player ID.

int	GetAuthorLastUpdated ()
	Returns Unix Time of last modification.

PlatformKind	GetAuthorPlatform ()
	Returns Unix Time of last modification.

void	SetAuthorUID (string authorUID)
	Set Author UID (for normal usage use SetAuthor())

void	SetAuthorPlatformID (string authorPlatformID)

void	SetAuthorUpdatedTime (int updatedLast)
	Set Time of last update.

void	SetAuthorPlatform (PlatformKind authorPlatform)

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.

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

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
void	AttachTo (SCR_EditableEntityComponent attachedTo)
	Attaches an entity to this waypoint task.

void	OnAttachedToId ()
	Runs when an ID is attached.

void	OnPreWaypointIdRpl ()

void	DetachFromTarget ()
	Detach the waypoint from the target, runs both in client and server.

Protected Member Functions inherited from SCR_EditableEntityComponent
bool	IsServer ()

bool	CanRpc ()

void	SetTransformOwner (vector transform[4])

void	SetTransformBroadcast (vector transform[4])

void	OnAuthorChangedServer (string authorUID, int authorID, string authorPlatformID, int platform, int lastUpdated)

void	OnAuthorChangedSaveServer (string authorUID, int authorID, string authorPlatformID, int platform, int lastUpdated)

void	OnAuthorChanged (string authorUID, int authorID, string authorPlatformID, int platform, int lastUpdated)

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
RplId	m_PrevWaypointId

bool	m_bIsCurrent

int	m_iIndex

SCR_EditableEntityComponent	m_Group

SCR_EditableEntityComponent	m_PrevWaypoint

SCR_AIWaypoint	m_AttachableWaypoint

SCR_EditableEntityComponent	m_AttachedTo

RplId	m_AttachedToId

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 SCR_EditableEntityAuthor	m_Author

int	m_iAuthorLastUpdated

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 waypoint.

Constructor & Destructor Documentation

◆ SCR_EditableWaypointComponent()

void SCR_EditableWaypointComponent.SCR_EditableWaypointComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Member Function Documentation

◆ AttachTo()

void SCR_EditableWaypointComponent.AttachTo ( SCR_EditableEntityComponent attachedTo )

protected

Attaches an entity to this waypoint task.

Parameters

[in] attachedTo to which component attach this waypoint - can be null to detach it

◆ CanDuplicate()

override bool SCR_EditableWaypointComponent.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.

Parameters

[out] outRecipients editableEntityComponents that will be passed to the duplicated entity (Groupcomponent / FactionComponent)

Returns: true if entity can be duplicated

Implements SCR_EditableEntityComponent.

◆ CanSetParent()

override bool SCR_EditableWaypointComponent.CanSetParent ( SCR_EditableEntityComponent parentEntity )

Check if the entity can be moved to intended parent.

Parameters

[in] parentEntity New parent. Null when evaluating root.

Returns

Implements SCR_EditableEntityComponent.

◆ DetachFromTarget()

void SCR_EditableWaypointComponent.DetachFromTarget ( )

protected

Detach the waypoint from the target, runs both in client and server.

◆ EOnEditorPlace()

override SCR_EditableEntityComponent SCR_EditableWaypointComponent.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.

◆ GetAIGroup()

override SCR_EditableEntityComponent SCR_EditableWaypointComponent.GetAIGroup ( )

Get entity's AI group.

Returns: Editable entity of the group

Implements SCR_EditableEntityComponent.

◆ GetAttachedTo()

override SCR_EditableEntityComponent SCR_EditableWaypointComponent.GetAttachedTo ( )

Returns current entity which this editable task is attached to.

Returns: current entity which this editable task is attached to

Implements SCR_EditableEntityComponent.

◆ GetFaction()

override Faction SCR_EditableWaypointComponent.GetFaction ( )

Get entity's faction.

Returns: Faction

Implements SCR_EditableEntityComponent.

◆ GetPos()

override bool SCR_EditableWaypointComponent.GetPos ( out vector pos )

Get position representing the entity.

Parameters

[out] pos Entity's position

Returns: true if the entity has a position

Implements SCR_EditableEntityComponent.

◆ GetPrevWaypoint()

SCR_EditableEntityComponent SCR_EditableWaypointComponent.GetPrevWaypoint ( )

Get previous waypoint.

Returns: Waypoint or group (when there is no previous waypoint)

◆ GetWaypointIndex()

int SCR_EditableWaypointComponent.GetWaypointIndex ( )

Get order index of the waypoint.

Returns: Index starting with 0

◆ IsAttachable()

override bool SCR_EditableWaypointComponent.IsAttachable ( )

Returns if current entity is attachable.

Returns: bool

Implements SCR_EditableEntityComponent.

◆ IsAttached()

override bool SCR_EditableWaypointComponent.IsAttached ( )

Returns if current entity is attached.

Returns: bool

Implements SCR_EditableEntityComponent.

◆ IsCurrent()

bool SCR_EditableWaypointComponent.IsCurrent ( )

Check if the waypoint is group's current waypoint.

Returns: True when current

◆ OnAttachedToId()

void SCR_EditableWaypointComponent.OnAttachedToId ( )

protected

Runs when an ID is attached.

◆ OnDelete()

override void SCR_EditableWaypointComponent.OnDelete ( IEntity owner )

Implements SCR_EditableEntityComponent.

◆ OnParentEntityChanged()

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

Implements SCR_EditableEntityComponent.

◆ OnPreWaypointIdRpl()

void SCR_EditableWaypointComponent.OnPreWaypointIdRpl ( )

protected

◆ SetTransform()

override void SCR_EditableWaypointComponent.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.

◆ SetTransformBroadcast()

override void SCR_EditableWaypointComponent.SetTransformBroadcast ( vector transform[4] )

Implements SCR_EditableEntityComponent.

◆ SetWaypointIndex()

void SCR_EditableWaypointComponent.SetWaypointIndex	(	int	index,
		bool	isCurrent,
		SCR_EditableEntityComponent	prevWaypoint
	)

Assign order index of the waypoint and whether it's current or not.

Parameters

[in]	index	Order in group's waypoints, starting with 0
[in]	isCurrent	True if the waypoint is current
[in]	prevWaypoint

Member Data Documentation

◆ m_AttachableWaypoint

SCR_AIWaypoint SCR_EditableWaypointComponent.m_AttachableWaypoint

protected

◆ m_AttachedTo

SCR_EditableEntityComponent SCR_EditableWaypointComponent.m_AttachedTo

protected

◆ m_AttachedToId

RplId SCR_EditableWaypointComponent.m_AttachedToId

protected

◆ m_bIsCurrent

bool SCR_EditableWaypointComponent.m_bIsCurrent

protected

◆ m_Group

SCR_EditableEntityComponent SCR_EditableWaypointComponent.m_Group

protected

◆ m_iIndex

int SCR_EditableWaypointComponent.m_iIndex

protected

◆ m_PrevWaypoint

SCR_EditableEntityComponent SCR_EditableWaypointComponent.m_PrevWaypoint

protected

◆ m_PrevWaypointId

RplId SCR_EditableWaypointComponent.m_PrevWaypointId

protected

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

Game/Editor/Components/EditableEntity/SCR_EditableWaypointComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SCR_EditableWaypointComponent()

Member Function Documentation

◆ AttachTo()

◆ CanDuplicate()

◆ CanSetParent()

◆ DetachFromTarget()

◆ EOnEditorPlace()

◆ GetAIGroup()

◆ GetAttachedTo()

◆ GetFaction()

◆ GetPos()

◆ GetPrevWaypoint()

◆ GetWaypointIndex()

◆ IsAttachable()

◆ IsAttached()

◆ IsCurrent()

◆ OnAttachedToId()

◆ OnDelete()

◆ OnParentEntityChanged()

◆ OnPreWaypointIdRpl()

◆ SetTransform()

◆ SetTransformBroadcast()

◆ SetWaypointIndex()

Member Data Documentation

◆ m_AttachableWaypoint

◆ m_AttachedTo

◆ m_AttachedToId

◆ m_bIsCurrent

◆ m_Group

◆ m_iIndex

◆ m_PrevWaypoint

◆ m_PrevWaypointId