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

Public Member Functions

 EventLogAction (ScriptedEvent parentEvent, ContentXElement element)
 
override bool IsFinished (ref string goTo)
 Has the action finished. More...
 
override void Reset ()
 
LocalizedString GetDisplayText ()
 
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 Id [get, set]
 
string Text [get, set]
 
Identifier TargetTag [get, set]
 
bool ShowInServerLog [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

◆ EventLogAction()

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

Member Function Documentation

◆ GetDisplayText()

LocalizedString Barotrauma.EventLogAction.GetDisplayText ( )

◆ IsFinished()

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

◆ Reset()

override void Barotrauma.EventLogAction.Reset ( )
virtual

◆ ToDebugString()

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

◆ Update()

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

Property Documentation

◆ Id

Identifier Barotrauma.EventLogAction.Id
getset

◆ ShowInServerLog

bool Barotrauma.EventLogAction.ShowInServerLog
getset

◆ TargetTag

Identifier Barotrauma.EventLogAction.TargetTag
getset

◆ Text

string Barotrauma.EventLogAction.Text
getset