FiguraMC:Contributing/Style Guide
This page is a stub. You can help this wiki by expanding it
Types
When creating a type page, please use the following layout:
From TypeExample (edit)
Page title
(Don't add an additional level-1 heading for the page title.)
If necessary, use {{host only}}, {{Notice|...}}, or {{Notice/Warning|...}}. For example:
This API is only available on the host.
For more information, see Pings.
(Important information about the type...)
Methods
| Method | Brief description |
|---|---|
| methodName | description |
| secondCategoryMethod | Returns the position of the ModelPart as a Vector3 |
Fields
| Field | Description | Type |
|---|---|---|
| field | Brief description | type |
| TICK | Runs every tick the player is rendered | Event |
Methods
Category
Brief description
methodName
Description
Overloads:
| Arguments | Return Type |
|---|---|
| pos Vector3, name string | nil | nil |
| x number, y number, z number, name string | nil | nil |
Description
-- Example Code
Category
Brief description
secondCategoryMethod
Description
Overloads:
| Arguments | Return Type |
|---|---|
| rotation Vector3 | nil |
| x number, y number, z number | nil |
-- Example Code
Each method in the table should link to the section more in-depth explaining it.