Barotrauma.MessageBoxAction Class Reference

Displays a message box, or modifies an existing one. More...

Inheritance diagram for Barotrauma.MessageBoxAction:

Public Types
enum	ActionType { Create , ConnectObjective , Close , Clear }

Public Member Functions
	MessageBoxAction (ScriptedEvent parentEvent, ContentXElement element)
override void	Update (float deltaTime)
override bool	IsFinished (ref string goToLabel)
override void	Reset ()
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
ActionType	Type [get, set]
Identifier	Identifier [get, set]
string	Tag [get, set]
Identifier	Header [get, set]
Identifier	Text [get, set]
string	IconStyle [get, set]
bool	HideCloseButton [get, set]
Identifier	TargetTag [get, set]
string	CloseOnInput [get, set]
Identifier	CloseOnSelectTag [get, set]
Identifier	CloseOnPickUpTag [get, set]
Identifier	CloseOnEquipTag [get, set]
Identifier	CloseOnExitRoomName [get, set]
Identifier	CloseOnInRoomName [get, set]
Identifier	ObjectiveTag [get, set]
bool	ObjectiveCanBeCompleted [get, set]
Identifier	ParentObjectiveId [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

Displays a message box, or modifies an existing one.

Member Enumeration Documentation

ActionType

enum Barotrauma.MessageBoxAction.ActionType

Enumerator
Create
ConnectObjective
Close
Clear

Constructor & Destructor Documentation

MessageBoxAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.MessageBoxAction.IsFinished

(

ref string

goToLabel

)

Reset()

override void Barotrauma.MessageBoxAction.Reset

(

)

ToDebugString()

override string Barotrauma.MessageBoxAction.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.MessageBoxAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

CloseOnEquipTag

Identifier Barotrauma.MessageBoxAction.CloseOnEquipTag

getset

CloseOnExitRoomName

Identifier Barotrauma.MessageBoxAction.CloseOnExitRoomName

getset

CloseOnInput

string Barotrauma.MessageBoxAction.CloseOnInput

getset

CloseOnInRoomName

Identifier Barotrauma.MessageBoxAction.CloseOnInRoomName

getset

CloseOnPickUpTag

Identifier Barotrauma.MessageBoxAction.CloseOnPickUpTag

getset

CloseOnSelectTag

Identifier Barotrauma.MessageBoxAction.CloseOnSelectTag

getset

Header

Identifier Barotrauma.MessageBoxAction.Header

getset

HideCloseButton

bool Barotrauma.MessageBoxAction.HideCloseButton

getset

IconStyle

string Barotrauma.MessageBoxAction.IconStyle

getset

Identifier

Identifier Barotrauma.MessageBoxAction.Identifier

getset

ObjectiveCanBeCompleted

bool Barotrauma.MessageBoxAction.ObjectiveCanBeCompleted

getset

ObjectiveTag

Identifier Barotrauma.MessageBoxAction.ObjectiveTag

getset

ParentObjectiveId

Identifier Barotrauma.MessageBoxAction.ParentObjectiveId

getset

Tag

string Barotrauma.MessageBoxAction.Tag

getset

TargetTag

Identifier Barotrauma.MessageBoxAction.TargetTag

getset

Text

Identifier Barotrauma.MessageBoxAction.Text

getset

Type

ActionType Barotrauma.MessageBoxAction.Type

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