godot/doc/classes/VisibilityEnabler2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" version="4.0">
	<brief_description>
		Enables 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 nodes with the same root node as the VisibilityEnabler2D, and the root node itself.
		Note that VisibilityEnabler2D will not affect nodes added after scene initialization.
	</description>
	<tutorials>
	</tutorials>
	<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 enabler identified by given [enum Enabler] constant is active.
			</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>
				Sets active state of the enabler identified by given [enum Enabler] constant.
			</description>
		</method>
	</methods>
	<members>
		<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">
			If [code]true[/code], [RigidBody2D] nodes will be paused.
		</member>
		<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">
			If [code]true[/code], [AnimatedSprite2D] nodes will be paused.
		</member>
		<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">
			If [code]true[/code], [AnimationPlayer] nodes will be paused.
		</member>
		<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">
			If [code]true[/code], [GPUParticles2D] nodes will be paused.
		</member>
		<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="false">
			If [code]true[/code], the parent's [method Node._physics_process] will be stopped.
		</member>
		<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="false">
			If [code]true[/code], the parent's [method Node._process] will be stopped.
		</member>
	</members>
	<constants>
		<constant name="ENABLER_PAUSE_ANIMATIONS" value="0" enum="Enabler">
			This enabler will pause [AnimationPlayer] nodes.
		</constant>
		<constant name="ENABLER_FREEZE_BODIES" value="1" enum="Enabler">
			This enabler will freeze [RigidBody2D] nodes.
		</constant>
		<constant name="ENABLER_PAUSE_PARTICLES" value="2" enum="Enabler">
			This enabler will stop [GPUParticles2D] nodes.
		</constant>
		<constant name="ENABLER_PARENT_PROCESS" value="3" enum="Enabler">
			This enabler will stop the parent's _process function.
		</constant>
		<constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4" enum="Enabler">
			This enabler will stop the parent's _physics_process function.
		</constant>
		<constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler">
			This enabler will stop [AnimatedSprite2D] nodes animations.
		</constant>
		<constant name="ENABLER_MAX" value="6" enum="Enabler">
			Represents the size of the [enum Enabler] enum.
		</constant>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Update docs to version 4.0 2020-02-01 09:03:48 +08:00			`<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" version="4.0">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 07:04:47 +08:00			`Enables certain nodes only when visible.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
[Docs] Clarify VisibilityEnabler2D description 2019-09-04 10:53:13 +08: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.`
Fix visibility enabler flag toggling 2020-03-17 23:44:48 +08:00			`Note that VisibilityEnabler2D will not affect nodes added after scene initialization.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 22:10:09 +08:00			`<method name="is_enabler_enabled" qualifiers="const">`
			`<return type="bool">`
			`</return>`
			`<argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler">`
			`</argument>`
			`<description>`
doc: Sync classref with current source 2020-01-12 21:30:21 +08:00			`Returns whether the enabler identified by given [enum Enabler] constant is active.`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 22:10:09 +08:00			`</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>`
Complete documentation of various classes 2020-01-09 05:51:16 +08:00			`Sets active state of the enabler identified by given [enum Enabler] constant.`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 22:10:09 +08:00			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], [RigidBody2D] nodes will be paused.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`If [code]true[/code], [AnimatedSprite2D] nodes will be paused.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], [AnimationPlayer] nodes will be paused.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="true">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`If [code]true[/code], [GPUParticles2D] nodes will be paused.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], the parent's [method Node._physics_process] will be stopped.`
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip] 2017-10-12 05:54:43 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], the parent's [method Node._process] will be stopped.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="ENABLER_PAUSE_ANIMATIONS" value="0" enum="Enabler">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`This enabler will pause [AnimationPlayer] nodes.`
			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="ENABLER_FREEZE_BODIES" value="1" enum="Enabler">`
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip] 2017-10-22 18:56:11 +08:00			`This enabler will freeze [RigidBody2D] nodes.`
			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="ENABLER_PAUSE_PARTICLES" value="2" enum="Enabler">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`This enabler will stop [GPUParticles2D] nodes.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="ENABLER_PARENT_PROCESS" value="3" enum="Enabler">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`This enabler will stop the parent's _process function.`
			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="ENABLER_PARENT_PHYSICS_PROCESS" value="4" enum="Enabler">`
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip] 2017-10-12 05:54:43 +08:00			`This enabler will stop the parent's _physics_process function.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`This enabler will stop [AnimatedSprite2D] nodes animations.`
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip] 2017-10-22 18:56:11 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="ENABLER_MAX" value="6" enum="Enabler">`
doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 17:10:53 +08:00			`Represents the size of the [enum Enabler] enum.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constant>`
			`</constants>`
			`</class>`