Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

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

From FiguraMC
PenguinEncounter (talk | contribs)
move example to subpage
Tag: 2017 source edit
 
m link to templates
 
(3 intermediate revisions by 2 users not shown)
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>{{</nowiki>[[Template:host only|host only]]<nowiki>}}</nowiki></code>, <code><nowiki>{{</nowiki>[[Template:Notice|Notice]]|...<nowiki>}}</nowiki></code>, or <code><nowiki>{{</nowiki>[[Template:Notice/Warning|Notice/Warning]]|...<nowiki>}}</nowiki></code>. For example:
{{host only|nocat=yes}}
(Important information about the type...)
(Important information about the type...)


Line 31: Line 39:
== Methods ==
== Methods ==
=== Category ===
=== Category ===
Brief description
==== methodName ====
==== methodName ====
----
Description
Overloads:
Overloads:
{| class="wikitable"
{| class="wikitable"
Line 49: Line 61:
</syntaxHighlight>
</syntaxHighlight>
=== Category ===
=== Category ===
Brief description
==== secondCategoryMethod ====
==== secondCategoryMethod ====
----
Description
Description
Overloads:
Overloads:
{| class="wikitable"
{| class="wikitable"
Line 57: Line 72:
! Return Type
! Return Type
|-
|-
| rotation {{Type|Vector3}}}}
| rotation {{Type|Vector3}}
| {{Type|nil}}
| {{Type|nil}}
|-
|-

Latest revision as of 21:50, 9 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