Barotrauma.UIHighlightAction Class Reference

Highlights an UI element of some kind. Generally used in tutorials. More...

Inheritance diagram for Barotrauma.UIHighlightAction:

Public Types
enum	ElementId {   None , RepairButton , PumpSpeedSlider , PassiveSonarIndicator ,   ActiveSonarIndicator , SonarModeSwitch , DirectionalSonarFrame , SteeringModeSwitch ,   MaintainPosTickBox , AutoTempSwitch , PowerButton , FissionRateSlider ,   TurbineOutputSlider , DeconstructButton , RechargeSpeedSlider , CPRButton ,   CloseButton , MessageBoxCloseButton }

Public Member Functions
	UIHighlightAction (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
ElementId	Id [get, set]
Identifier	EntityIdentifier [get, set]
OrderCategory	OrderCategory [get, set]
Identifier	OrderIdentifier [get, set]
Identifier	OrderOption [get, set]
Identifier	OrderTargetTag [get, set]
bool	Bounce [get, set]
bool	HighlightMultiple [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

Highlights an UI element of some kind. Generally used in tutorials.

Member Enumeration Documentation

ElementId

enum Barotrauma.UIHighlightAction.ElementId

Enumerator
None
RepairButton
PumpSpeedSlider
PassiveSonarIndicator
ActiveSonarIndicator
SonarModeSwitch
DirectionalSonarFrame
SteeringModeSwitch
MaintainPosTickBox
AutoTempSwitch
PowerButton
FissionRateSlider
TurbineOutputSlider
DeconstructButton
RechargeSpeedSlider
CPRButton
CloseButton
MessageBoxCloseButton

Constructor & Destructor Documentation

UIHighlightAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.UIHighlightAction.IsFinished

(

ref string

goToLabel

)

Reset()

override void Barotrauma.UIHighlightAction.Reset

(

)

Update()

override void Barotrauma.UIHighlightAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

Bounce

bool Barotrauma.UIHighlightAction.Bounce

getset

EntityIdentifier

Identifier Barotrauma.UIHighlightAction.EntityIdentifier

getset

HighlightMultiple

bool Barotrauma.UIHighlightAction.HighlightMultiple

getset

Id

ElementId Barotrauma.UIHighlightAction.Id

getset

OrderCategory

OrderCategory Barotrauma.UIHighlightAction.OrderCategory

getset

OrderIdentifier

Identifier Barotrauma.UIHighlightAction.OrderIdentifier

getset

OrderOption

Identifier Barotrauma.UIHighlightAction.OrderOption

getset

OrderTargetTag

Identifier Barotrauma.UIHighlightAction.OrderTargetTag

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