Barotrauma Server Doc
Barotrauma.StatusEffectAction Class Reference
Inheritance diagram for Barotrauma.StatusEffectAction:
Barotrauma.EventAction Barotrauma.EventAction

Public Member Functions

 StatusEffectAction (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 TargetTag [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

Constructor & Destructor Documentation

◆ StatusEffectAction()

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

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.StatusEffectAction.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 36 of file BarotraumaShared/SharedSource/Events/EventActions/StatusEffectAction.cs.

◆ Reset()

override void Barotrauma.StatusEffectAction.Reset ( )
virtual

◆ ToDebugString()

override string Barotrauma.StatusEffectAction.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 84 of file BarotraumaShared/SharedSource/Events/EventActions/StatusEffectAction.cs.

◆ Update()

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

Property Documentation

◆ TargetTag

Identifier Barotrauma.StatusEffectAction.TargetTag
getset