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

Public Member Functions

 ModifyLocationAction (ScriptedEvent parentEvent, ContentXElement element)
 
override bool IsFinished (ref string goTo)
 Has the action finished. More...
 
override void Reset ()
 
override void Update (float deltaTime)
 
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 Faction [get, set]
 
Identifier SecondaryFaction [get, set]
 
Identifier Type [get, set]
 
Identifier Name [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 3 of file ModifyLocationAction.cs.

Constructor & Destructor Documentation

◆ ModifyLocationAction()

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

Definition at line 19 of file ModifyLocationAction.cs.

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.ModifyLocationAction.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 23 of file ModifyLocationAction.cs.

◆ Reset()

override void Barotrauma.ModifyLocationAction.Reset ( )
virtual

Implements Barotrauma.EventAction.

Definition at line 27 of file ModifyLocationAction.cs.

◆ ToDebugString()

override string Barotrauma.ModifyLocationAction.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 89 of file ModifyLocationAction.cs.

◆ Update()

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

Reimplemented from Barotrauma.EventAction.

Definition at line 32 of file ModifyLocationAction.cs.

Property Documentation

◆ Faction

Identifier Barotrauma.ModifyLocationAction.Faction
getset

Definition at line 6 of file ModifyLocationAction.cs.

◆ Name

Identifier Barotrauma.ModifyLocationAction.Name
getset

Definition at line 15 of file ModifyLocationAction.cs.

◆ SecondaryFaction

Identifier Barotrauma.ModifyLocationAction.SecondaryFaction
getset

Definition at line 9 of file ModifyLocationAction.cs.

◆ Type

Identifier Barotrauma.ModifyLocationAction.Type
getset

Definition at line 12 of file ModifyLocationAction.cs.