Template:FrameTable/doc: Difference between revisions

Latest revision as of 06:22, 23 February 2022

	This template uses TemplateStyles:
	Template:FrameTable/style2.css

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.
`state`	`Stance`	Label for the third row.
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 df+1

Frame

Input

State

1

d/f1

2

⋯

12

13

14

15

⋯

25

26

27

28

29

39

31

32

33

34

@@ Line 3: / Line 3: @@
 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 various frame tables to describe very different situations while having a limited palette.
+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 ==
@@ Line 9: / Line 9: @@
 <syntaxhighlight lang="html">
 {{FrameTable|
-{{Frame|frame-number|input|state}}
+{{Frame|1|d/f1|blue}}
+{{Frame|2|n|orange}}
 }}
 </syntaxhighlight>
@@ Line 15: / Line 16: @@
 === FrameTable set ===
-If there are a set of FrameTables intended to be read in parallel, wrap them in a <syntaxhighlight lang="html" inline><div class="frame-table-set"></div></syntaxhighlight>. This will give them a shared scrollbar if they overflow, keeping them aligned.
+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 ==
+{| class="wikitable col-1-center"
+! Parameter !! Default !! Description
+|-
+| <code>caption</code>
+|
+| A caption for the table. Can be blank.
+|-
+| <code>state</code>
+| <code>Stance</code>
+| Label for the third row.
+|-
+| 1
+|
+| A sequence of [[Template:Frame]]s that make up the table itself.
+|}
 == Parameters for [[Template:Frame]] ==
@@ Line 24: / Line 43: @@
 | 1
 | <code>⋯</code>
-| The frame number for this column. Use ⋯ to indicate a series of frames with the same input and state.
+| The frame number for this column. Use ⋯ for multiple frames with the same input and state.
 |-
 | 2
@@ Line 32: / Line 51: @@
 | 3
 | <code>blue</code>
-|
+| The color of the final cell in the column. This represents the state of the player. Available colors are {{Template:Colors}}.
-The color of the final cell in the column. This represents the state of the player. Available colors are {{Template:Colors}}.
-Be very aware of off-by-1 errors here. This is the state ''at the start of the frame'', which is necessarily unaffected by this frame's own input. For example, the player is ''standing'' on the frame where they press D from standing. They are only crouching on the next frame.
-Similarly, if a player attacks, the startup counts from the ''next'' frame. An i10 move whose input is pressed on frame 1 will have its first active frame on frame 11. For this reason, it's generally best to start the table on frame 0.
 |}
@@ Line 44: / Line 58: @@
 {{Legend
 |float=right
-|blue=Standing
+|green=Recovered
 |orange=Startup
-|yellow=Active frame
+|yellow=Active
 |teal=Recovery
 |purple=Input buffer
-|green=Crouch
 }}
-{{FrameTable|
+{{FrameTable|caption=Lee df+1|
-{{Frame|0|d/f1}}
+{{Frame|1|d/f1|orange}}
-{{Frame|1|n|orange}}
+{{Frame|2||orange}}
-{{Frame|⋯|n|orange}}
+{{Frame|⋯||orange}}
-{{Frame|12|n|orange}}
+{{Frame|12||orange}}
-{{Frame|13|n|yellow}}
+{{Frame|13||yellow}}
-{{Frame|14|n|yellow}}
+{{Frame|14||yellow}}
-{{Frame|15|n|teal}}
+{{Frame|15||teal}}
-{{Frame|⋯|n|teal}}
+{{Frame|⋯||teal}}
-{{Frame|26|n|teal}}
+{{Frame|25||teal}}
-{{Frame|27|n|purple}}
+{{Frame|26||purple}}
-{{Frame|28|n|purple}}
+{{Frame|27||purple}}
-{{Frame|29|n|purple}}
+{{Frame|28||purple}}
-{{Frame|39|n|purple}}
+{{Frame|29||purple}}
-{{Frame|31|d|purple}}
+{{Frame|39||purple}}
-{{Frame|32|d|purple}}
+{{Frame|31||purple}}
-{{Frame|33|d|purple}}
+{{Frame|32||purple}}
-{{Frame|34|d|blue}}
+{{Frame|33||purple}}
-{{Frame|35|d|green}}
+{{Frame|34||green}}
-{{Frame|⋯|d|green}}
 }}
-<div style="clear: both"></div>