VisibleOnScreenEnabler2D

A rectangular region of 2D space that, when visible on screen, enables a target node.

1.0.0

class VisibleOnScreenEnabler2DReckfellSharpInherits VisibleOnScreenNotifier2D

A rectangular region of 2D space that, when visible on screen, enables a target node.

VisibleOnScreenEnabler2D contains a rectangular region of 2D 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 VisibleOnScreenNotifier2D if you only want to be notified when the region is visible on screen. Note: VisibleOnScreenEnabler2D uses the render culling code to determine whether it's visible on screen, so it won't function unless CanvasItem.Visible is set to true.

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

Constructors1

VisibleOnScreenEnabler2DConstructor

# VisibleOnScreenEnabler2D

C#
public VisibleOnScreenEnabler2D();

Properties2

EnableEntityPathProperty

# EnableEntityPath

C#
public EntityPath EnableEntityPath { get; set; }

The path to the target node, relative to the VisibleOnScreenEnabler2D. The target node is cached; it's only assigned when setting this property (if the VisibleOnScreenEnabler2D is inside the scene tree) and every time the VisibleOnScreenEnabler2D 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 VisibleOnScreenEnabler2D.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

GetEnableModeVisibleOnScreenEnabler2D.EnableModeEnum

# GetEnableMode

C#
public VisibleOnScreenEnabler2D.EnableModeEnum GetEnableMode();

Returns VisibleOnScreenEnabler2D.EnableModeEnum

SetEnableEntityPathvoid

# SetEnableEntityPath

C#
public void SetEnableEntityPath(EntityPath path);

Parameters
Name	Type	Default
`path`	`EntityPath`	—

SetEnableModevoid

# SetEnableMode

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

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

VisibleOnScreenEnabler2D.EnableModeEnum

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

Reckfell Engine documentationBack to top ↑