FiguraMC:Contributing/Style Guide/TypeExample - Revision history

PoolloverNathan: link to templates

2024-10-09T21:50:20Z

link to templates

← Older revision		Revision as of 21:50, 9 October 2024
Line 2:		Line 2:
	(Don't add an additional level-1 heading for the page title.)		(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:		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}}		{{host only\|nocat=yes}}

TheKillerBunny: fix typo

2024-10-09T21:09:50Z

fix typo

← Older revision		Revision as of 21:09, 9 October 2024
Line 72:		Line 72:
	! Return Type		! Return Type
	\|-		\|-
	\| rotation {{Type\|Vector3}}}}		\| rotation {{Type\|Vector3}}
	\| {{Type\|nil}}		\| {{Type\|nil}}
	\|-		\|-

TheKillerBunny: fix formatting and add category descriptions as well as lines

2024-10-05T19:55:30Z

fix formatting and add category descriptions as well as lines

← Older revision		Revision as of 19:55, 5 October 2024
Line 39:		Line 39:
	== Methods ==		== Methods ==
	=== Category ===		=== Category ===
			Brief description
	==== methodName ====		==== methodName ====
			----
			Description

	Overloads:		Overloads:
	{\| class="wikitable"		{\| class="wikitable"
Line 57:		Line 61:
	</syntaxHighlight>		</syntaxHighlight>
	=== Category ===		=== Category ===
			Brief description
	==== secondCategoryMethod ====		==== secondCategoryMethod ====
			----
	Description		Description

	Overloads:		Overloads:
	{\| class="wikitable"		{\| class="wikitable"

PenguinEncounter at 06:00, 5 October 2024

2024-10-05T06:00:18Z

← Older revision		Revision as of 06:00, 5 October 2024
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...)

PenguinEncounter: move example to subpage

2024-10-05T05:53:53Z

move example to subpage

New page

(Important information about the type...)

== 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
|-
| field
| Brief description
| {{type|type}}
|-
| 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>