mirror of
https://github.com/godotengine/godot.git
synced 2024-12-09 10:09:20 +08:00
71 lines
2.7 KiB
XML
71 lines
2.7 KiB
XML
<?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">
|
|
</member>
|
|
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
|
</member>
|
|
<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
|
</member>
|
|
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
|
</member>
|
|
<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
|
</member>
|
|
<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
|
</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>
|