virtualx-engine/doc/classes/FuncRef.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="FuncRef" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Reference to a function in an object.
	</brief_description>
	<description>
		In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments.
		However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="call_func" qualifiers="vararg">
			<return type="Variant" />
			<description>
				Calls the referenced function previously set in [member function] or [method @GDScript.funcref].
			</description>
		</method>
		<method name="call_funcv">
			<return type="Variant" />
			<argument index="0" name="arg_array" type="Array" />
			<description>
				Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. Contrarily to [method call_func], this method does not support a variable number of arguments but expects all parameters to be passed via a single [Array].
			</description>
		</method>
		<method name="is_valid" qualifiers="const">
			<return type="bool" />
			<description>
				Returns whether the object still exists and has the function assigned.
			</description>
		</method>
		<method name="set_instance">
			<return type="void" />
			<argument index="0" name="instance" type="Object" />
			<description>
				The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary].
			</description>
		</method>
	</methods>
	<members>
		<member name="function" type="String" setter="set_function" getter="get_function" default="&quot;&quot;">
			The name of the referenced function.
		</member>
	</members>
	<constants>
	</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" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-03-16 23:01:02 +01:00			`<class name="FuncRef" inherits="Reference" version="3.5" 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>`
			`Reference to a function in an object.`
			`</brief_description>`
			`<description>`
			`In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments.`
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class. 2019-03-29 23:37:35 +01:00			`However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called.`
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>`
			`<methods>`
			`<method name="call_func" qualifiers="vararg">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="Variant" />`
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>`
Make "function" a property of FuncRef (cherry picked from commit b4e7edabf351753878098cbfc518c9f8074ec70f) 2020-09-27 14:43:56 +02:00			`Calls the referenced function previously set in [member function] or [method @GDScript.funcref].`
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>`
			`</method>`
Add FuncRef.call_funcv Closes #31143 2019-08-08 08:51:18 +02:00			`<method name="call_funcv">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="Variant" />`
			`<argument index="0" name="arg_array" type="Array" />`
Add FuncRef.call_funcv Closes #31143 2019-08-08 08:51:18 +02:00			`<description>`
Make "function" a property of FuncRef (cherry picked from commit b4e7edabf351753878098cbfc518c9f8074ec70f) 2020-09-27 14:43:56 +02:00			`Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. Contrarily to [method call_func], this method does not support a variable number of arguments but expects all parameters to be passed via a single [Array].`
Add FuncRef.call_funcv Closes #31143 2019-08-08 08:51:18 +02:00			`</description>`
			`</method>`
doc: Sync classref with current source 2020-10-19 17:13:30 +02:00			`<method name="is_valid" qualifiers="const">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="bool" />`
doc: Sync classref with current source 2020-10-19 17:13:30 +02:00			`<description>`
			`Returns whether the object still exists and has the function assigned.`
			`</description>`
			`</method>`
Make "function" a property of FuncRef (cherry picked from commit b4e7edabf351753878098cbfc518c9f8074ec70f) 2020-09-27 14:43:56 +02:00			`<method name="set_instance">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="void" />`
			`<argument index="0" name="instance" type="Object" />`
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>`
Make "function" a property of FuncRef (cherry picked from commit b4e7edabf351753878098cbfc518c9f8074ec70f) 2020-09-27 14:43:56 +02:00			`The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary].`
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>`
			`</method>`
			`</methods>`
Make "function" a property of FuncRef (cherry picked from commit b4e7edabf351753878098cbfc518c9f8074ec70f) 2020-09-27 14:43:56 +02:00			`<members>`
doc: Sync classref with current source 2020-10-19 17:13:30 +02:00			`<member name="function" type="String" setter="set_function" getter="get_function" default="""">`
Make "function" a property of FuncRef (cherry picked from commit b4e7edabf351753878098cbfc518c9f8074ec70f) 2020-09-27 14:43:56 +02:00			`The name of the referenced function.`
			`</member>`
			`</members>`
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			`<constants>`
			`</constants>`
			`</class>`