godot/doc/classes/VisibilityEnabler3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityEnabler3D" inherits="VisibilityNotifier3D" version="4.0">
	<brief_description>
		Enables certain nodes only when visible.
	</brief_description>
	<description>
		The VisibilityEnabler3D will disable [RigidBody3D] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler3D itself.
		Note that VisibilityEnabler3D 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="VisibilityEnabler3D.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="VisibilityEnabler3D.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], [RigidBody3D] 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>
	</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 [RigidBody3D] nodes.
		</constant>
		<constant name="ENABLER_MAX" value="2" 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-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`<class name="VisibilityEnabler3D" inherits="VisibilityNotifier3D" 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-12 20:42:36 +00: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-21 23:04:47 +00: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-12 20:42:36 +00:00			`</brief_description>`
			`<description>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`The VisibilityEnabler3D will disable [RigidBody3D] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler3D itself.`
			`Note that VisibilityEnabler3D 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-12 20:42:36 +00: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 14:10:09 +00:00			`<method name="is_enabler_enabled" qualifiers="const">`
			`<return type="bool">`
			`</return>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`<argument index="0" name="enabler" type="int" enum="VisibilityEnabler3D.Enabler">`
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 14:10:09 +00:00			`</argument>`
			`<description>`
doc: Sync classref with current source 2020-01-12 13:30:21 +00: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 14:10:09 +00:00			`</description>`
			`</method>`
			`<method name="set_enabler">`
			`<return type="void">`
			`</return>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`<argument index="0" name="enabler" type="int" enum="VisibilityEnabler3D.Enabler">`
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 14:10:09 +00:00			`</argument>`
			`<argument index="1" name="enabled" type="bool">`
			`</argument>`
			`<description>`
Complete documentation of various classes 2020-01-08 21:51:16 +00: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 14:10:09 +00: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-12 20:42:36 +00:00			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="freeze_bodies" 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-30 16:22:57 +00:00			`If [code]true[/code], [RigidBody3D] 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-12 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00: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 12:46:54 +00: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-12 20:42:36 +00:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00: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-12 20:42:36 +00:00			`This enabler will pause [AnimationPlayer] nodes.`
			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00:00			`<constant name="ENABLER_FREEZE_BODIES" value="1" enum="Enabler">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`This enabler will freeze [RigidBody3D] nodes.`
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip] 2017-10-22 10:56:11 +00:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00:00			`<constant name="ENABLER_MAX" value="2" enum="Enabler">`
doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 09:10:53 +00: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-12 20:42:36 +00:00			`</constant>`
			`</constants>`
			`</class>`