Barotrauma Client Doc
Barotrauma.AfflictionAction Class Reference
Inheritance diagram for Barotrauma.AfflictionAction:
Barotrauma.EventAction

Public Member Functions

 AfflictionAction (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 Affliction [get, set]
 
float Strength [get, set]
 
LimbType LimbType [get, set]
 
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

Definition at line 5 of file AfflictionAction.cs.

Constructor & Destructor Documentation

◆ AfflictionAction()

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

Definition at line 19 of file AfflictionAction.cs.

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.AfflictionAction.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 23 of file AfflictionAction.cs.

◆ Reset()

override void Barotrauma.AfflictionAction.Reset ( )
virtual

Implements Barotrauma.EventAction.

Definition at line 28 of file AfflictionAction.cs.

◆ ToDebugString()

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

Reimplemented from Barotrauma.EventAction.

Definition at line 72 of file AfflictionAction.cs.

◆ Update()

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

Reimplemented from Barotrauma.EventAction.

Definition at line 33 of file AfflictionAction.cs.

Property Documentation

◆ Affliction

Identifier Barotrauma.AfflictionAction.Affliction
getset

Definition at line 8 of file AfflictionAction.cs.

◆ LimbType

LimbType Barotrauma.AfflictionAction.LimbType
getset

Definition at line 14 of file AfflictionAction.cs.

◆ Strength

float Barotrauma.AfflictionAction.Strength
getset

Definition at line 11 of file AfflictionAction.cs.

◆ TargetTag

Identifier Barotrauma.AfflictionAction.TargetTag
getset

Definition at line 17 of file AfflictionAction.cs.