Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add GDScript naming convention summary table #10295

Merged
merged 1 commit into from
Nov 21, 2024
Merged

Add GDScript naming convention summary table #10295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion tutorials/scripting/gdscript/gdscript_styleguide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,29 @@ Naming conventions

These naming conventions follow the Godot Engine style. Breaking these will make
your code clash with the built-in naming conventions, leading to inconsistent
code.
code. As a summary table:

+---------------+----------------+----------------------------------------------------+
| Type | Convention | Example |
+===============+================+====================================================+
| File names | snake_case | ``yaml_parser.gd`` |
+---------------+----------------+----------------------------------------------------+
| Class names | PascalCase | ``class_name YAMLParser`` |
+---------------+----------------+----------------------------------------------------+
| Node names | PascalCase | ``Camera3D``, ``Player`` |
+---------------+----------------+----------------------------------------------------+
| Functions | snake_case | ``func load_level():`` |
+---------------+----------------+----------------------------------------------------+
| Variables | snake_case | ``var particle_effect`` |
+---------------+----------------+----------------------------------------------------+
| Signals | snake_case | ``signal door_opened`` |
+---------------+----------------+----------------------------------------------------+
| Constants | CONSTANT_CASE | ``const MAX_SPEED = 200`` |
+---------------+----------------+----------------------------------------------------+
| Enum names | PascalCase | ``enum Element`` |
+---------------+----------------+----------------------------------------------------+
| Enum members | CONSTANT_CASE | ``{EARTH, WATER, AIR, FIRE}`` |
+---------------+----------------+----------------------------------------------------+

File names
~~~~~~~~~~
Expand Down