godotengine / godotengine/godot-docs
CONNECT_REFERENCE_COUNTED/connect documentation does not give important information
- Dominant language
- reStructuredText
- Stars
- 5.7k
- Forks
- 3.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 25
Description
**Godot version:** v3.2.3.stable.official
**URL to the documentation page:** https://docs.godotengine.org/en/stable/classes/class_object.html (under `connect`)
It fails to indicate some things that resulted in great confusion as someone trying to learn godot. When using `CONNECT_REFERENCE_COUNTED`:
- The `binds` parameter in the `connect` function is only used in the first connection
- Even when using `CONNECT_REFERENCE_COUNTED`, it will only fire a target/method pair once
Further, the `connect` documentation claims that:
> It will throw an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED
However, this is not fully true: if you call `connect` the 2nd time with `CONNECT_REFERENCE_COUNTED`, it won't error, even if you did not use `CONNECT_REFERENCE_COUNTED` for the first connection.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.