virtualx-engine/doc/classes/VisibleOnScreenEnabler2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisibleOnScreenEnabler2D" inherits="VisibleOnScreenNotifier2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Automatically disables another node if not visible on screen.
	</brief_description>
	<description>
		VisibleOnScreenEnabler2D detects when it is visible on screen (just like [VisibleOnScreenNotifier2D]) and automatically enables or disables the target node. The target node is disabled when [VisibleOnScreenEnabler2D] is not visible on screen (including when [member CanvasItem.visible] is [code]false[/code]), and enabled when the enabler is visible. The disabling is achieved by changing [member Node.process_mode].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="enable_mode" type="int" setter="set_enable_mode" getter="get_enable_mode" enum="VisibleOnScreenEnabler2D.EnableMode" default="0">
			Determines how the node is enabled. Corresponds to [enum Node.ProcessMode]. Disabled node uses [constant Node.PROCESS_MODE_DISABLED].
		</member>
		<member name="enable_node_path" type="NodePath" setter="set_enable_node_path" getter="get_enable_node_path" default="NodePath(&quot;..&quot;)">
			The path to the target node, relative to the [VisibleOnScreenEnabler2D]. The target node is cached; it's only assigned when setting this property (if the [VisibleOnScreenEnabler2D] is inside scene tree) and every time the [VisibleOnScreenEnabler2D] enters the scene tree. If the path is invalid, nothing will happen.
		</member>
	</members>
	<constants>
		<constant name="ENABLE_MODE_INHERIT" value="0" enum="EnableMode">
			Corresponds to [constant Node.PROCESS_MODE_INHERIT].
		</constant>
		<constant name="ENABLE_MODE_ALWAYS" value="1" enum="EnableMode">
			Corresponds to [constant Node.PROCESS_MODE_ALWAYS].
		</constant>
		<constant name="ENABLE_MODE_WHEN_PAUSED" value="2" enum="EnableMode">
			Corresponds to [constant Node.PROCESS_MODE_WHEN_PAUSED].
		</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" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="VisibleOnScreenEnabler2D" inherits="VisibleOnScreenNotifier2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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>`
Fill random docs 2022-10-06 21:59:48 +02:00			`Automatically disables another node if not visible on screen.`
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>`
			`<description>`
Fill random docs 2022-10-06 21:59:48 +02:00			`VisibleOnScreenEnabler2D detects when it is visible on screen (just like [VisibleOnScreenNotifier2D]) and automatically enables or disables the target node. The target node is disabled when [VisibleOnScreenEnabler2D] is not visible on screen (including when [member CanvasItem.visible] is [code]false[/code]), and enabled when the enabler is visible. The disabling is achieved by changing [member Node.process_mode].`
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			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
Rename VisibilityNotifierXD to VisibleOnScreenNotifierXD * Renames for 2D and 3D * Class name was confusing, given both 2D and 3D have a "visible" property that is unrelated to actual on-screen visibility. * New name makes it clear that this is about visibility on screen. 2021-06-17 02:52:30 +02:00			`<member name="enable_mode" type="int" setter="set_enable_mode" getter="get_enable_mode" enum="VisibleOnScreenEnabler2D.EnableMode" default="0">`
Fill random docs 2022-10-06 21:59:48 +02:00			`Determines how the node is enabled. Corresponds to [enum Node.ProcessMode]. Disabled node uses [constant Node.PROCESS_MODE_DISABLED].`
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>`
Refactor VisibilityNotifier * Works from RenderinServer * Accurately tells when on or off-scren, its no longer approximate. * VisibilityEnabler also simplified to use the process mode instead. 2021-06-15 22:33:24 +02:00			`<member name="enable_node_path" type="NodePath" setter="set_enable_node_path" getter="get_enable_node_path" default="NodePath("..")">`
Fill random docs 2022-10-06 21:59:48 +02:00			`The path to the target node, relative to the [VisibleOnScreenEnabler2D]. The target node is cached; it's only assigned when setting this property (if the [VisibleOnScreenEnabler2D] is inside scene tree) and every time the [VisibleOnScreenEnabler2D] enters the scene tree. If the path is invalid, nothing will happen.`
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>`
Refactor VisibilityNotifier * Works from RenderinServer * Accurately tells when on or off-scren, its no longer approximate. * VisibilityEnabler also simplified to use the process mode instead. 2021-06-15 22:33:24 +02:00			`<constant name="ENABLE_MODE_INHERIT" value="0" enum="EnableMode">`
Fill random docs 2022-10-06 21:59:48 +02:00			`Corresponds to [constant Node.PROCESS_MODE_INHERIT].`
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>`
Refactor VisibilityNotifier * Works from RenderinServer * Accurately tells when on or off-scren, its no longer approximate. * VisibilityEnabler also simplified to use the process mode instead. 2021-06-15 22:33:24 +02:00			`<constant name="ENABLE_MODE_ALWAYS" value="1" enum="EnableMode">`
Fill random docs 2022-10-06 21:59:48 +02:00			`Corresponds to [constant Node.PROCESS_MODE_ALWAYS].`
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			`</constant>`
Refactor VisibilityNotifier * Works from RenderinServer * Accurately tells when on or off-scren, its no longer approximate. * VisibilityEnabler also simplified to use the process mode instead. 2021-06-15 22:33:24 +02:00			`<constant name="ENABLE_MODE_WHEN_PAUSED" value="2" enum="EnableMode">`
Fix a few typos in the class reference 2023-02-16 06:26:17 +01:00			`Corresponds to [constant Node.PROCESS_MODE_WHEN_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 22:42:36 +02:00			`</constant>`
			`</constants>`
			`</class>`