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

FiguraMC:Contributing/Style Guide: Difference between revisions

From FiguraMC
No edit summary
m bunny, that was a subtle suggestion
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Types =
{{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:
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
|-
| [[#method]]
| description
|-
| [[ModelPart/getPos|getPos]]
| 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}}
|}
=== -- 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:
Each method in the table should link to the section more in-depth explaining it.
=== -- START EXAMPLE -- ===
== Methods ==
=== Category ===
==== methodName ====
Description
<syntaxHighlight lang="lua">
-- Example Code
</syntaxHighlight>
=== Category ===
==== methodName ====
Description
<syntaxHighlight lang="lua">
-- Example Code
</syntaxHighlight>
=== -- END EXAMPLE -- ===

Latest revision as of 21:44, 9 October 2024

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

General Guidelines

  • Avoid writing in the first/second 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

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

Each method in the table should link to the section more in-depth explaining it.