Barotrauma Client Doc
Barotrauma.NPCFollowAction Class Reference
Inheritance diagram for Barotrauma.NPCFollowAction:
Barotrauma.EventAction

Public Member Functions

 NPCFollowAction (ScriptedEvent parentEvent, ContentXElement element)
 
override void Update (float deltaTime)
 
override bool IsFinished (ref string goTo)
 Has the action finished. More...
 
override void Reset ()
 
override string ToDebugString ()
 Rich test to display in debugdraw More...
 
- Public Member Functions inherited from Barotrauma.EventAction
 EventAction (ScriptedEvent parentEvent, ContentXElement element)
 
virtual bool SetGoToTarget (string goTo)
 
virtual bool CanBeFinished ()
 
virtual IEnumerable< EventActionGetSubActions ()
 

Properties

Identifier NPCTag [get, set]
 
Identifier TargetTag [get, set]
 
bool Follow [get, set]
 
int MaxTargets [get, set]
 
bool AbandonOnReset [get, set]
 

Additional Inherited Members

- Static Public Member Functions inherited from Barotrauma.EventAction
static EventAction Instantiate (ScriptedEvent scriptedEvent, ContentXElement element)
 
- Public Attributes inherited from Barotrauma.EventAction
readonly ScriptedEvent ParentEvent
 
- Protected Member Functions inherited from Barotrauma.EventAction
void ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
 

Detailed Description

Definition at line 6 of file NPCFollowAction.cs.

Constructor & Destructor Documentation

◆ NPCFollowAction()

Barotrauma.NPCFollowAction.NPCFollowAction ( ScriptedEvent  parentEvent,
ContentXElement  element 
)

Definition at line 25 of file NPCFollowAction.cs.

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.NPCFollowAction.IsFinished ( ref string  goToLabel)
virtual

Has the action finished.

Parameters
goToLabelIf null or empty, the event moves to the next action. Otherwise it moves to the specified label.
Returns

Implements Barotrauma.EventAction.

Definition at line 74 of file NPCFollowAction.cs.

◆ Reset()

override void Barotrauma.NPCFollowAction.Reset ( )
virtual

Implements Barotrauma.EventAction.

Definition at line 79 of file NPCFollowAction.cs.

◆ ToDebugString()

override string Barotrauma.NPCFollowAction.ToDebugString ( )
virtual

Rich test to display in debugdraw

public override string ToDebugString()
{
return $"{ToolBox.GetDebugSymbol(isFinished)} SomeAction -> "(someInfo: {info.ColorizeObject()})";
}
override string ToDebugString()
Rich test to display in debugdraw
Returns

Reimplemented from Barotrauma.EventAction.

Definition at line 100 of file NPCFollowAction.cs.

◆ Update()

override void Barotrauma.NPCFollowAction.Update ( float  deltaTime)
virtual

Reimplemented from Barotrauma.EventAction.

Definition at line 31 of file NPCFollowAction.cs.

Property Documentation

◆ AbandonOnReset

bool Barotrauma.NPCFollowAction.AbandonOnReset
getset

Definition at line 21 of file NPCFollowAction.cs.

◆ Follow

bool Barotrauma.NPCFollowAction.Follow
getset

Definition at line 15 of file NPCFollowAction.cs.

◆ MaxTargets

int Barotrauma.NPCFollowAction.MaxTargets
getset

Definition at line 18 of file NPCFollowAction.cs.

◆ NPCTag

Identifier Barotrauma.NPCFollowAction.NPCTag
getset

Definition at line 9 of file NPCFollowAction.cs.

◆ TargetTag

Identifier Barotrauma.NPCFollowAction.TargetTag
getset

Definition at line 12 of file NPCFollowAction.cs.