Barotrauma.Label Class Reference

Inheritance diagram for Barotrauma.Label:

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

Properties
string	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 5 of file Label.cs.

Constructor & Destructor Documentation

Label()

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

Definition at line 10 of file Label.cs.

Member Function Documentation

IsFinished()

override bool Barotrauma.Label.IsFinished ( ref string  goToLabel )

virtual

Has the action finished.

Parameters

goToLabel

If null or empty, the event moves to the next action. Otherwise it moves to the specified label.

Returns

Implements Barotrauma.EventAction.

Definition at line 12 of file Label.cs.

Reset()

override void Barotrauma.Label.Reset ( )

virtual

Implements Barotrauma.EventAction.

Definition at line 27 of file Label.cs.

SetGoToTarget()

override bool Barotrauma.Label.SetGoToTarget ( string  goTo )

virtual

Reimplemented from Barotrauma.EventAction.

Definition at line 17 of file Label.cs.

ToDebugString()

override string Barotrauma.Label.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.

Definition at line 22 of file Label.cs.

Property Documentation

Name

string Barotrauma.Label.Name

getset

Definition at line 8 of file Label.cs.