Barotrauma.CheckDataAction Class Reference

Can be used to check arbitrary campaign metadata set using SetDataAction. More...

Inheritance diagram for Barotrauma.CheckDataAction:

Public Member Functions
	CheckDataAction (ScriptedEvent parentEvent, ContentXElement element)
	CheckDataAction (ContentXElement element, string parentDebugString)
bool	GetSuccess ()
override string	ToDebugString ()
	Rich test to display in debugdraw.
Public Member Functions inherited from Barotrauma.BinaryOptionAction
	BinaryOptionAction (ScriptedEvent parentEvent, ContentXElement element)
override IEnumerable< EventAction >	GetSubActions ()
override bool	IsFinished (ref string goTo)
override bool	SetGoToTarget (string goTo)
override void	Reset ()
override void	Update (float deltaTime)
Public Member Functions inherited from Barotrauma.EventAction
	EventAction (ScriptedEvent parentEvent, ContentXElement element)
bool	IsFinished (ref string goToLabel)
	Has the action finished.
void	Reset ()
virtual bool	CanBeFinished ()

Protected Member Functions
override? bool	DetermineSuccess ()
virtual bool	GetBool (CampaignMode campaignMode)
virtual float	GetFloat (CampaignMode campaignMode)
Protected Member Functions inherited from Barotrauma.BinaryOptionAction
bool	DetermineFinished ()
bool	DetermineFinished (ref string goTo)
bool	HasBeenDetermined ()
bool?	DetermineSuccess ()
Protected Member Functions inherited from Barotrauma.EventAction
void	ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
string	GetEventDebugName ()

Protected Attributes
object?	value2
object?	value1
Protected Attributes inherited from Barotrauma.BinaryOptionAction
bool?	succeeded = null

Properties
Identifier	Identifier = Identifier.Empty [get, set]
string	Condition = "" [get, set]
bool	ForceString [get, set]
bool	CheckAgainstMetadata [get, set]
PropertyConditional.ComparisonOperatorType	Operator [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.BinaryOptionAction
SubactionGroup	Success = null
SubactionGroup	Failure = null
Public Attributes inherited from Barotrauma.EventAction
readonly ScriptedEvent	ParentEvent

Detailed Description

Can be used to check arbitrary campaign metadata set using SetDataAction.

Constructor & Destructor Documentation

CheckDataAction() [1/2]

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

CheckDataAction() [2/2]

Barotrauma.CheckDataAction.CheckDataAction	(	ContentXElement	element,
		string	parentDebugString )

Member Function Documentation

DetermineSuccess()

override? bool Barotrauma.CheckDataAction.DetermineSuccess ( )

protected

GetBool()

virtual bool Barotrauma.CheckDataAction.GetBool ( CampaignMode campaignMode )

protectedvirtual

GetFloat()

virtual float Barotrauma.CheckDataAction.GetFloat ( CampaignMode campaignMode )

protectedvirtual

GetSuccess()

bool Barotrauma.CheckDataAction.GetSuccess

(

)

ToDebugString()

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

Member Data Documentation

value1

object? Barotrauma.CheckDataAction.value1

protected

value2

object? Barotrauma.CheckDataAction.value2

protected

Property Documentation

CheckAgainstMetadata

bool Barotrauma.CheckDataAction.CheckAgainstMetadata

getset

Condition

string Barotrauma.CheckDataAction.Condition = ""

getset

ForceString

bool Barotrauma.CheckDataAction.ForceString

getset

Identifier

Identifier Barotrauma.CheckDataAction.Identifier = Identifier.Empty

getset

Operator

PropertyConditional.ComparisonOperatorType Barotrauma.CheckDataAction.Operator

getsetprotected

---

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