Barotrauma Client Doc
Barotrauma.WaitForItemUsedAction Class Reference
Inheritance diagram for Barotrauma.WaitForItemUsedAction:
Barotrauma.EventAction

Public Member Functions

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

Properties

Identifier ItemTag [get, set]
 
Identifier UserTag [get, set]
 
Identifier TargetItemComponent [get, set]
 
Identifier ApplyTagToItem [get, set]
 
Identifier ApplyTagToUser [get, set]
 
Identifier ApplyTagToHull [get, set]
 
Identifier ApplyTagToLinkedHulls [get, set]
 
int RequiredUseCount [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 10 of file WaitForItemUsedAction.cs.

Constructor & Destructor Documentation

◆ WaitForItemUsedAction()

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

Definition at line 56 of file WaitForItemUsedAction.cs.

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.WaitForItemUsedAction.IsFinished ( ref string  goToLabel)
virtual

Has the action finished.

Parameters
goToLabelIf null or empty, the event moves to the next action. Otherwise it moves to the specified label.
Returns

Implements Barotrauma.EventAction.

Definition at line 135 of file WaitForItemUsedAction.cs.

◆ Reset()

override void Barotrauma.WaitForItemUsedAction.Reset ( )
virtual

Implements Barotrauma.EventAction.

Definition at line 140 of file WaitForItemUsedAction.cs.

◆ ToDebugString()

override string Barotrauma.WaitForItemUsedAction.ToDebugString ( )
virtual

Rich test to display in debugdraw

public override string ToDebugString()
{
return $"{ToolBox.GetDebugSymbol(isFinished)} SomeAction -> "(someInfo: {info.ColorizeObject()})";
}
override string ToDebugString()
Rich test to display in debugdraw
Returns

Reimplemented from Barotrauma.EventAction.

Definition at line 147 of file WaitForItemUsedAction.cs.

◆ Update()

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

Reimplemented from Barotrauma.EventAction.

Definition at line 87 of file WaitForItemUsedAction.cs.

Property Documentation

◆ ApplyTagToHull

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToHull
getset

Definition at line 28 of file WaitForItemUsedAction.cs.

◆ ApplyTagToItem

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToItem
getset

Definition at line 22 of file WaitForItemUsedAction.cs.

◆ ApplyTagToLinkedHulls

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToLinkedHulls
getset

Definition at line 31 of file WaitForItemUsedAction.cs.

◆ ApplyTagToUser

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToUser
getset

Definition at line 25 of file WaitForItemUsedAction.cs.

◆ ItemTag

Identifier Barotrauma.WaitForItemUsedAction.ItemTag
getset

Definition at line 13 of file WaitForItemUsedAction.cs.

◆ RequiredUseCount

int Barotrauma.WaitForItemUsedAction.RequiredUseCount
getset

Definition at line 34 of file WaitForItemUsedAction.cs.

◆ TargetItemComponent

Identifier Barotrauma.WaitForItemUsedAction.TargetItemComponent
getset

Definition at line 19 of file WaitForItemUsedAction.cs.

◆ UserTag

Identifier Barotrauma.WaitForItemUsedAction.UserTag
getset

Definition at line 16 of file WaitForItemUsedAction.cs.