Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-22 04:06:14 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #42369 from Rubonnek/document-funcref-get-function

Browse Source 
Make "function" a property of FuncRef
This commit is contained in:
Rémi Verschelde 2020-09-30 13:34:52 +02:00 committed by GitHub
commit 3c441baf6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
core/func_ref.cpp
View File

@ -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("call_funcv", "arg_array"), &FuncRef::call_funcv);
ClassDB::bind_method(D_METHOD("set_instance", "instance"), &FuncRef::set_instance); 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("set_function", "name"), &FuncRef::set_function);
ClassDB::bind_method(D_METHOD("get_function"), &FuncRef::get_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");
} }

32
doc/classes/FuncRef.xml
View File

@ -14,7 +14,7 @@
<return type="Variant"> <return type="Variant">
</return> </return>
<description> <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> </description>
</method> </method>
<method name="call_funcv"> <method name="call_funcv">
@ -23,23 +23,7 @@
<argument index="0" name="arg_array" type="Array"> <argument index="0" name="arg_array" type="Array">
</argument> </argument>
<description> <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">
<return type="void">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<description>
The name of the referenced function to call on the object, without parentheses or any parameters.
</description> </description>
</method> </method>
<method name="set_instance"> <method name="set_instance">
@ -51,7 +35,19 @@
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]. 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> </description>
</method> </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>
</methods> </methods>
<members>
<member name="function" type="StringName" setter="set_function" getter="get_function">
The name of the referenced function.
</member>
</members>
<constants> <constants>
</constants> </constants>
</class> </class>