Barotrauma Client Doc
Barotrauma.CheckDataAction Class Reference
Inheritance diagram for Barotrauma.CheckDataAction:
Barotrauma.BinaryOptionAction Barotrauma.EventAction Barotrauma.CheckReputationAction

Public Member Functions

 CheckDataAction (ScriptedEvent parentEvent, ContentXElement element)
 
 CheckDataAction (ContentXElement element, string parentDebugString)
 
bool GetSuccess ()
 
override string ToDebugString ()
 Rich test to display in debugdraw More...
 
- Public Member Functions inherited from Barotrauma.BinaryOptionAction
 BinaryOptionAction (ScriptedEvent parentEvent, ContentXElement element)
 
override IEnumerable< EventActionGetSubActions ()
 
override bool IsFinished (ref string goTo)
 Has the action finished. More...
 
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)
 
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 ()
 
- Protected Member Functions inherited from Barotrauma.EventAction
void ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
 

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

Definition at line 7 of file CheckDataAction.cs.

Constructor & Destructor Documentation

◆ CheckDataAction() [1/2]

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

Definition at line 26 of file CheckDataAction.cs.

◆ CheckDataAction() [2/2]

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

Definition at line 39 of file CheckDataAction.cs.

Member Function Documentation

◆ DetermineSuccess()

override? bool Barotrauma.CheckDataAction.DetermineSuccess ( )
protectedvirtual

Implements Barotrauma.BinaryOptionAction.

Definition at line 57 of file CheckDataAction.cs.

◆ GetBool()

virtual bool Barotrauma.CheckDataAction.GetBool ( CampaignMode  campaignMode)
protectedvirtual

Reimplemented in Barotrauma.CheckReputationAction.

Definition at line 178 of file CheckDataAction.cs.

◆ GetFloat()

virtual float Barotrauma.CheckDataAction.GetFloat ( CampaignMode  campaignMode)
protectedvirtual

Reimplemented in Barotrauma.CheckReputationAction.

Definition at line 183 of file CheckDataAction.cs.

◆ GetSuccess()

bool Barotrauma.CheckDataAction.GetSuccess ( )

Definition at line 52 of file CheckDataAction.cs.

◆ 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()})";
}
override string ToDebugString()
Rich test to display in debugdraw
Returns

Reimplemented from Barotrauma.EventAction.

Reimplemented in Barotrauma.CheckReputationAction.

Definition at line 193 of file CheckDataAction.cs.

Member Data Documentation

◆ value1

object? Barotrauma.CheckDataAction.value1
protected

Definition at line 22 of file CheckDataAction.cs.

◆ value2

object? Barotrauma.CheckDataAction.value2
protected

Definition at line 21 of file CheckDataAction.cs.

Property Documentation

◆ CheckAgainstMetadata

bool Barotrauma.CheckDataAction.CheckAgainstMetadata
getset

Definition at line 19 of file CheckDataAction.cs.

◆ Condition

string Barotrauma.CheckDataAction.Condition = ""
getset

Definition at line 13 of file CheckDataAction.cs.

◆ ForceString

bool Barotrauma.CheckDataAction.ForceString
getset

Definition at line 16 of file CheckDataAction.cs.

◆ Identifier

Identifier Barotrauma.CheckDataAction.Identifier = Identifier.Empty
getset

Definition at line 10 of file CheckDataAction.cs.

◆ Operator

PropertyConditional.ComparisonOperatorType Barotrauma.CheckDataAction.Operator
getsetprotected

Definition at line 24 of file CheckDataAction.cs.