FiguraMC:Contributing/Style Guide/TypeExample: Difference between revisions

From FiguraMC
PenguinEncounter (talk | contribs)
move example to subpage
Tag: 2017 source edit
 
PenguinEncounter (talk | contribs)
No edit summary
Tag: 2017 source edit
Line 1: Line 1:
= Page title = <!-- this one's just so that the transclusion looks like a full page -->
(Don't add an additional level-1 heading for the page title.)
If necessary, use <code><nowiki>{{host only}}</nowiki></code>, <code><nowiki>{{Notice|...}}</nowiki></code>, or <code><nowiki>{{Notice/Warning|...}}</nowiki></code>. For example:
{{host only|nocat=yes}}
(Important information about the type...)
(Important information about the type...)



Revision as of 06:00, 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

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