Difference between revisions of "Template:2da documentation"

Revision as of 23:50, 27 July 2009

This template set includes the following templates:

• Template:2da start
• Template:2da column
• Template:2da end

It's intended to allow quick and easy creation of 2DA description tables for documentation purposes. Note that although the 2da column template is called "column", it actually produces rows in the formatted table. this is due to the fact that the Excel source documents for 2DAs are organized by column.

You should omit the "ID" column that all 2DAs have by default, this is added automatically by the 2da start template. You should add the name of the 2da's worksheet to the 2da start template; the worksheet name is what the resulting 2da file will be named after.

For exmample, the following set of templates:

{{2da start|ANIM_base}}
{{2da column| LABEL | string | name of the model }}
{{2da column| bHasAppearAnim | int | 0: Creature has no default appear animation. 1: Creature DOES have a default appear animation}}
{{2da end}}

Produces:

Alternately, you could use named parameters like so:

{{2da start
|name=ANIM_base}}
{{2da column
|name= LABEL
|type= string
|description= name of the model
}}
{{2da column
|name= bHasAppearAnim
|type= int
|description= 0: Creature has no default appear animation. 1: Creature DOES have a default appear animation
}}
{{2da end}}

Produces: