2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-08-05 16:51:38 +00:00
<class name= "VisibilityEnabler2D" inherits= "VisibilityNotifier2D" version= "3.6" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
2020-04-17 20:04:19 +00:00
Enables certain nodes only when approximately visible.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2019-09-04 02:53:13 +00:00
The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect nodes with the same root node as the VisibilityEnabler2D, and the root node itself.
2020-07-17 22:29:03 +00:00
If you just want to receive notifications, use [VisibilityNotifier2D] instead.
[b]Note:[/b] For performance reasons, VisibilityEnabler2D uses an approximate heuristic with precision determined by [member ProjectSettings.world/2d/cell_size]. If you need precise visibility checking, use another method such as adding an [Area2D] node as a child of a [Camera2D] node.
2020-04-17 20:04:19 +00:00
[b]Note:[/b] VisibilityEnabler2D will not affect nodes added after scene initialization.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
2019-06-27 14:10:09 +00:00
<method name= "is_enabler_enabled" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "enabler" type= "int" enum= "VisibilityEnabler2D.Enabler" />
2019-06-27 14:10:09 +00:00
<description >
2020-01-12 13:30:21 +00:00
Returns whether the enabler identified by given [enum Enabler] constant is active.
2019-06-27 14:10:09 +00:00
</description>
</method>
<method name= "set_enabler" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
<argument index= "0" name= "enabler" type= "int" enum= "VisibilityEnabler2D.Enabler" />
<argument index= "1" name= "enabled" type= "bool" />
2019-06-27 14:10:09 +00:00
<description >
2020-01-08 21:51:16 +00:00
Sets active state of the enabler identified by given [enum Enabler] constant.
2019-06-27 14:10:09 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "freeze_bodies" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" default= "true" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], [RigidBody2D] nodes will be paused.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "pause_animated_sprites" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" default= "true" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], [AnimatedSprite] nodes will be paused.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "pause_animations" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" default= "true" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], [AnimationPlayer] nodes will be paused.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "pause_particles" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" default= "true" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], [Particles2D] nodes will be paused.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "physics_process_parent" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the parent's [method Node._physics_process] will be stopped.
2017-10-11 21:54:43 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "process_parent" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the parent's [method Node._process] will be stopped.
2017-09-12 20:42:36 +00:00
</member>
2022-07-19 08:56:47 +00:00
<member name= "visibility_parent" type= "bool" setter= "set_enabler" getter= "is_enabler_enabled" default= "true" >
If [code]true[/code] and the parent is a [CanvasItem], the parent will be hidden.
</member>
2017-09-12 20:42:36 +00:00
</members>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "ENABLER_PAUSE_ANIMATIONS" value= "0" enum= "Enabler" >
2017-09-12 20:42:36 +00:00
This enabler will pause [AnimationPlayer] nodes.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ENABLER_FREEZE_BODIES" value= "1" enum= "Enabler" >
2017-10-22 10:56:11 +00:00
This enabler will freeze [RigidBody2D] nodes.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ENABLER_PAUSE_PARTICLES" value= "2" enum= "Enabler" >
2017-09-12 20:42:36 +00:00
This enabler will stop [Particles2D] nodes.
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ENABLER_PARENT_PROCESS" value= "3" enum= "Enabler" >
2022-06-17 07:19:31 +00:00
This enabler will stop the parent's [method Node._process] function.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ENABLER_PARENT_PHYSICS_PROCESS" value= "4" enum= "Enabler" >
2022-06-17 07:19:31 +00:00
This enabler will stop the parent's [method Node._physics_process] function.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ENABLER_PAUSE_ANIMATED_SPRITES" value= "5" enum= "Enabler" >
2020-01-08 21:51:16 +00:00
This enabler will stop [AnimatedSprite] nodes animations.
2017-10-22 10:56:11 +00:00
</constant>
2022-07-19 08:56:47 +00:00
<constant name= "ENABLER_PARENT_VISIBILITY" value= "6" enum= "Enabler" >
</constant>
<constant name= "ENABLER_MAX" value= "7" enum= "Enabler" >
2019-06-27 09:10:53 +00:00
Represents the size of the [enum Enabler] enum.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>