Document how struct "constants" aren't really constants in C#

This commit is contained in:
Aaron Franke
2020-10-06 15:04:53 -04:00
parent 252d430a06
commit 1430ddfff5

View File

@@ -21,7 +21,12 @@ Most global constants were moved to their own enums.
Constants
^^^^^^^^^
Global constants were moved to their own enums.
In C#, only primitive types can be constant. For example, the ``TAU`` constant
is replaced by the ``Mathf.Tau`` constant, but the ``Vector2.RIGHT`` constant
is replaced by the ``Vector2.Right`` read-only property. This behaves similarly
to a constant, but can't be used in some contexts like ``switch`` statements.
Global enum constants were moved to their own enums.
For example, ``ERR_*`` constants were moved to the ``Error`` enum.
Special cases: