godot/doc/classes/VisibilityEnabler.xml

32 lines
1.2 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 09:32:53 +00:00
<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.1.2">
<brief_description>
Enable certain nodes only when visible.
</brief_description>
<description>
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.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
If [code]true[/code], [RigidBody] nodes will be paused.
</member>
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
If [code]true[/code], [AnimationPlayer] nodes will be paused.
</member>
</members>
<constants>
2017-11-24 22:16:30 +00:00
<constant name="ENABLER_PAUSE_ANIMATIONS" value="0" enum="Enabler">
This enabler will pause [AnimationPlayer] nodes.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="ENABLER_FREEZE_BODIES" value="1" enum="Enabler">
This enabler will freeze [RigidBody] nodes.
</constant>
2017-11-24 22:16:30 +00:00
<constant name="ENABLER_MAX" value="2" enum="Enabler">
</constant>
</constants>
</class>