blob: 523acb8983721149928efaf34bf665e118802abd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="FuncRef" inherits="Reference" category="Core" version="3.2">
<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 [code]FuncRef[/code] 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>
<demos>
</demos>
<methods>
<method name="call_func" qualifiers="vararg">
<return type="Variant">
</return>
<description>
Calls the referenced function previously set by [method set_function] or [method @GDScript.funcref].
</description>
</method>
<method name="set_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
The name of the referenced function to call on the object, without parentheses or any parameters.
</description>
</method>
<method name="set_instance">
<return type="void">
</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].
</description>
</method>
</methods>
<constants>
</constants>
</class>
|