virtualx-engine/doc/classes/VisibilityEnabler.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.0-stable">
	<brief_description>
		Enable certain nodes only when visible.
	</brief_description>
	<description>
		The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
	</methods>
	<members>
		<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
		</member>
		<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
		</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 [RigidBody] nodes.
		</constant>
		<constant name="ENABLER_MAX" value="2" 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-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Sync with current source Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage). 2018-01-25 08:50:56 +01:00			`<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.0-stable">`
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 22:42:36 +02:00			`<brief_description>`
			`Enable certain nodes only when visible.`
			`</brief_description>`
			`<description>`
			`The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself.`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<demos>`
			`</demos>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
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 22:42:36 +02:00			`</member>`
doc: Sync classref with current source [ci skip] 2017-09-13 08:49:40 +02:00			`<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">`
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 22:42:36 +02:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01: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 22:42:36 +02:00			`This enabler will pause [AnimationPlayer] nodes.`
			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01: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 12:56:11 +02:00			`This enabler will freeze [RigidBody] nodes.`
			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00			`<constant name="ENABLER_MAX" 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-12 22:42:36 +02:00			`</constant>`
			`</constants>`
			`</class>`