FiguraMC:Contributing/Style Guide: Difference between revisions

From FiguraMC
No edit summary
No edit summary
Line 9: Line 9:
! Brief description
! Brief description
|-
|-
| [[#method]]
| [[#methodName|method]]
| description
| description
|-
|-
Line 30: Line 30:
| {{type|Event}}
| {{type|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 ==
== Methods ==
=== Category ===
=== Category ===
Line 50: Line 45:
</syntaxHighlight>
</syntaxHighlight>
=== -- END EXAMPLE -- ===
=== -- END EXAMPLE -- ===
Each field/method should link to a subpage for that field/method

Revision as of 03:54, 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

Methods

Category

methodName

Description

-- Example Code

Category

methodName

Description

-- Example Code

-- END EXAMPLE --

Each field/method should link to a subpage for that field/method