Barotrauma.ModifyLocationAction Class Reference

Modifies the current location in some way (e.g. adjusting the faction, type of name). More...

Inheritance diagram for Barotrauma.ModifyLocationAction:

Public Member Functions
	ModifyLocationAction (ScriptedEvent parentEvent, ContentXElement element)
override bool	IsFinished (ref string goTo)
override void	Reset ()
override void	Update (float deltaTime)
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	Faction [get, set]
Identifier	SecondaryFaction [get, set]
Identifier	Type [get, set]
Identifier	Name [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

Modifies the current location in some way (e.g. adjusting the faction, type of name).

Constructor & Destructor Documentation

ModifyLocationAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.ModifyLocationAction.IsFinished

(

ref string

goTo

)

Reset()

override void Barotrauma.ModifyLocationAction.Reset

(

)

ToDebugString()

override string Barotrauma.ModifyLocationAction.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.ModifyLocationAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

Faction

Identifier Barotrauma.ModifyLocationAction.Faction

getset

Name

Identifier Barotrauma.ModifyLocationAction.Name

getset

SecondaryFaction

Identifier Barotrauma.ModifyLocationAction.SecondaryFaction

getset

Type

Identifier Barotrauma.ModifyLocationAction.Type

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