Barotrauma.MessageBoxAction Class Reference

Inheritance diagram for Barotrauma.MessageBoxAction:

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

Public Member Functions
	MessageBoxAction (ScriptedEvent parentEvent, ContentXElement element)
override void	Update (float deltaTime)
override bool	IsFinished (ref string goToLabel)
	Has the action finished. More...
override void	Reset ()
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< 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)

Detailed Description

Definition at line 3 of file MessageBoxAction.cs.

Member Enumeration Documentation

ActionType

enum Barotrauma.MessageBoxAction.ActionType

strong

Enumerator
Create
ConnectObjective
Close
Clear

Definition at line 5 of file MessageBoxAction.cs.

Constructor & Destructor Documentation

MessageBoxAction()

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

Definition at line 60 of file MessageBoxAction.cs.

Member Function Documentation

IsFinished()

override bool Barotrauma.MessageBoxAction.IsFinished ( ref string  goToLabel )

virtual

Has the action finished.

Parameters

goToLabel

If null or empty, the event moves to the next action. Otherwise it moves to the specified label.

Returns

Implements Barotrauma.EventAction.

Reset()

override void Barotrauma.MessageBoxAction.Reset ( )

virtual

Implements Barotrauma.EventAction.

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.

Definition at line 68 of file MessageBoxAction.cs.

Property Documentation

CloseOnEquipTag

Identifier Barotrauma.MessageBoxAction.CloseOnEquipTag

getset

Definition at line 41 of file MessageBoxAction.cs.

CloseOnExitRoomName

Identifier Barotrauma.MessageBoxAction.CloseOnExitRoomName

getset

Definition at line 44 of file MessageBoxAction.cs.

CloseOnInput

string Barotrauma.MessageBoxAction.CloseOnInput

getset

Definition at line 32 of file MessageBoxAction.cs.

CloseOnInRoomName

Identifier Barotrauma.MessageBoxAction.CloseOnInRoomName

getset

Definition at line 47 of file MessageBoxAction.cs.

CloseOnPickUpTag

Identifier Barotrauma.MessageBoxAction.CloseOnPickUpTag

getset

Definition at line 38 of file MessageBoxAction.cs.

CloseOnSelectTag

Identifier Barotrauma.MessageBoxAction.CloseOnSelectTag

getset

Definition at line 35 of file MessageBoxAction.cs.

Header

Identifier Barotrauma.MessageBoxAction.Header

getset

Definition at line 17 of file MessageBoxAction.cs.

HideCloseButton

bool Barotrauma.MessageBoxAction.HideCloseButton

getset

Definition at line 26 of file MessageBoxAction.cs.

IconStyle

string Barotrauma.MessageBoxAction.IconStyle

getset

Definition at line 23 of file MessageBoxAction.cs.

Identifier

Identifier Barotrauma.MessageBoxAction.Identifier

getset

Definition at line 11 of file MessageBoxAction.cs.

ObjectiveCanBeCompleted

bool Barotrauma.MessageBoxAction.ObjectiveCanBeCompleted

getset

Definition at line 53 of file MessageBoxAction.cs.

ObjectiveTag

Identifier Barotrauma.MessageBoxAction.ObjectiveTag

getset

Definition at line 50 of file MessageBoxAction.cs.

ParentObjectiveId

Identifier Barotrauma.MessageBoxAction.ParentObjectiveId

getset

Definition at line 56 of file MessageBoxAction.cs.

Tag

string Barotrauma.MessageBoxAction.Tag

getset

Definition at line 14 of file MessageBoxAction.cs.

TargetTag

Identifier Barotrauma.MessageBoxAction.TargetTag

getset

Definition at line 29 of file MessageBoxAction.cs.

Text

Identifier Barotrauma.MessageBoxAction.Text

getset

Definition at line 20 of file MessageBoxAction.cs.

Type

ActionType Barotrauma.MessageBoxAction.Type

getset

Definition at line 8 of file MessageBoxAction.cs.