diff options
Diffstat (limited to 'doc/classes/VisibilityEnabler2D.xml')
| -rw-r--r-- | doc/classes/VisibilityEnabler2D.xml | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml new file mode 100644 index 0000000000..899be8993d --- /dev/null +++ b/doc/classes/VisibilityEnabler2D.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Enable certain nodes only when visible. + </brief_description> + <description> + The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_enabler_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler"> + </argument> + <description> + Returns whether the specified enabler was set to true or not. + </description> + </method> + <method name="set_enabler"> + <return type="void"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect. + </description> + </method> + </methods> + <members> + <member name="fixed_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled" brief=""> + </member> + <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" brief=""> + </member> + <member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled" brief=""> + </member> + <member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled" brief=""> + </member> + <member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled" brief=""> + </member> + <member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled" brief=""> + </member> + </members> + <constants> + <constant name="ENABLER_FREEZE_BODIES" value="1"> + This enabler will freeze [RigidBody2D] nodes. + </constant> + <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> + This enabler will pause [AnimationPlayer] nodes. + </constant> + <constant name="ENABLER_PAUSE_PARTICLES" value="2"> + This enabler will stop [Particles2D] nodes. + </constant> + <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> + </constant> + <constant name="ENABLER_PARENT_PROCESS" value="3"> + This enabler will stop the parent's _process function. + </constant> + <constant name="ENABLER_PARENT_FIXED_PROCESS" value="4"> + This enabler will stop the parent's _fixed_process function. + </constant> + <constant name="ENABLER_MAX" value="6"> + </constant> + </constants> +</class> |