Barotrauma.EventLogAction Class Reference

Adds an entry to the "event log" displayed in the mission tab of the tab menu. More...

Inheritance diagram for Barotrauma.EventLogAction:

Public Member Functions
	EventLogAction (ScriptedEvent parentEvent, ContentXElement element)
override bool	IsFinished (ref string goTo)
override void	Reset ()
LocalizedString	GetDisplayText ()
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< EventAction >	GetSubActions ()

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)
string	GetEventDebugName ()

Detailed Description

Adds an entry to the "event log" displayed in the mission tab of the tab menu.

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

goTo

)

Reset()

override void Barotrauma.EventLogAction.Reset

(

)

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()})";
}

Returns

Reimplemented from Barotrauma.EventAction.

Update()

override void Barotrauma.EventLogAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

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

---

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