Barotrauma.CheckItemAction Class Reference

Inheritance diagram for Barotrauma.CheckItemAction:

Public Member Functions
	CheckItemAction (ScriptedEvent parentEvent, ContentXElement element)
override string	ToDebugString ()
	Rich test to display in debugdraw More...
Public Member Functions inherited from Barotrauma.BinaryOptionAction
	BinaryOptionAction (ScriptedEvent parentEvent, ContentXElement element)
override IEnumerable< EventAction >	GetSubActions ()
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 ()
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)

Properties
Identifier	TargetTag [get, set]
string	ItemIdentifiers [get, set]
string	ItemTags [get, set]
int	Amount [get, set]
Identifier	HullTag [get, set]
Identifier	ApplyTagToTarget [get, set]
Identifier	ApplyTagToItem [get, set]
bool	RequireEquipped [get, set]
bool	Recursive [get, set]
int	ItemContainerIndex [get, set]
float	RequiredConditionalMatchPercentage [get, set]
	What percentage of targets do the conditionals need to match for the check to succeed? More...
bool	CompareToInitialAmount [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
Protected Attributes inherited from Barotrauma.BinaryOptionAction
bool?	succeeded = null

Detailed Description

Definition at line 9 of file CheckItemAction.cs.

Constructor & Destructor Documentation

CheckItemAction()

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

Definition at line 64 of file CheckItemAction.cs.

Member Function Documentation

DetermineSuccess()

override? bool Barotrauma.CheckItemAction.DetermineSuccess ( )

protectedvirtual

Implements Barotrauma.BinaryOptionAction.

Definition at line 112 of file CheckItemAction.cs.

ToDebugString()

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

Definition at line 262 of file CheckItemAction.cs.

Property Documentation

Amount

int Barotrauma.CheckItemAction.Amount

getset

Definition at line 21 of file CheckItemAction.cs.

ApplyTagToItem

Identifier Barotrauma.CheckItemAction.ApplyTagToItem

getset

Definition at line 30 of file CheckItemAction.cs.

ApplyTagToTarget

Identifier Barotrauma.CheckItemAction.ApplyTagToTarget

getset

Definition at line 27 of file CheckItemAction.cs.

CompareToInitialAmount

bool Barotrauma.CheckItemAction.CompareToInitialAmount

getset

Definition at line 57 of file CheckItemAction.cs.

HullTag

Identifier Barotrauma.CheckItemAction.HullTag

getset

Definition at line 24 of file CheckItemAction.cs.

ItemContainerIndex

int Barotrauma.CheckItemAction.ItemContainerIndex

getset

Definition at line 39 of file CheckItemAction.cs.

ItemIdentifiers

string Barotrauma.CheckItemAction.ItemIdentifiers

getset

Definition at line 15 of file CheckItemAction.cs.

ItemTags

string Barotrauma.CheckItemAction.ItemTags

getset

Definition at line 18 of file CheckItemAction.cs.

Recursive

bool Barotrauma.CheckItemAction.Recursive

getset

Definition at line 36 of file CheckItemAction.cs.

RequiredConditionalMatchPercentage

float Barotrauma.CheckItemAction.RequiredConditionalMatchPercentage

getset

What percentage of targets do the conditionals need to match for the check to succeed?

Definition at line 50 of file CheckItemAction.cs.

RequireEquipped

bool Barotrauma.CheckItemAction.RequireEquipped

getset

Definition at line 33 of file CheckItemAction.cs.

TargetTag

Identifier Barotrauma.CheckItemAction.TargetTag

getset

Definition at line 12 of file CheckItemAction.cs.