Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: a9ccac82ea
Branches Tags
godot-docs
/
classes
/
class_funcref.rst

class_funcref.rst 2.6 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the FuncRef.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_FuncRef:
    6. 

  6. 

  7. FuncRef
    8. 

  8. =======
    9. 

  9. 

  10. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Reference to a function in an object.
    18. 

  18. 

  19. Methods
    20. 

  20. -------
    21. 

  21. 

  22. +-------------------------------+---------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`Variant<class_Variant>` | :ref:`call_func<class_FuncRef_method_call_func>` **(** **)** vararg                                     |
    24. 

  24. +-------------------------------+---------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                          | :ref:`set_function<class_FuncRef_method_set_function>` **(** :ref:`String<class_String>` name **)**     |
    26. 

  26. +-------------------------------+---------------------------------------------------------------------------------------------------------+
    27. 

  27. | void                          | :ref:`set_instance<class_FuncRef_method_set_instance>` **(** :ref:`Object<class_Object>` instance **)** |
    28. 

  28. +-------------------------------+---------------------------------------------------------------------------------------------------------+
    29. 

  29. 

  30. Description
    31. 

  31. -----------
    32. 

  32. 

  33. 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.
    34. 

  34. 

  35. 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.
    36. 

  36. 

  37. Method Descriptions
    38. 

  38. -------------------
    39. 

  39. 

  40. .. _class_FuncRef_method_call_func:
    41. 

  41. 

  42. - :ref:`Variant<class_Variant>` **call_func** **(** **)** vararg
    43. 

  43. 

  44. Calls the referenced function previously set by :ref:`set_function<class_FuncRef_method_set_function>` or :ref:`@GDScript.funcref<class_@GDScript_method_funcref>`.
    45. 

  45. 

  46. .. _class_FuncRef_method_set_function:
    47. 

  47. 

  48. - void **set_function** **(** :ref:`String<class_String>` name **)**
    49. 

  49. 

  50. The name of the referenced function to call on the object, without parentheses or any parameters.
    51. 

  51. 

  52. .. _class_FuncRef_method_set_instance:
    53. 

  53. 

  54. - void **set_instance** **(** :ref:`Object<class_Object>` instance **)**
    55. 

  55. 

  56. 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>`.
    57. 

  57.