Template:FrameTable/doc: Difference between revisions

Template page
(fixed color order of legend might change and shouldn't be relied on; either way this should be in Template:Legend)
Line 79: Line 79:
{{Frame|33||purple}}
{{Frame|33||purple}}
{{Frame|34||green}}
{{Frame|34||green}}
}}
== Color order==
Not mandatory but the legend table follows a color order so it's helpful if organized properly.
{{Legend
|float=right
|blue=1
|red=2
|yellow=3
|orange=4
|teal=5
|green=6
|purple=7
}}
{{FrameTable|caption=Color order|
{{Frame|1||blue}}
{{Frame|2||red}}
{{Frame|3||yellow}}
{{Frame|4||orange}}
{{Frame|5||teal}}
{{Frame|6||green}}
{{Frame|7||purple}}
}}
}}

Revision as of 08:06, 22 September 2021

This template is used to show how something works on a frame-per-frame level.

There is no hard rule on what the colors mean. Instead, all uses of this template should have a nearby Template:Legend explicitly indicating what they mean on the page. This allows frame tables to describe very different situations while having a limited palette.

Usage

{{FrameTable|
{{Frame|1|d/f1|blue}}
{{Frame|2|n|orange}}
}}

FrameTable set

If there are a set of FrameTables intended to be read in parallel, wrap them in a Template:FrameTableSet. This will give them a shared scrollbar if they overflow, keeping them aligned.

Parameters

Parameter Default Description
caption A caption for the table. Can be blank.
1 A sequence of Template:Frames that make up the table itself.

Parameters for Template:Frame

Parameter Default Description
1 The frame number for this column. Use ⋯ for multiple frames with the same input and state.
2 The input performed on this frame. Uses Template:IronFist to represent the input. There should at most be two symbols used here: one for the direction, and one for the attack input. If other frames in the table use both, make sure you use n for any attack with a neutral directional input to keep the direction and attack buttons in the table aligned.
3 blue The color of the final cell in the column. This represents the state of the player. Available colors are red, orange, yellow, green, teal, blue, and purple.

Example

Active
Startup
Recovery
Recovered
Input buffer
Lee d/f+1
Frame
Input
State
1
d/f1
2
12
13
14
15
25
26
27
28
29
39
31
32
33
34