diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-09-30 13:34:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-30 13:34:52 +0200 |
| commit | 3c441baf6c11de564ee723fa8731ce40a0052fd9 (patch) | |
| tree | 3e1b51667b5694e6f190577091624cd7442b3b83 | |
| parent | 39a93c007d0e35bad768ac171b41ea583454bb90 (diff) | |
| parent | b4e7edabf351753878098cbfc518c9f8074ec70f (diff) | |
Merge pull request #42369 from Rubonnek/document-funcref-get-function
Make "function" a property of FuncRef
| -rw-r--r-- | core/func_ref.cpp | 5 | ||||
| -rw-r--r-- | doc/classes/FuncRef.xml | 30 |
2 files changed, 17 insertions, 18 deletions
diff --git a/core/func_ref.cpp b/core/func_ref.cpp index 893f7f9103..7e062f16d0 100644 --- a/core/func_ref.cpp +++ b/core/func_ref.cpp @@ -92,7 +92,10 @@ void FuncRef::_bind_methods() { ClassDB::bind_method(D_METHOD("call_funcv", "arg_array"), &FuncRef::call_funcv); ClassDB::bind_method(D_METHOD("set_instance", "instance"), &FuncRef::set_instance); + ClassDB::bind_method(D_METHOD("is_valid"), &FuncRef::is_valid); + ClassDB::bind_method(D_METHOD("set_function", "name"), &FuncRef::set_function); ClassDB::bind_method(D_METHOD("get_function"), &FuncRef::get_function); - ClassDB::bind_method(D_METHOD("is_valid"), &FuncRef::is_valid); + + ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "function"), "set_function", "get_function"); } 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> |