Barotrauma.WaitForItemUsedAction Class Reference

Waits for some item(s) to be used before continuing the execution of the event. More...

Inheritance diagram for Barotrauma.WaitForItemUsedAction:

Public Member Functions
	WaitForItemUsedAction (ScriptedEvent parentEvent, ContentXElement element)
override void	Update (float deltaTime)
override bool	IsFinished (ref string goTo)
override void	Reset ()
override string	ToDebugString ()
	Rich test to display in debugdraw.
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 ()

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

Detailed Description

Waits for some item(s) to be used before continuing the execution of the event.

Constructor & Destructor Documentation

WaitForItemUsedAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.WaitForItemUsedAction.IsFinished

(

ref string

goTo

)

Reset()

override void Barotrauma.WaitForItemUsedAction.Reset

(

)

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()})";
}

Returns

Reimplemented from Barotrauma.EventAction.

Update()

override void Barotrauma.WaitForItemUsedAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

ApplyTagToHull

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToHull

getset

ApplyTagToItem

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToItem

getset

ApplyTagToLinkedHulls

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToLinkedHulls

getset

ApplyTagToUser

Identifier Barotrauma.WaitForItemUsedAction.ApplyTagToUser

getset

ItemTag

Identifier Barotrauma.WaitForItemUsedAction.ItemTag

getset

RequiredUseCount

int Barotrauma.WaitForItemUsedAction.RequiredUseCount

getset

TargetItemComponent

Identifier Barotrauma.WaitForItemUsedAction.TargetItemComponent

getset

UserTag

Identifier Barotrauma.WaitForItemUsedAction.UserTag

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