Barotrauma.MissionStateAction Class Reference

Changes the state of a specific active mission. The way the states are used depends on the type of mission. More...

Inheritance diagram for Barotrauma.MissionStateAction:

Public Types
enum	OperationType { Set , Add }

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

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)
string	GetEventDebugName ()

Detailed Description

Changes the state of a specific active mission. The way the states are used depends on the type of mission.

Member Enumeration Documentation

OperationType

enum Barotrauma.MissionStateAction.OperationType

Enumerator
Set
Add

Constructor & Destructor Documentation

MissionStateAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.MissionStateAction.IsFinished

(

ref string

goTo

)

Reset()

override void Barotrauma.MissionStateAction.Reset

(

)

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()})";
}

Returns

Reimplemented from Barotrauma.EventAction.

Update()

override void Barotrauma.MissionStateAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

MissionIdentifier

Identifier Barotrauma.MissionStateAction.MissionIdentifier

getset

Operation

OperationType Barotrauma.MissionStateAction.Operation

getset

State

int Barotrauma.MissionStateAction.State

getset

---

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

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Events/EventActions/MissionStateAction.cs