godot/doc/classes/VisibilityEnabler2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.1">
	<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>
	</methods>
	<members>
		<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] [RigidBody2D] nodes will be paused.
		</member>
		<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] [AnimatedSprite] 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>
		<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			If [code]true[/code] [Particles2D] nodes will be paused.
		</member>
		<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
			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">
			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 [Particles2D] 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">
		</constant>
		<constant name="ENABLER_MAX" value="6" enum="Enabler">
		</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" ?>`
doc: Remove status from hardcoded version string It has no practical use case and just generates noise for each alpha, beta, etc. 2018-02-27 20:40:43 +08:00			`<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.1">`
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>`
			`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>`
			`</methods>`
			`<members>`
doc: Sync classref with current source [ci skip] 2017-09-13 14:49:40 +08:00			`<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
[DOCS] Update VisibilityEnabler* and TileSet doc 2018-10-02 06:20:18 +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: Sync classref with current source [ci skip] 2017-09-13 14:49:40 +08:00			`<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
[DOCS] Update VisibilityEnabler* and TileSet doc 2018-10-02 06:20:18 +08:00			`If [code]true[/code] [AnimatedSprite] 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: Sync classref with current source [ci skip] 2017-09-13 14:49:40 +08:00			`<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
[DOCS] Update VisibilityEnabler* and TileSet doc 2018-10-02 06:20:18 +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: Sync classref with current source [ci skip] 2017-09-13 14:49:40 +08:00			`<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
[DOCS] Update VisibilityEnabler* and TileSet doc 2018-10-02 06:20:18 +08:00			`If [code]true[/code] [Particles2D] 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: 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 name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
[DOCS] Update VisibilityEnabler* and TileSet doc 2018-10-02 06:20:18 +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: Sync classref with current source [ci skip] 2017-09-13 14:49:40 +08:00			`<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
[DOCS] Update VisibilityEnabler* and TileSet doc 2018-10-02 06:20:18 +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">`
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 [Particles2D] nodes.`
			`</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">`
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">`
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>`