Open Classmigueldeicaza.swiftgodot 0.45.0SwiftGodot

VisibleOnScreenEnabler2D

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

class VisibleOnScreenEnabler2D

Mangled symbol

s10SwiftGodot24VisibleOnScreenEnabler2DCWhat are these?

FNV24: [73AIB]

VisibleOnScreenEnabler2D contains a rectangular region of 2D space and a target node. The target node will be automatically enabled (via its 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.

Superclasses

class VisibleOnScreenNotifier2D
A rectangular region of 2D space that detects whether it is visible on screen.

Citizens in SwiftGodot

Conformances

protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Types

enum EnableMode

Type members

class var godotClassName: StringName

Instance members

var enableMode: VisibleOnScreenEnabler2D.EnableMode
Determines how the target node is enabled. Corresponds to Node.ProcessMode. When the node is disabled, it always uses disabled.
var enableNodePath: NodePath
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 invalid, an error will be printed in the editor and no node will be affected.