Skip to content

Update object_class.rst , updating connect()'s code sample and relevant explanation #11341

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Update object_class.rst , updating connect()'s code sample and relevant explanation #11341

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a4a3743
Update object_class.rst
Paperomo Oct 4, 2025
4a6177b
Update object_class.rst
Paperomo Oct 5, 2025
a054108
Update engine_details/architecture/object_class.rst
Paperomo Oct 6, 2025
602fd37
Update engine_details/architecture/object_class.rst
Paperomo Oct 6, 2025
545d4b2
Update engine_details/architecture/object_class.rst
Paperomo Oct 6, 2025
3657416
Apply suggestions from code review
Calinou Oct 6, 2025
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
15 changes: 9 additions & 6 deletions engine_details/architecture/object_class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,12 +227,15 @@ languages). This example shows how to connect to them:

.. code-block:: cpp

obj->connect(<signal>, target_instance, target_method)
// for example:
obj->connect("enter_tree", this, "_node_entered_tree")

The method ``_node_entered_tree`` must be registered to the class using
``ClassDB::bind_method`` (explained before).
// This is the function signature:
//
// Error connect(const StringName &p_signal, const Callable &p_callable, uint32_t p_flags = 0)
//
// For example:
obj->connect("signal_name_here", callable_mp(this, &MyCustomType::method), CONNECT_DEFERRED);

``callable_mp`` is a macro to create a custom callable function pointer to member functions.
For the values of ``p_flags``, see :ref:`ConnectFlags <enum_Object_ConnectFlags>`.

Adding signals to a class is done in ``_bind_methods``, using the
``ADD_SIGNAL`` macro, for example:
Expand Down
Loading