GDScript Style Guide

[ac-arcana]

I notice some little things in the scripts that aren't quite to the style guide. https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html

I'm not sure how much we care lol. For example, class names are often put after extends, but the style guide puts them before.

I also think we could make more use of code regions.

Can we have a candid discussion about style for the project? Even if the result is anything goes lol

[Phazorknight]

Yeah, I've only seen the style guide way after I've started work on COGITO.
I'm fully on board with keeping to it as much as possible.
Also as I am coming from Unity/C# I realize quite a few of my naming conventions are probably all over the place

I'm all for unifying and cleaning up the scripts and will try to do so as I go, but it's currently more of a side-task than a priority.

[ac-arcana]

Also as I am coming from Unity/C# I realize quite a few of my naming conventions are probably all over the place

I'm also a recent convert! I had spent probably thousands on assets on the Unity Asset Store, but when Unity pulled the scummy backwards changes to their monetization (which they back pedaled on now), I like many, thought it would be best to find something that can't ever make scummy moves like that. Godot has gotten a lot more mature in the past while.

I'm all for unifying and cleaning up the scripts and will try to do so as I go, but it's currently more of a side-task than a priority.

Then when I'm making commits I wont be afraid to add little style guide changes here and there :)

[brian-holsters]

Then when I'm making commits I wont be afraid to add little style guide changes here and there :)

Just be sure to only make changes to stuff you are working on in the PR if it's not a pure style PR as a general git good practice, reviewing a PR that should do one thing but modifies files that have nothing to do with the affected functionality can be quite bothersome.

[ksjfhor]

I think this is very valuable, but real talk: I do not care about any or none spaces on clamps, as long as there are not like 6 together, lol.

One thing that is not very clear are the typed var hints, which can/will affect performance.
Also in Godot 3.x they could be NULL, but not anymore in GD Script 4.

I would never write it that way:
@onready var health_bar := get_node("UI/LifeBar") as ProgressBar
I would rather go with:
@onready var health_bar: ProgressBar = get_node("UI/LifeBar")
Because thats more readable for me, myself and I.

But that is something where someone has the make the decision, which way is the way to go.

Maybe you could install a template for pullrequests and one for issues ?
See here how godot handles issues.

I guess most people can agree with the declaration on top, which should be inside a code region, then the inbuild-classes and then the selfwritten-classes.
Imho more or less code regions are depending on the personal style, e.g. I use code region on declaration and to group classes together, like the detection region, which contain all the functions that are used for any detection, so when I am done with it, I collapse the region.

[ac-arcana]

For me if bool: and if not bool:

The style guide actually asks you to use and, or, not instead of &&, ||, !

[ksjfhor]

The style guide actually asks you to use and, or, not instead of &&, ||, !

Yes, that is true. Why did you come up with that ? Because of the == ?
AFAIK godot has no equal.

[ac-arcana]

I'm just so used to using &&, ||, and ! from other languages. Phasorknight is too, I see a lot of ! conditionals.

[ksjfhor]

Ah okay, yeah it happens that you stick to a habit ;-)
Sometimes I still go and make bool != bool and then I wonder why it is not toggeling, until I see in the Inspector "this line does nothing", but one day I will change my mind xD

[Phazorknight]

onready var health_bar: ProgressBar = get_node("UI/LifeBar")

I vastly prefer this and would want to stick to this.
IMHO explicit typing improves readability quite a bit.

I have to admit that I was quite lazy with explicit typing within function declarations, but I'm slowly trying to update those as I encounter them to have all of those explicitly typed as well.

The style guide actually asks you to use and, or, not instead of &&, ||, !

I'm happy to use Godot's verbal operators (and/or), but for some reason the ! one is just very intuitive for me, so that's why you see that one a lot.

Regions might depend on the script.

My two cents on regions is that I personally actually never use them, because if they get collapsed, my eyes don't register them and I feel like code is missing in the script. 😅

Maybe you could install a template for issues?

I just added a slightly modified default template for issues. So far every contributor has been great with how they flag stuff and the PR request have been fine as well. I currently don't see myself starting to overly police these two, but instead will give feedback in comments etc.