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

Public Types

enum class  OperationType { Set , Add }
 

Public Member Functions

 MissionStateAction (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 MissionIdentifier [get, set]
 
OperationType Operation [get, set]
 
int State [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 MissionStateAction.cs.

Member Enumeration Documentation

◆ OperationType

Enumerator
Set 
Add 

Definition at line 8 of file MissionStateAction.cs.

Constructor & Destructor Documentation

◆ MissionStateAction()

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

Definition at line 22 of file MissionStateAction.cs.

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.MissionStateAction.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 32 of file MissionStateAction.cs.

◆ Reset()

override void Barotrauma.MissionStateAction.Reset ( )
virtual

Implements Barotrauma.EventAction.

Definition at line 36 of file MissionStateAction.cs.

◆ ToDebugString()

override string Barotrauma.MissionStateAction.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 62 of file MissionStateAction.cs.

◆ Update()

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

Reimplemented from Barotrauma.EventAction.

Definition at line 41 of file MissionStateAction.cs.

Property Documentation

◆ MissionIdentifier

Identifier Barotrauma.MissionStateAction.MissionIdentifier
getset

Definition at line 6 of file MissionStateAction.cs.

◆ Operation

OperationType Barotrauma.MissionStateAction.Operation
getset

Definition at line 15 of file MissionStateAction.cs.

◆ State

int Barotrauma.MissionStateAction.State
getset

Definition at line 18 of file MissionStateAction.cs.