VisibleOnScreenEnabler3D — C# API

A box-shaped region of 3D space that, when visible on screen, enables a target node.

class VisibleOnScreenEnabler3DReckfellSharpInherits VisibleOnScreenNotifier3D

A box-shaped region of 3D space that, when visible on screen, enables a target node.

VisibleOnScreenEnabler3D contains a box-shaped region of 3D space and a target node. The target node will be automatically enabled (via its Entity.ProcessMode property) when any part of this region becomes visible on the screen, and automatically disabled otherwise. This can for example be used to activate enemies only when the player approaches them. See VisibleOnScreenNotifier3D if you only want to be notified when the region is visible on screen. Note: VisibleOnScreenEnabler3D uses an approximate heuristic that doesn't take walls and other occlusion into account, unless occlusion culling is used. It also won't function unless Entity3D.Visible is set to true.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

VisibleOnScreenEnabler3DConstructor

# VisibleOnScreenEnabler3D

C#
public VisibleOnScreenEnabler3D();

Properties2

EnableEntityPathProperty

# EnableEntityPath

C#
public EntityPath EnableEntityPath { get; set; }

The path to the target node, relative to the VisibleOnScreenEnabler3D. The target node is cached; it's only assigned when setting this property (if the VisibleOnScreenEnabler3D is inside the scene tree) and every time the VisibleOnScreenEnabler3D enters the scene tree. If the path is empty, no node will be affected. If the path is invalid, an error is also generated.

EnableModeProperty

# EnableMode

C#
public VisibleOnScreenEnabler3D.EnableModeEnum EnableMode { get; set; }

Determines how the target node is enabled. Corresponds to Entity.ProcessModeEnum. When the node is disabled, it always uses Entity.ProcessModeEnum.Disabled.

Methods4

GetEnableEntityPathEntityPath

# GetEnableEntityPath

C#
public EntityPath GetEnableEntityPath();

Returns EntityPath

GetEnableModeVisibleOnScreenEnabler3D.EnableModeEnum

# GetEnableMode

C#
public VisibleOnScreenEnabler3D.EnableModeEnum GetEnableMode();

Returns VisibleOnScreenEnabler3D.EnableModeEnum

SetEnableEntityPathvoid

# SetEnableEntityPath

C#
public void SetEnableEntityPath(EntityPath path);

Parameters
Name	Type	Default
`path`	`EntityPath`	—

SetEnableModevoid

# SetEnableMode

C#
public void SetEnableMode(VisibleOnScreenEnabler3D.EnableModeEnum mode);

Parameters
Name	Type	Default
`mode`	`VisibleOnScreenEnabler3D.EnableModeEnum`	—

VisibleOnScreenEnabler3D.EnableModeEnum

Value	Description
`Always = 1`	Corresponds to `Entity.ProcessModeEnum.Always`.
`Inherit = 0`	Corresponds to `Entity.ProcessModeEnum.Inherit`.
`WhenPaused = 2`	Corresponds to `Entity.ProcessModeEnum.WhenPaused`.