Barotrauma.EventObjectiveAction Class Reference

Displays an objective in the top-right corner of the screen, or modifies an existing objective in some way. More...

Inheritance diagram for Barotrauma.EventObjectiveAction:

Public Types
enum	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)
override void	Reset ()
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 ()
virtual string	ToDebugString ()
	Rich test to display in debugdraw.

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)
string	GetEventDebugName ()

Detailed Description

Displays an objective in the top-right corner of the screen, or modifies an existing objective in some way.

Member Enumeration Documentation

SegmentActionType

enum Barotrauma.EventObjectiveAction.SegmentActionType

Enumerator
Trigger	Legacy support. Triggers an info box segment, with optional support for video clips.
Add	Adds a new objective to the list.
AddIfNotFound	Adds a new objective to the list if there are no existing objectives with the same identifier.
Complete	Marks the objective as completed.
CompleteAndRemove	Marks the objective as completed and removes it from the list.
Remove	Removes the objective from the list.
Fail	Marks the objective as failed.
FailAndRemove	Marks the objective as failed and removes it from the list.

Constructor & Destructor Documentation

EventObjectiveAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.EventObjectiveAction.IsFinished

(

ref string

goToLabel

)

Reset()

override void Barotrauma.EventObjectiveAction.Reset

(

)

Update()

override void Barotrauma.EventObjectiveAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

AutoPlayVideo

bool Barotrauma.EventObjectiveAction.AutoPlayVideo

getset

CanBeCompleted

bool Barotrauma.EventObjectiveAction.CanBeCompleted

getset

Height

int Barotrauma.EventObjectiveAction.Height

getset

Identifier

Identifier Barotrauma.EventObjectiveAction.Identifier

getset

ObjectiveTag

Identifier Barotrauma.EventObjectiveAction.ObjectiveTag

getset

ParentObjectiveId

Identifier Barotrauma.EventObjectiveAction.ParentObjectiveId

getset

TargetTag

Identifier Barotrauma.EventObjectiveAction.TargetTag

getset

TextTag

Identifier Barotrauma.EventObjectiveAction.TextTag

getset

Type

SegmentActionType Barotrauma.EventObjectiveAction.Type

getset

VideoFile

string Barotrauma.EventObjectiveAction.VideoFile

getset

Width

int Barotrauma.EventObjectiveAction.Width

getset

---

The documentation for this class was generated from the following files:

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Events/EventActions/EventObjectiveAction.cs
• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaServer/ServerSource/Events/EventActions/EventObjectiveAction.cs