Barotrauma.TriggerAction Class Reference

Waits for a player to trigger the action before continuing. Triggering can mean entering a specific trigger area, or interacting with a specific entity. More...

Inheritance diagram for Barotrauma.TriggerAction:

Public Types
enum	TriggerType { Inside , Outside }

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

Public Attributes
bool	isRunning = false
Public Attributes inherited from Barotrauma.EventAction
readonly ScriptedEvent	ParentEvent

Properties
Identifier	Target1Tag [get, set]
Identifier	Target2Tag [get, set]
Identifier	TargetModuleType [get, set]
Identifier	ApplyToTarget1 [get, set]
Identifier	ApplyToTarget2 [get, set]
TriggerType	Type [get, set]
float	Radius [get, set]
bool	DisableInCombat [get, set]
bool	DisableIfTargetIncapacitated [get, set]
bool	WaitForInteraction [get, set]
bool	AllowMultipleTargets [get, set]
bool	CheckAllTargets [get, set]
bool	SelectOnTrigger [get, set]

Additional Inherited Members
Static Public Member Functions inherited from Barotrauma.EventAction
static EventAction	Instantiate (ScriptedEvent scriptedEvent, ContentXElement element)
Protected Member Functions inherited from Barotrauma.EventAction
void	ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
string	GetEventDebugName ()

Detailed Description

Waits for a player to trigger the action before continuing. Triggering can mean entering a specific trigger area, or interacting with a specific entity.

Member Enumeration Documentation

TriggerType

enum Barotrauma.TriggerAction.TriggerType

Enumerator
Inside
Outside

Constructor & Destructor Documentation

TriggerAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.TriggerAction.IsFinished

(

ref string

goTo

)

Reset()

override void Barotrauma.TriggerAction.Reset

(

)

ToDebugString()

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

Update()

override void Barotrauma.TriggerAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Member Data Documentation

isRunning

bool Barotrauma.TriggerAction.isRunning = false

Property Documentation

AllowMultipleTargets

bool Barotrauma.TriggerAction.AllowMultipleTargets

getset

ApplyToTarget1

Identifier Barotrauma.TriggerAction.ApplyToTarget1

getset

ApplyToTarget2

Identifier Barotrauma.TriggerAction.ApplyToTarget2

getset

CheckAllTargets

bool Barotrauma.TriggerAction.CheckAllTargets

getset

DisableIfTargetIncapacitated

bool Barotrauma.TriggerAction.DisableIfTargetIncapacitated

getset

DisableInCombat

bool Barotrauma.TriggerAction.DisableInCombat

getset

Radius

float Barotrauma.TriggerAction.Radius

getset

SelectOnTrigger

bool Barotrauma.TriggerAction.SelectOnTrigger

getset

Target1Tag

Identifier Barotrauma.TriggerAction.Target1Tag

getset

Target2Tag

Identifier Barotrauma.TriggerAction.Target2Tag

getset

TargetModuleType

Identifier Barotrauma.TriggerAction.TargetModuleType

getset

Type

TriggerType Barotrauma.TriggerAction.Type

getset

WaitForInteraction

bool Barotrauma.TriggerAction.WaitForInteraction

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