VisibleOnScreenEnabler3D
A box-shaped region of 3D space that, when visible on screen, enables a target node.
VisibleOnScreenEnabler3D.swift:22class VisibleOnScreenEnabler3D
VisibleOnScreenEnabler3D
contains a box-shaped region of 3D 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 VisibleOnScreenNotifier3D
if you only want to be notified when the region is visible on screen.
Superclasses
class VisibleOnScreenNotifier3D
A box-shaped region of 3D 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 exampleGString
,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
Type members
Instance members
var enableMode: VisibleOnScreenEnabler3D.EnableMode
Determines how the target node is enabled. Corresponds to
Node.ProcessMode
. When the node is disabled, it always usesdisabled
.var enableNodePath: NodePath
The path to the target node, relative to the
VisibleOnScreenEnabler3D
. The target node is cached; it’s only assigned when setting this property (if theVisibleOnScreenEnabler3D
is inside the scene tree) and every time theVisibleOnScreenEnabler3D
enters the scene tree. If the path is empty, no node will be affected. If the path is invalid, an error is also generated.