godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10295 from tetrapod00/gdscript-summary

Browse Source 
Add GDScript naming convention summary table
This commit is contained in:
Max Hilbrunner
2024-11-21 03:22:13 +01:00
committed by GitHub
parent b82187d22c c1310e6009
commit 5b15d190e9
1 changed files with 23 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
tutorials/scripting/gdscript/gdscript_styleguide.rst
View File

@@ -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
~~~~~~~~~~