SYNTAX.md

Project's Syntax Ruleset

This file contains all the rules that are to be followed when contributing to the project. Please note that the following list isn't exclusive, meaning that it might miss some cases that are left for personal preference. It will likely be updated in the future as time goes on.

For any doubts, please make sure to contact other developers at our Discord.

Class names:

Will always use "Pascal Case".

public class ClassName

Class names working as files:

Will always end with "File" in the name.

public class ClassNameFile

Class names working as packets:

Will always end with "Data" in the name.

public class ClassNameData

Class variables:

Will always use "cammel Case".

public string variableName

Interface names:

Will always start with "I" followed by "Pascal Case".

public interface IName

Constant variables:

Will always use "full caps".

public const CONSTANTVARIABLE

Packet specific variables that are sent through the network:

Will always use starting underscore followed by "cammel Case".

public int _variableName

File specific variables that can be edited by players:

Will always use "Pascal Case".

public float VariableName

Functions that explicitly set values:

Will always use "Pascal Case" and start with "Set" followed by an identified of the value.

public void SetExampleDouble()

Functions that explicitly return values:

Will always use "Pascal Case" and start with "Get" followed by an identifier of the value.

public double GetExampleDouble()