Latest revision as of 21:44, 9 October 2024

General Guidelines

Avoid writing in the first/second person
- Only write in the second person in tutorials
- Avoid using personal pronouns
- See Grammatical person
Properly capitalize wikilinks where it makes sense

Types

When creating a type page, please use the following layout:

From TypeExample (edit)

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

@@ Line 1: / Line 1: @@
 {{Stub}}
+== General Guidelines ==
+* Avoid writing in the first/second person
+** Only write in the second person in tutorials
+** Avoid using [[wikipedia:English personal pronouns|personal pronouns]]
+** See [[wikipedia:Grammatical person|Grammatical person]]
+* Properly capitalize wikilinks where it makes sense
 == Types ==
 When creating a type page, please use the following layout:
-=== -- START EXAMPLE -- ===
+{{VeryObviouslyTranscluded/2|FiguraMC:Contributing/Style Guide/TypeExample|TypeExample}}
-== Methods ==
-{| class="wikitable"
-|-
-! Method
-! Brief description
-|-
-| [[#methodName|methodName]]
-| description
-|-
-| [[#secondCategoryMethod|secondCategoryMethod]]
-| Returns the position of the ModelPart as a {{type|Vector3}}
-|}
-== Fields ==
-{| class="wikitable"
-|-
-! Field
-! Description
-! Type
-|-
-| [[Type/Field|field]]
-| Brief description
-| {{type|type}}
-|-
-| [[Events/TICK|TICK]]
-| Runs every tick the player is rendered
-| {{type|Event}}
-|}
-== Methods ==
-=== Category ===
-==== methodName ====
-Overloads:
-{| class="wikitable"
-|-
-! Arguments
-! Return Type
-|-
-| pos {{Type|Vector3}}, name {{Type|string?}}
-| {{Type|nil}}
-|-
-| x {{Type|number}}, y {{Type|number}}, z {{Type|number}}, name {{Type|string?}}
-| {{Type|nil}}
-|}
-Description
-<syntaxHighlight lang="lua">
--- Example Code
-</syntaxHighlight>
-=== Category ===
-==== secondCategoryMethod ====
-Description
-Overloads:
-{| class="wikitable"
-|-
-! Arguments
-! Return Type
-|-
-| rotation {{Type|Vector3}}}}
-| {{Type|nil}}
-|-
-| x {{Type|number}}, y {{Type|number}}, z {{Type|number}}
-| {{Type|nil}}
-|}
-<syntaxHighlight lang="lua">
--- Example Code
-</syntaxHighlight>
-=== -- END EXAMPLE -- ===
 Each method in the table should link to the section more in-depth explaining it.

Arguments	Return Type
pos Vector3, name string \| nil	nil
x number, y number, z number, name string \| nil	nil

Arguments	Return Type
rotation Vector3	nil
x number, y number, z number	nil