Displaying documentation in Event Sheet functions

Please make sure to follow the forum’s rules before posting.
:x: Posts that do not follow the rules will be ignored, closed and archived.

Could it be possible to have documentation on a precise function when you click with right button on a GD function? (see below when the menu showed could be completed with the word “Documentation”)

A reference to the documentation concerning this function would then be made by selecting “Documentation”, by referring to the GD online documentation.

Thanks for considering my proposal.

A+
Xierra

PS: i know it would be a lot of work for the team to create all the documentation links for existing GD features.
I don’t know if it’s really possible to create these links but I think it would be a big plus for GD.

2 Likes

When you focus on the expression CursorX() here, the auto-completion opens and tells you in detail what it is.

Documentation exists for it, but it is strictly identical, not sure the interest of a link is useful. And we can’t give a link to it, think of the case where there is multiple expression in the same feild.
https://wiki.gdevelop.io/gdevelop5/all-features/mouse-touch/reference/#conditions

2 Likes

Hello @Bouh

Yes, I understand well but it’s not quite the same usage.
What you are talking about occurs when the instruction is entered, therefore during editing time.

But you are probably right: just copy the instruction to the clipboard then look in the GDevelop documentation.
Or modify the instruction so that auto-completion appears.
But it’s less instinctive and quick.

Thanks A.

A+
Xierra

In that case, I didn’t understand the proposal.
Does it concern the expression, as I mentioned, or the action line?


Par ailleurs, la traduction automatique en français modifie certains termes. Quand je dis qu’il faut « focus » l’expression, il n’est pas nécessaire de la mettre dans le presse-papiers ni de la copier : un simple clic pour placer le curseur dessus suffit à voir la doc comme sur l’image.

Yes, it concerns the expression and not the line.

It’s a bit like in IDEs intended for programming languages: you click on the name of the function then you type, for example, F1 and it takes you to the precise documentation on this function.

Xierra

1 Like