Barotrauma.EventObjectiveAction Class Reference

Inheritance diagram for Barotrauma.EventObjectiveAction:

Public Types
enum class	SegmentActionType {   Trigger , Add , AddIfNotFound , Complete ,   CompleteAndRemove , Remove , Fail , FailAndRemove }

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

Properties
SegmentActionType	Type [get, set]
Identifier	Identifier [get, set]
Identifier	ObjectiveTag [get, set]
bool	CanBeCompleted [get, set]
Identifier	ParentObjectiveId [get, set]
bool	AutoPlayVideo [get, set]
Identifier	TextTag [get, set]
string	VideoFile [get, set]
int	Width [get, set]
int	Height [get, set]
Identifier	TargetTag [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 3 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Member Enumeration Documentation

SegmentActionType

enum Barotrauma.EventObjectiveAction.SegmentActionType

strong

Enumerator
Trigger
Add
AddIfNotFound
Complete
CompleteAndRemove
Remove
Fail
FailAndRemove

Definition at line 5 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Constructor & Destructor Documentation

EventObjectiveAction()

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

Definition at line 42 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Member Function Documentation

IsFinished()

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

Reset()

override void Barotrauma.EventObjectiveAction.Reset ( )

virtual

Implements Barotrauma.EventAction.

Update()

override void Barotrauma.EventObjectiveAction.Update ( float  deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Definition at line 64 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Property Documentation

AutoPlayVideo

bool Barotrauma.EventObjectiveAction.AutoPlayVideo

getset

Definition at line 23 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

CanBeCompleted

bool Barotrauma.EventObjectiveAction.CanBeCompleted

getset

Definition at line 17 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Height

int Barotrauma.EventObjectiveAction.Height

getset

Definition at line 35 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Identifier

Identifier Barotrauma.EventObjectiveAction.Identifier

getset

Definition at line 11 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

ObjectiveTag

Identifier Barotrauma.EventObjectiveAction.ObjectiveTag

getset

Definition at line 14 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

ParentObjectiveId

Identifier Barotrauma.EventObjectiveAction.ParentObjectiveId

getset

Definition at line 20 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

TargetTag

Identifier Barotrauma.EventObjectiveAction.TargetTag

getset

Definition at line 38 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

TextTag

Identifier Barotrauma.EventObjectiveAction.TextTag

getset

Definition at line 26 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Type

SegmentActionType Barotrauma.EventObjectiveAction.Type

getset

Definition at line 8 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

VideoFile

string Barotrauma.EventObjectiveAction.VideoFile

getset

Definition at line 29 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.

Width

int Barotrauma.EventObjectiveAction.Width

getset

Definition at line 32 of file BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs.