Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix method bind instructions and style #8735

Merged
merged 2 commits into from
Jan 24, 2024
Merged

Fix method bind instructions and style #8735

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d9a61f
Fix method bind instructions and style
AThousandShips Jan 7, 2024
b0b01c6
Update contributing/development/core_and_modules/object_class.rst
mhilbrunner Jan 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions contributing/development/core_and_modules/object_class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,17 @@ Registering functions is one:

.. code-block:: cpp

ClassDB::bind_method(D_METHOD("methodname", "arg1name", "arg2name"), &MyCustomMethod);
ClassDB::bind_method(D_METHOD("methodname", "arg1name", "arg2name", "arg3name"), &MyCustomType::method);

Default values for arguments can be passed in reverse order:
Default values for arguments can be passed as parameters at the end:

.. code-block:: cpp

ClassDB::bind_method(D_METHOD("methodname", "arg1name", "arg2name"), &MyCustomType::method, DEFVAL(-1)); // default value for arg2name
ClassDB::bind_method(D_METHOD("methodname", "arg1name", "arg2name", "arg3name"), &MyCustomType::method, DEFVAL(-1), DEFVAL(-2)); // Default values for arg2name (-1) and arg3name (-2).

Default values must be provided in the same order as they are declared,
skipping requried arguments and then providing default values for the optional ones.
mhilbrunner marked this conversation as resolved.
Show resolved Hide resolved
This matches the syntax for declaring methods in C++.

``D_METHOD`` is a macro that converts "methodname" to a StringName for more
efficiency. Argument names are used for introspection, but when
Expand Down Expand Up @@ -142,7 +146,7 @@ For example:

PropertyInfo(Variant::INT, "amount", PROPERTY_HINT_RANGE, "0,49,1", PROPERTY_USAGE_EDITOR)

This is an integer property named "amount". The hint is a range, and the range
This is an integer property named "amount". The hint is a range, and the range
goes from 0 to 49 in steps of 1 (integers). It is only usable for the editor
(editing the value visually) but won't be serialized.

Expand Down