Script structure

shIxx

Hello everyone,

I am new to Godot and as my learning project gets bigger and bigger the question arises what kind of convention there is in the script structure or better said how is the "correct" structure?

So far I've always done it like this:

# inherits
extends xy

# variables
export var xy
var xy
....
....

# funcions
func xy():
....
....

# ready
func _ready():

# signals 
func _on_xy_body_entered():
....
.....

# process
func _process():
func _physics_process(delta):

xyz

Each script file represents a class definition. All functions are class methods and all variables, constants and enums declared outside functions are class properties. Order of function or property definition doesn't matter at all. You can even have properties inbetween two methods etc. The only mandatory positions are "extends" declaration and "tool" keyword, which must stand at the beginning. Even class_name can be declared anywhere in the script. So you can order things in any way you see fit.

That said, there are stylistic conventions that Godot recommends. They are covered in style guide section in Godot docs (eps. Code Order sub-section).

shIxx

Thank you