Barotrauma Client
Loading...
Searching...
No Matches
Barotrauma.TutorialIconAction Class Reference

Displays a tutorial icon next to a specific target. More...

Inheritance diagram for Barotrauma.TutorialIconAction:
Barotrauma.EventAction

Public Types

enum  ActionType {
  Add , Remove , RemoveTarget , RemoveIcon ,
  Clear
}
 

Public Member Functions

 TutorialIconAction (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< EventActionGetSubActions ()
 
virtual string ToDebugString ()
 Rich test to display in debugdraw.
 

Properties

ActionType Type [get, set]
 
Identifier TargetTag [get, set]
 
Identifier IconStyle [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 a tutorial icon next to a specific target.

Member Enumeration Documentation

◆ ActionType

Enumerator
Add 
Remove 
RemoveTarget 
RemoveIcon 
Clear 

Constructor & Destructor Documentation

◆ TutorialIconAction()

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

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.TutorialIconAction.IsFinished ( ref string goToLabel)

◆ Reset()

override void Barotrauma.TutorialIconAction.Reset ( )

◆ Update()

override void Barotrauma.TutorialIconAction.Update ( float deltaTime)
virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

◆ IconStyle

Identifier Barotrauma.TutorialIconAction.IconStyle
getset

◆ TargetTag

Identifier Barotrauma.TutorialIconAction.TargetTag
getset

◆ Type

ActionType Barotrauma.TutorialIconAction.Type
getset

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