-
-
Notifications
You must be signed in to change notification settings - Fork 22.8k
Add example of using get_connection_list_from_node
#108056
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.
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
Add example of using get_connection_list_from_node
#108056
Conversation
get_connection_list_from_node
a6e45f4
to
b44bd26
Compare
b44bd26
to
ab3df22
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is assuming the example itself is correct.
One weird thing is where the example is located. It can't really belong anywhere else except this description because get_connection_list_from_node
is required, but this method is really just used as an intermediary to create a method that doesn't exist in GraphEdit's API.
@@ -223,6 +223,25 @@ | |||
keep_alive: bool | |||
} | |||
[/codeblock] | |||
[b]Example:[/b] Get all connections on a specific port: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe? Due of how out-of-place it feels.
[b]Example:[/b] Get all connections on a specific port: | |
This method can also be used to get all connections on a specific port: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just an auxiliary example that describes one of the ways to use the method, but at the same time it is a solution for many GraphEdit users on how to implement the search for the desired connection.
I think simply indicating that this is an example is enough.
ab3df22
to
8f51c22
Compare
PR is essentially ready |
All in due time. It's a fine Sunday today. |
Thanks! |
Adds a useful example to the documentation for getting all connections to a specific port in GraphEdit.
Initially, the get_connection_list_from_node function was planned as a method that should get a list of connections to a specific port, but due to the generalization of this method for wider use, it is not easy for beginners to understand how to do this, which is what I encountered and godot-proposals/issues/12207