Browse Source

Add an enum naming guideline to the GDScript style guide

This partially addresses #1736.
Hugo Locurcio 5 years ago
parent
commit
f3aaa480e2
1 changed files with 17 additions and 4 deletions
  1. 17 4
      getting_started/scripting/gdscript/gdscript_styleguide.rst

+ 17 - 4
getting_started/scripting/gdscript/gdscript_styleguide.rst

@@ -242,11 +242,24 @@ Use past tense:
     signal door_opened
     signal door_opened
     signal score_changed
     signal score_changed
 
 
-Constants
-~~~~~~~~~
+Constants and enums
+~~~~~~~~~~~~~~~~~~~
 
 
-Use CONSTANT\_CASE, all caps, with an underscore (\_) to separate words:
-``const MAX_SPEED = 200``
+Use CONSTANT\_CASE, all caps, with an underscore (\_) to separate words.
+
+Enum *names* (if any) should use PascalCase, but their *values* should be in
+CONSTANT\_CASE.
+
+::
+
+    const MAX_SPEED = 200
+
+    enum Element {
+        EARTH,
+        WATER,
+        AIR,
+        FIRE,
+    }
 
 
 Static typing
 Static typing
 -------------
 -------------