Barotrauma.CheckVisibilityAction Class Reference

Check whether a specific entity is visible from the perspective of another entity. More...

Inheritance diagram for Barotrauma.CheckVisibilityAction:

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

Protected Member Functions
override? bool	DetermineSuccess ()
Protected Member Functions inherited from Barotrauma.BinaryOptionAction
bool	DetermineFinished ()
bool	DetermineFinished (ref string goTo)
bool	HasBeenDetermined ()
bool?	DetermineSuccess ()
Protected Member Functions inherited from Barotrauma.EventAction
void	ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
string	GetEventDebugName ()

Properties
Identifier	EntityTag [get, set]
Identifier	ExcludedEntityTag [get, set]
Identifier	TargetTag [get, set]
bool	CheckFacing [get, set]
float	MaxDistance [get, set]
Identifier	ApplyTagToEntity [get, set]
Identifier	ApplyTagToTarget [get, set]
bool	AllowSameEntity [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.BinaryOptionAction
SubactionGroup	Success = null
SubactionGroup	Failure = null
Public Attributes inherited from Barotrauma.EventAction
readonly ScriptedEvent	ParentEvent
Protected Attributes inherited from Barotrauma.BinaryOptionAction
bool?	succeeded = null

Detailed Description

Check whether a specific entity is visible from the perspective of another entity.

Constructor & Destructor Documentation

CheckVisibilityAction()

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

Member Function Documentation

DetermineSuccess()

override? bool Barotrauma.CheckVisibilityAction.DetermineSuccess ( )

protected

ToDebugString()

override string Barotrauma.CheckVisibilityAction.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.

Property Documentation

AllowSameEntity

bool Barotrauma.CheckVisibilityAction.AllowSameEntity

getset

ApplyTagToEntity

Identifier Barotrauma.CheckVisibilityAction.ApplyTagToEntity

getset

ApplyTagToTarget

Identifier Barotrauma.CheckVisibilityAction.ApplyTagToTarget

getset

CheckFacing

bool Barotrauma.CheckVisibilityAction.CheckFacing

getset

EntityTag

Identifier Barotrauma.CheckVisibilityAction.EntityTag

getset

ExcludedEntityTag

Identifier Barotrauma.CheckVisibilityAction.ExcludedEntityTag

getset

MaxDistance

float Barotrauma.CheckVisibilityAction.MaxDistance

getset

TargetTag

Identifier Barotrauma.CheckVisibilityAction.TargetTag

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