Barotrauma Client
Loading...
Searching...
No Matches
Barotrauma.ClearTagAction Class Reference

Clears the specific tag from the event (i.e. untagging all the entities that have been previously given the tag). More...

Inheritance diagram for Barotrauma.ClearTagAction:
Barotrauma.EventAction

Public Member Functions

 ClearTagAction (ScriptedEvent parentEvent, ContentXElement element)
 
override bool IsFinished (ref string goToLabel)
 
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< EventActionGetSubActions ()
 

Properties

Identifier Tag [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

Clears the specific tag from the event (i.e. untagging all the entities that have been previously given the tag).

Constructor & Destructor Documentation

◆ ClearTagAction()

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

Member Function Documentation

◆ IsFinished()

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

◆ Reset()

override void Barotrauma.ClearTagAction.Reset ( )

◆ ToDebugString()

override string Barotrauma.ClearTagAction.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.
Definition ClearTagAction.cs:34
Returns

Reimplemented from Barotrauma.EventAction.

◆ Update()

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

Reimplemented from Barotrauma.EventAction.

Property Documentation

◆ Tag

Identifier Barotrauma.ClearTagAction.Tag
getset

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