summaryrefslogtreecommitdiff
path: root/doc/classes/FuncRef.xml
diff options
context:
space:
mode:
authorWilson E. Alvarez <wilson.e.alvarez1@gmail.com>2020-09-27 08:43:56 -0400
committerWilson E. Alvarez <wilson.e.alvarez1@gmail.com>2020-09-30 06:57:59 -0400
commitb4e7edabf351753878098cbfc518c9f8074ec70f (patch)
tree5b196311244c9ee3aba11037e1a859a4bd5c78cf /doc/classes/FuncRef.xml
parent72a3759ae5b56e5483ef82f8cf8831c6174f2087 (diff)
Make "function" a property of FuncRef
Diffstat (limited to 'doc/classes/FuncRef.xml')
-rw-r--r--doc/classes/FuncRef.xml30
1 files changed, 13 insertions, 17 deletions
diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml
index bf0c0b0d34..7c01397c24 100644
--- a/doc/classes/FuncRef.xml
+++ b/doc/classes/FuncRef.xml
@@ -14,7 +14,7 @@
<return type="Variant">
</return>
<description>
- Calls the referenced function previously set by [method set_function] or [method @GDScript.funcref].
+ Calls the referenced function previously set in [member function] or [method @GDScript.funcref].
</description>
</method>
<method name="call_funcv">
@@ -23,35 +23,31 @@
<argument index="0" name="arg_array" type="Array">
</argument>
<description>
- Calls the referenced function previously set by [method set_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].
+ 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">
- </return>
- <description>
- Returns whether the object still exists and has the function assigned.
- </description>
- </method>
- <method name="set_function">
+ <method name="set_instance">
<return type="void">
</return>
- <argument index="0" name="name" type="StringName">
+ <argument index="0" name="instance" type="Object">
</argument>
<description>
- The name of the referenced function to call on the object, without parentheses or any parameters.
+ 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>
- <method name="set_instance">
- <return type="void">
+ <method name="is_valid" qualifiers="const">
+ <return type="bool">
</return>
- <argument index="0" name="instance" type="Object">
- </argument>
<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].
+ Returns whether the object still exists and has the function assigned.
</description>
</method>
</methods>
+ <members>
+ <member name="function" type="StringName" setter="set_function" getter="get_function">
+ The name of the referenced function.
+ </member>
+ </members>
<constants>
</constants>
</class>