FiguraMC:Contributing/Style Guide: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
= Types = | == Types == | ||
When creating a type page, please use the following layout: | When creating a type page, please use the following layout: | ||
| Line 9: | Line 9: | ||
! Brief description | ! Brief description | ||
|- | |- | ||
| [[#methodName| | | [[#methodName|methodName]] | ||
| description | | description | ||
|- | |- | ||
| [[ | | [[#secondCategoryMethod|secondCategoryMethod]] | ||
| Returns the position of the ModelPart as a {{type|Vector3}} | | Returns the position of the ModelPart as a {{type|Vector3}} | ||
|} | |} | ||
| Line 34: | Line 34: | ||
=== Category === | === Category === | ||
==== methodName ==== | ==== methodName ==== | ||
Overloads: | |||
{| class="wikitable" | |||
|- | |||
! Arguments | |||
! Return Type | |||
|- | |||
| pos {{Type|Vector3}}, name {{Type|string?}} | |||
| {{Type|nil}} | |||
|- | |||
| x {{Type|number}}, y {{Type|number}}, z {{Type|number}}, name {{Type|string?}} | |||
| {{Type|nil}} | |||
|} | |||
Description | Description | ||
<syntaxHighlight lang="lua"> | <syntaxHighlight lang="lua"> | ||
| Line 39: | Line 51: | ||
</syntaxHighlight> | </syntaxHighlight> | ||
=== Category === | === Category === | ||
==== | ==== secondCategoryMethod ==== | ||
Description | Description | ||
Overloads: | |||
{| class="wikitable" | |||
|- | |||
! Arguments | |||
! Return Type | |||
|- | |||
| rotation {{Type|Vector3}}}} | |||
| {{Type|nil}} | |||
|- | |||
| x {{Type|number}}, y {{Type|number}}, z {{Type|number}} | |||
| {{Type|nil}} | |||
|} | |||
<syntaxHighlight lang="lua"> | <syntaxHighlight lang="lua"> | ||
-- Example Code | -- Example Code | ||
| Line 46: | Line 70: | ||
=== -- END EXAMPLE -- === | === -- END EXAMPLE -- === | ||
Each | Each method in the table should link to the section more in-depth explaining it. | ||
Revision as of 04:00, 5 October 2024
Types
When creating a type page, please use the following layout:
-- START EXAMPLE --
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
methodName
Overloads:
| Arguments | Return Type |
|---|---|
| pos Vector3, name string | nil | nil |
| x number, y number, z number, name string | nil | nil |
Description
-- Example Code
Category
secondCategoryMethod
Description Overloads:
| Arguments | Return Type |
|---|---|
| rotation Vector3}} | nil |
| x number, y number, z number | nil |
-- Example Code
-- END EXAMPLE --
Each method in the table should link to the section more in-depth explaining it.