W3cubDocs

/Godot 3.0

FuncRef

Inherits: Reference < Object

Category: Core

Brief Description

Reference to a function in an object.

Member Functions

Variant call_func ( ) vararg
void set_function ( String name )
void set_instance ( 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 @GDScript.funcref function, a reference to a function in a given object can be created, passed around and called.

Member Function Description

Variant call_func ( ) vararg

Calls the referenced function previously set by set_function or @GDScript.funcref.

void set_function ( String name )

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

void set_instance ( Object instance )

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.

© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.0/classes/class_funcref.html