VisibilityEnabler

Enables certain nodes only when approximately visible.

The VisibilityEnabler will disable RigidBody and AnimationPlayer nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. If you just want to receive notifications, use VisibilityNotifier instead. Note: VisibilityEnabler uses an approximate heuristic for performance reasons. It doesn't take walls and other occlusion into account. The heuristic is an implementation detail and may change in future versions. If you need precise visibility checking, use another method such as adding an Area node as a child of a Camera node and/or Vector3.dot. Note: VisibilityEnabler will not affect nodes added after scene initialization.

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

Constants
enum Constants
Enabler
enum Enabler

Functions

_nodeRemoved
void _nodeRemoved(Node arg0)
isEnablerEnabled
bool isEnablerEnabled(long enabler)

Returns whether the enabler identified by given enabler constant is active.

opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(VisibilityEnabler other)
opEquals
bool opEquals(typeof(null) n)
setEnabler
void setEnabler(long enabler, bool enabled)

Sets active state of the enabler identified by given enabler constant.

toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

freezeBodies
bool freezeBodies [@property getter]
bool freezeBodies [@property setter]

If true, RigidBody nodes will be paused.

pauseAnimations
bool pauseAnimations [@property getter]
bool pauseAnimations [@property setter]

If true, AnimationPlayer nodes will be paused.

Static functions

_new
VisibilityEnabler _new()

Construct a new instance of VisibilityEnabler. Note: use memnew!VisibilityEnabler instead.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

GDNativeClassBinding
struct GDNativeClassBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
inout(To) as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
inout(To) as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
inout(ToRef) as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta