mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
64 lines
2.7 KiB
ReStructuredText
64 lines
2.7 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the FuncRef.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_FuncRef:
|
|
|
|
FuncRef
|
|
=======
|
|
|
|
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Reference to a function in an object.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`call_func<class_FuncRef_method_call_func>` **(** ... **)** vararg |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_function<class_FuncRef_method_set_function>` **(** :ref:`String<class_String>` name **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_instance<class_FuncRef_method_set_instance>` **(** :ref:`Object<class_Object>` instance **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
In GDScript, functions are not *first-class objects*. 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 :ref:`@GDScript.funcref<class_@GDScript_method_funcref>` function, a reference to a function in a given object can be created, passed around and called.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_FuncRef_method_call_func:
|
|
|
|
- :ref:`Variant<class_Variant>` **call_func** **(** ... **)** vararg
|
|
|
|
Calls the referenced function previously set by :ref:`set_function<class_FuncRef_method_set_function>` or :ref:`@GDScript.funcref<class_@GDScript_method_funcref>`.
|
|
|
|
----
|
|
|
|
.. _class_FuncRef_method_set_function:
|
|
|
|
- void **set_function** **(** :ref:`String<class_String>` name **)**
|
|
|
|
The name of the referenced function to call on the object, without parentheses or any parameters.
|
|
|
|
----
|
|
|
|
.. _class_FuncRef_method_set_instance:
|
|
|
|
- void **set_instance** **(** :ref:`Object<class_Object>` instance **)**
|
|
|
|
The object containing the referenced function. This object must be of a type actually inheriting from :ref:`Object<class_Object>`, not a built-in type such as :ref:`int<class_int>`, :ref:`Vector2<class_Vector2>` or :ref:`Dictionary<class_Dictionary>`.
|
|
|