Barotrauma.NPCChangeTeamAction Class Reference

Changes the team of an NPC. Most common use cases are adding a character to the crew, or turning an NPC hostile to the crew by changing their team to a hostile one. More...

Inheritance diagram for Barotrauma.NPCChangeTeamAction:

Public Member Functions
	NPCChangeTeamAction (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	NPCTag [get, set]
CharacterTeamType	TeamID [get, set]
bool	AddToCrew [get, set]
bool	RemoveFromCrew [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

Changes the team of an NPC. Most common use cases are adding a character to the crew, or turning an NPC hostile to the crew by changing their team to a hostile one.

Constructor & Destructor Documentation

NPCChangeTeamAction()

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

Member Function Documentation

IsFinished()

override bool Barotrauma.NPCChangeTeamAction.IsFinished

(

ref string

goTo

)

Reset()

override void Barotrauma.NPCChangeTeamAction.Reset

(

)

ToDebugString()

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

virtual

Reimplemented from Barotrauma.EventAction.

Property Documentation

AddToCrew

bool Barotrauma.NPCChangeTeamAction.AddToCrew

getset

NPCTag

Identifier Barotrauma.NPCChangeTeamAction.NPCTag

getset

RemoveFromCrew

bool Barotrauma.NPCChangeTeamAction.RemoveFromCrew

getset

TeamID

CharacterTeamType Barotrauma.NPCChangeTeamAction.TeamID

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