Barotrauma.CheckItemAction Class Reference

Can be used to do various kinds of checks on items: whether a specific kind of item exists, if it's in a specific character's inventory or in a container, or whether some conditions are met on the item. More...

Inheritance diagram for Barotrauma.CheckItemAction:

Public Member Functions
	CheckItemAction (ScriptedEvent parentEvent, ContentXElement element)
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 ()
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 ()

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	RequireWorn [get, set]
bool	Recursive [get, set]
int	ItemContainerIndex [get, set]
float	RequiredConditionalMatchPercentage [get, set]
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

Can be used to do various kinds of checks on items: whether a specific kind of item exists, if it's in a specific character's inventory or in a container, or whether some conditions are met on the item.

Constructor & Destructor Documentation

CheckItemAction()

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

Member Function Documentation

DetermineSuccess()

override? bool Barotrauma.CheckItemAction.DetermineSuccess ( )

protected

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.

Property Documentation

Amount

int Barotrauma.CheckItemAction.Amount

getset

ApplyTagToItem

Identifier Barotrauma.CheckItemAction.ApplyTagToItem

getset

ApplyTagToTarget

Identifier Barotrauma.CheckItemAction.ApplyTagToTarget

getset

CompareToInitialAmount

bool Barotrauma.CheckItemAction.CompareToInitialAmount

getset

HullTag

Identifier Barotrauma.CheckItemAction.HullTag

getset

ItemContainerIndex

int Barotrauma.CheckItemAction.ItemContainerIndex

getset

ItemIdentifiers

string Barotrauma.CheckItemAction.ItemIdentifiers

getset

ItemTags

string Barotrauma.CheckItemAction.ItemTags

getset

Recursive

bool Barotrauma.CheckItemAction.Recursive

getset

RequiredConditionalMatchPercentage

float Barotrauma.CheckItemAction.RequiredConditionalMatchPercentage

getset

RequireEquipped

bool Barotrauma.CheckItemAction.RequireEquipped

getset

RequireWorn

bool Barotrauma.CheckItemAction.RequireWorn

getset

TargetTag

Identifier Barotrauma.CheckItemAction.TargetTag

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