Barotrauma.TagAction Class Reference

Inheritance diagram for Barotrauma.TagAction:

Public Types
enum class	SubType {   Any = 0 , Player = 1 , Outpost = 2 , Wreck = 4 ,   BeaconStation = 8 }

Public Member Functions
	TagAction (ScriptedEvent parentEvent, ContentXElement element)
override bool	IsFinished (ref string goTo)
	Has the action finished. More...
override void	Reset ()
override void	Update (float deltaTime)
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
string	Criteria [get, set]
Identifier	Tag [get, set]
SubType	SubmarineType [get, set]
bool	IgnoreIncapacitatedCharacters [get, set]
bool	AllowHiddenItems [get, set]
bool	ChooseRandom [get, set]
bool	ContinueIfNoTargetsFound [get, set]
float	ChoosePercentage [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 9 of file TagAction.cs.

Member Enumeration Documentation

SubType

enum Barotrauma.TagAction.SubType

strong

Enumerator
Any
Player
Outpost
Wreck
BeaconStation

Definition at line 11 of file TagAction.cs.

Constructor & Destructor Documentation

TagAction()

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

Definition at line 53 of file TagAction.cs.

Member Function Documentation

IsFinished()

override bool Barotrauma.TagAction.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.

Definition at line 77 of file TagAction.cs.

Reset()

override void Barotrauma.TagAction.Reset ( )

virtual

Implements Barotrauma.EventAction.

Definition at line 81 of file TagAction.cs.

ToDebugString()

override string Barotrauma.TagAction.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 359 of file TagAction.cs.

Update()

override void Barotrauma.TagAction.Update ( float  deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Definition at line 314 of file TagAction.cs.

Property Documentation

AllowHiddenItems

bool Barotrauma.TagAction.AllowHiddenItems

getset

Definition at line 26 of file TagAction.cs.

ChoosePercentage

float Barotrauma.TagAction.ChoosePercentage

getset

Definition at line 35 of file TagAction.cs.

ChooseRandom

bool Barotrauma.TagAction.ChooseRandom

getset

Definition at line 29 of file TagAction.cs.

ContinueIfNoTargetsFound

bool Barotrauma.TagAction.ContinueIfNoTargetsFound

getset

Definition at line 32 of file TagAction.cs.

Criteria

string Barotrauma.TagAction.Criteria

getset

Definition at line 14 of file TagAction.cs.

IgnoreIncapacitatedCharacters

bool Barotrauma.TagAction.IgnoreIncapacitatedCharacters

getset

Definition at line 23 of file TagAction.cs.

SubmarineType

SubType Barotrauma.TagAction.SubmarineType

getset

Definition at line 20 of file TagAction.cs.

Tag

Identifier Barotrauma.TagAction.Tag

getset

Definition at line 17 of file TagAction.cs.