-
-
Notifications
You must be signed in to change notification settings - Fork 21.2k
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
Clarify port/slot distinction and add method to get slot idx from port idx in GraphNode #40043
Conversation
Clarified distinction between ports and slots in GraphEdit class documentation, and added method to convert a port index to its corresponding slot index.
2b87cb4
to
3eb11d4
Compare
In Visual Script one of the terms means the entire left and right connectors. The other one is the "sequence" connectors and the function parameter connectors. To get the proper function parameter connectors you need to subtract the sequence connectors. Hopefully that gives flavour to your documentation. |
@fire Should that information go into the |
I would like to leave a 'port' term everywhere and remove 'slot' entirely (I don't much like this word since only one letter divided it from one vulgar word) |
I'd like to have |
Can you write a proposal what to rename it to? I don't think removing the term is proper. I like @umarcor 's proposal, I tried to find how the ISO standard defines graphical node line graphical language, so it matches the terms. However, it was difficult, and I couldn't find it. |
@fire, note that I am currently trying to prototype an schematic editor for structural HDL designs (see umarcor.github.io/hwstudio and godotengine/godot-proposals#1401). Hence, my proposal is very biased. I'd like to hear other users describe use cases where it might not fit, before making a stronger proposition. |
A lot of time has passed, but it would be good to revisit this and try to reach a consensus on the terminology. CC @godotengine/gui-nodes |
We took a look in the PR review meeting today. This needs a more in-depth review from knowledgeable contributors cc @fire @Chaosus @YuriSizov |
To add to that, we should resolve this for 4.0, because it can end up compatibility breaking and that would be very annoying to keep for another major release cycle. |
Thanks for your contribution! I went ahead and remade the PR against the current master and update it to better fit Godot's engine design. Your work has been credited as a co-author! Superseded by #65574. |
The
GraphEdit
class documentation uses the termsport
andslot
interchangeably to refer only to slots that are enabled,whereas the
GraphNode
class documentation usesslot
to refer to any slot, regardless of whether it is enabled or not.This PR clarifies the distinction between ports and slots in the
GraphEdit
class documentation, and updates the relevantsignal descriptions accordingly.
It also adds a method to convert a port/connection index to its corresponding slot index on the
GraphNode
.Closes #37227