FiguraMC:Contributing/Style Guide/TypeExample: Difference between revisions
No edit summary Tag: 2017 source edit |
m fix formatting and add category descriptions as well as lines |
||
| Line 39: | Line 39: | ||
== Methods == | == Methods == | ||
=== Category === | === Category === | ||
Brief description | |||
==== methodName ==== | ==== methodName ==== | ||
---- | |||
Description | |||
Overloads: | Overloads: | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 57: | Line 61: | ||
</syntaxHighlight> | </syntaxHighlight> | ||
=== Category === | === Category === | ||
Brief description | |||
==== secondCategoryMethod ==== | ==== secondCategoryMethod ==== | ||
---- | |||
Description | Description | ||
Overloads: | Overloads: | ||
{| class="wikitable" | {| class="wikitable" | ||
Revision as of 19:55, 5 October 2024
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