FiguraMC:Contributing/Style Guide: Difference between revisions

From FiguraMC
No edit summary
Line 23: Line 23:
! Type
! Type
|-
|-
| [[Type/Field|field]]
| Type/Field|field
| Brief description
| Brief description
| {{type|type}}
| {{type|type}}
|-
|-
| [[Events/TICK|TICK]]
| Events/TICK|TICK
| Runs every tick the player is rendered
| Runs every tick the player is rendered
| {{type|Event}}
| {{type|Event}}

Revision as of 04:06, 5 October 2024

This page is a stub. You can help this wiki by expanding it

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.