Godot 4.2 Custom Signals for beginners - Intended for Godot Manual

Hi!

I struggled reading the Godot Manual’s Custom Signals page for a month at least, visiting it many times per week. The information there and in the tutorials is SO scattered all over the place in my opinion! I failed all the time to make my signal work in my game.

And only now I feel I understand Custom Signals through and through. I think they can be super easily communicated. So I made this quick tuto:
My Custom Signal Quick Tutorial

I’m hoping this would be included in the Manual page here, into the ‘Tutorials’ section:
Godot Manual: Signal Page

How to make that happen?
Can somebody make it in Sphinx format and submit as Pull Request for the Manual? I rather not start with installing make and all…

Thank you!
Manu

4 Likes

Okay, I learned how to make a pull request (draft, for starters):

2 Likes

Hey,

Just so your entry is clearer, could you rephrase the following?

degrees_sent_ and degrees_received (first argument) don’t need to have the same name

Because when you say “name” I’m unsure if you’re talking about the value, or something else. “Name” is very generic. This is also the case for the line following the above.

Your post makes things clearer.

Thank you.

PS: Also just noticed a typo:

_on_trigger_p~~ress

That’s in yellow_gate.gd. Specifically in:

%RedButtonArea3D.trigger.connect(_on_trigger_p~~ress)

Actually, long time ago already, I made a fix and removed all of that text. I think it made the example more complex so it needed to be removed.

1 Like

Oh, okay.

Thanks. I’ll check it out.

Wait… Is there supposed to be a stashpad page for that modification? I can’t see one. Maybe I’m blind. :sweat_smile:

About the typo, I can’t find it… what are you indicating with the ~ waves?

Ah, I ditched the stashpad one and made the official pull request

Ah! I see. Stashpad indeed may be going some changes as it’s very new. Maybe it’s not that good for code sharing yet :sweat_smile: :sweat_smile:

lol it’s fine.

So, if I want to read your take on the doc for signals, where should I go to read the full text entry?

Thanks btw, there’s a real need to clean that up.

Well, I can give you the raw .rst version if you want:

But a built .html page (a image screenshot) is easier to understand:

I’m actually quite pleased you’ve shown interest on this, you’re pretty much the first one.

So you agree this page should be in the manual as an example?

I almost lost interest in pushing this forward.

I need some energy to make it so that it would be included in the manual eventually.

Oh, now I get it :sweat_smile: I am not doing a full rewrite of Signals page (I’d be never allowed to do that for sure, it’s for technical people)

I’m just wanting a small link to be in there into this very concise and simple example of how to use signals.

My problem with the official docs of the Signal is that it takes a previous example and builds from there where people (most I’d say) only want a quick and easily understandable outline of how they work and how they can be implemented. THEN, from that, flesh out a simple example. But that’s not what they’re doing.

All the example did for me, was confused me and push me away. So, I end up skimming over the example, sometimes skipping important info, which can be a problem. So I have to double back and reread it and… then I give up because there’s no simplicity here and it should be simple.

Anyway, that’s my take on this and from what I have seen, your example seems to bring me closer to the signal concept and how to best use it. But honestly, I haven’t had the time to play with it much and at this point I don’t have any signal “working” because I haven’t has much time to play with them.

Yes, I’m with you. The signal page is overly complicated. Too bad I can only propose to add a link to my Concise Example page into the Signal page’s Tutorial section… :confused: If they accept even that kind of change…

Here’s to hoping… :crossed_fingers:

Btw, there’s some talks about this in here also:

If you want to chime in.
This forum post is not going to change much, but those official GitHub Pull Requests have a chance.

I’ll try to check this out when I have some time.

Thanks for the link.