FiguraMC:Contributing/Style Guide: Difference between revisions
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
! Brief description | ! Brief description | ||
|- | |- | ||
| [[ | | [[#method]] | ||
| description | | description | ||
|- | |- | ||
| Line 19: | Line 19: | ||
|- | |- | ||
! Field | ! Field | ||
! Description | |||
! Type | ! Type | ||
|- | |- | ||
| [[Type/Field|field]] | | [[Type/Field|field]] | ||
| Brief description | |||
| {{type|type}} | | {{type|type}} | ||
|- | |- | ||
| [[Events/TICK|TICK]] | | [[Events/TICK|TICK]] | ||
| Runs every tick the player is rendered | |||
| {{type|Event}} | | {{type|Event}} | ||
|} | |} | ||
| Line 30: | Line 33: | ||
Each field/method should link to a subpage for that field/method | Each field/method should link to a subpage for that field/method | ||
OR, for more complex things like [[ModelPart]], you should do as follows: | |||
=== -- START EXAMPLE -- === | |||
== Methods == | |||
=== Category === | |||
==== methodName ==== | |||
Description | |||
<syntaxHighlight lang="lua"> | |||
-- Example Code | |||
</syntaxHighlight> | |||
=== Category === | |||
==== methodName ==== | |||
Description | |||
<syntaxHighlight lang="lua"> | |||
-- Example Code | |||
</syntaxHighlight> | |||
=== -- END EXAMPLE -- === | |||
Revision as of 03:53, 5 October 2024
Types
When creating a type page, please use the following layout:
-- START EXAMPLE --
Methods
| Method | Brief description |
|---|---|
| #method | description |
| getPos | 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 |
-- END EXAMPLE --
Each field/method should link to a subpage for that field/method
OR, for more complex things like ModelPart, you should do as follows:
-- START EXAMPLE --
Methods
Category
methodName
Description
-- Example Code
Category
methodName
Description
-- Example Code