Barotrauma.Label Class Reference

Defines a point in the event that GoTo actions can jump to. More...

Inheritance diagram for Barotrauma.Label:

Public Member Functions
	Label (ScriptedEvent parentEvent, ContentXElement element)
override bool	IsFinished (ref string goTo)
override bool	SetGoToTarget (string goTo)
override string	ToDebugString ()
	Rich test to display in debugdraw.
override void	Reset ()
Public Member Functions inherited from Barotrauma.EventAction
	EventAction (ScriptedEvent parentEvent, ContentXElement element)
bool	IsFinished (ref string goToLabel)
	Has the action finished.
void	Reset ()
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)
string	GetEventDebugName ()

Detailed Description

Defines a point in the event that GoTo actions can jump to.

Constructor & Destructor Documentation

Label()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.Label.IsFinished

(

ref string

goTo

)

Reset()

override void Barotrauma.Label.Reset

(

)

SetGoToTarget()

override bool Barotrauma.Label.SetGoToTarget ( string goTo )

virtual

Reimplemented from Barotrauma.EventAction.

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.

Property Documentation

Name

string Barotrauma.Label.Name

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/Label.cs