2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-25 14:00:31 +02:00
<class name= "VisibilityEnabler2D" inherits= "VisibilityNotifier2D" category= "Core" version= "3.1.1" >
2017-09-12 22:42:36 +02:00
<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>
<methods >
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "freeze_bodies" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], [RigidBody2D] nodes will be paused.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "pause_animated_sprites" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], [AnimatedSprite] nodes will be paused.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "pause_animations" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], [AnimationPlayer] nodes will be paused.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "pause_particles" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], [Particles2D] nodes will be paused.
2017-09-12 22:42:36 +02:00
</member>
2017-10-11 23:54:43 +02:00
<member name= "physics_process_parent" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], the parent's [method Node._physics_process] will be stopped.
2017-10-11 23:54:43 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "process_parent" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], the parent's [method Node._process] will be stopped.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "ENABLER_PAUSE_ANIMATIONS" value= "0" enum= "Enabler" >
2017-09-12 22:42:36 +02:00
This enabler will pause [AnimationPlayer] nodes.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ENABLER_FREEZE_BODIES" value= "1" enum= "Enabler" >
2017-10-22 12:56:11 +02:00
This enabler will freeze [RigidBody2D] nodes.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ENABLER_PAUSE_PARTICLES" value= "2" enum= "Enabler" >
2017-09-12 22:42:36 +02:00
This enabler will stop [Particles2D] nodes.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ENABLER_PARENT_PROCESS" value= "3" enum= "Enabler" >
2017-09-12 22:42:36 +02:00
This enabler will stop the parent's _process function.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ENABLER_PARENT_PHYSICS_PROCESS" value= "4" enum= "Enabler" >
2017-10-11 23:54:43 +02:00
This enabler will stop the parent's _physics_process function.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ENABLER_PAUSE_ANIMATED_SPRITES" value= "5" enum= "Enabler" >
2017-10-22 12:56:11 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ENABLER_MAX" value= "6" enum= "Enabler" >
2017-09-12 22:42:36 +02:00
</constant>
</constants>
</class>