Template:Struct field

Template documentation[view] [edit] [history] [purge]

This is one of three helper templates for displaying struct fields on a data structure article. They are:

• {{Struct top}}
• {{Struct field}}
• {{Struct bottom}}

They must always be used together to build a full table.

Usage

{{Struct top}}
{{Struct field|offset|size|type|name|description}}
{{Struct field|offset|size|type|name|description}}
...
{{Struct bottom}}

Example

{{Struct top}}
{{Struct field|offset=0x1c|size=0x4|type=DifficultyLevel *|name=''Difficulty level''|description=Pointer to the current difficulty level}}
{{Struct bottom}}

Offset	Size	Type	Name	Description
0x1c	0x4	DifficultyLevel *	Difficulty level	Pointer to the current difficulty level

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Struct field

A template for rows in the {{tl|Struct}} template

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
offset	offset 1	Offset into the struct in bytes	Number	suggested
size	size 2	Size of the field in bytes	Number	suggested
type	type 3	The data type of the field Example int, float, etc.	String	suggested
name	name 4	The name of the field	String	suggested
description	description 5	Any description or notes about the field	String	optional

See also

• {{Struct top}}
• {{Struct bottom}}
• {{Enum value}}

The above documentation is transcluded from Template:Struct field/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.