SCR_EditableWaypointComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_EditableWaypointComponentClass

Functions
SCR_EditableWaypointComponentClass SCR_EditableEntityComponentClass	RplProp (onRplName:"OnPreWaypointIdRpl")
	Special configuration for editable waypoint.
void	AttachTo (SCR_EditableEntityComponent attachedTo)
void	OnAttachedToId ()
	Runs when an ID is attached.
void	SetWaypointIndex (int index, bool isCurrent, SCR_EditableEntityComponent prevWaypoint)
int	GetWaypointIndex ()
bool	IsCurrent ()
SCR_EditableEntityComponent	GetPrevWaypoint ()
void	OnPreWaypointIdRpl ()
override bool	CanDuplicate (out notnull set< SCR_EditableEntityComponent > outRecipients)
override Faction	GetFaction ()
override SCR_EditableEntityComponent	GetAIGroup ()
override void	OnParentEntityChanged (SCR_EditableEntityComponent parentEntity, SCR_EditableEntityComponent parentEntityPrev, bool changedByUser)
override bool	SetTransform (vector transform[4], bool changedByUser=false)
override void	SetTransformBroadcast (vector transform[4])
void	DetachFromTarget ()
	Detach the waypoint from the target, runs both in client and server.
override bool	GetPos (out vector pos)
override bool	CanSetParent (SCR_EditableEntityComponent parentEntity)
override SCR_EditableEntityComponent	EOnEditorPlace (out SCR_EditableEntityComponent parent, SCR_EditableEntityComponent recipient, EEditorPlacingFlags flags, bool isQueue, int playerID=0)
override void	OnDelete (IEntity owner)
override bool	IsAttachable ()
override bool	IsAttached ()
SCR_AIWaypoint	GetAIWaypoint ()
void	SCR_EditableWaypointComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Function Documentation

AttachTo()

void 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

Definition at line 38 of file SCR_EditableWaypointComponent.c.

CanDuplicate()

override bool CanDuplicate ( out notnull set< SCR_EditableEntityComponent > outRecipients )

protected

Definition at line 131 of file SCR_EditableWaypointComponent.c.

CanSetParent()

override bool CanSetParent ( SCR_EditableEntityComponent parentEntity )

protected

Definition at line 223 of file SCR_EditableWaypointComponent.c.

DetachFromTarget()

void DetachFromTarget ( )

protected

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

Definition at line 207 of file SCR_EditableWaypointComponent.c.

EOnEditorPlace()

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

protected

Definition at line 242 of file SCR_EditableWaypointComponent.c.

GetAIGroup()

override SCR_EditableEntityComponent GetAIGroup ( )

protected

Definition at line 151 of file SCR_EditableWaypointComponent.c.

GetAIWaypoint()

SCR_AIWaypoint GetAIWaypoint ( )

protected

Definition at line 292 of file SCR_EditableWaypointComponent.c.

GetFaction()

override Faction GetFaction ( )

protected

Definition at line 141 of file SCR_EditableWaypointComponent.c.

GetPos()

override bool GetPos ( out vector pos )

protected

Definition at line 214 of file SCR_EditableWaypointComponent.c.

GetPrevWaypoint()

SCR_EditableEntityComponent GetPrevWaypoint ( )

protected

Get previous waypoint.

Returns

Waypoint or group (when there is no previous waypoint)

Definition at line 116 of file SCR_EditableWaypointComponent.c.

GetWaypointIndex()

int GetWaypointIndex ( )

protected

Get order index of the waypoint.

Returns

Index starting with 0

Definition at line 100 of file SCR_EditableWaypointComponent.c.

IsAttachable()

override bool IsAttachable ( )

protected

Definition at line 277 of file SCR_EditableWaypointComponent.c.

IsAttached()

override bool IsAttached ( )

protected

Definition at line 283 of file SCR_EditableWaypointComponent.c.

IsCurrent()

bool IsCurrent ( )

protected

Check if the waypoint is group's current waypoint.

Returns

True when current

Definition at line 108 of file SCR_EditableWaypointComponent.c.

OnAttachedToId()

void OnAttachedToId ( )

protected

Runs when an ID is attached.

Definition at line 77 of file SCR_EditableWaypointComponent.c.

OnDelete()

override void OnDelete ( IEntity owner )

protected

Definition at line 263 of file SCR_EditableWaypointComponent.c.

OnParentEntityChanged()

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

protected

Definition at line 157 of file SCR_EditableWaypointComponent.c.

OnPreWaypointIdRpl()

void OnPreWaypointIdRpl ( )

protected

Definition at line 125 of file SCR_EditableWaypointComponent.c.

SCR_EditableWaypointComponent()

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

protected

Definition at line 298 of file SCR_EditableWaypointComponent.c.

SetTransform()

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

protected

Definition at line 192 of file SCR_EditableWaypointComponent.c.

SetTransformBroadcast()

override void SetTransformBroadcast ( vector transform[4] )

protected

Definition at line 199 of file SCR_EditableWaypointComponent.c.

SetWaypointIndex()

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

protected

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

Definition at line 88 of file SCR_EditableWaypointComponent.c.