How to read the documentation

How to read the documentation

Text pertaining to code is formatted like this.

Enumerations

Enumeration values are formatted as the type they are implemented as (Eg. 'strings'). For example:

Error codes

• int(OK) = 0
• int(NOMEM) = 1
• int(OTHER) = 2

Classes and Objects

Classes are referenced by their name followed by a code-friendly typename formatted in an inline code-block. For example:

Vector3 vector3

Functions

Functions are listed without parenthesis if they take no parameters (not including the implicit self argument). Otherwise parameters are listed in parenthesis next to the function name with their descriptions placed below the function description. Parameter types are described by placing the parameter name within a set of parenthesis placed after the typename. Default values are specified after the name followed by the assignment operator (=). If the function returns a value then an inline code-block will be present showcasing the type of the value returned. Return values have no name associated with them in descriptions. For example:

erf(x)

Returns the error function of the specified value.

• float(x): The value to compute the error function of.
• return float: The error function of the specified value.