ShimmerFairy: All my notes on TP's messages. Tags could probably be organized in a more ToC-friendly way, but at least the notes are here.

2025-03-23T17:10:25Z

All my notes on TP's messages. Tags could probably be organized in a more ToC-friendly way, but at least the notes are here.

New page

This page details how Twilight Princess extends the BMG format to handle all of its text needs, particularly message attributes and tags. For information on how the BMG file format works in general, see [[BMG|the main page on the subject]].

== Message Attributes ==

{{todo|Figure out more about the message attributes, which likely requires decomp advancements to do sanely. Also more completely catalog how the various style/position attributes interact with each other; they've only been independently tested on "standard" messages so far. And the camera position values.}}

Twilight Princess defines 16 bytes of attribute data for every BMG file ''except'' <code>zel_unit.bmg</code>, which is used for a different purpose than other BMG files. These attributes are laid out as follows:

{| class="wikitable"
|-
! Offset !! Size !! Meaning
|-
| 0x00 || 2 || Message ID, identical to the one it has been assigned in the MID1 section. These two occurrences of the ID must be kept synchronized for correct operation.
|-
| 0x02 || 2 || '''Unknown'''
|-
| 0x04 || 1 || Uncertain, seems to affect what sound is played as text is being printed (aka the "blips"), as well as what kind of efforts byte 0x0A is allowed to choose. Additionally, valid values appear to depend on some external context.
|-
| 0x05 || 1 || Display Style. Affects broadly how the message is displayed on screen, though some values only have their intended function in specific contexts. Valid values are listed further below.
|-
| 0x06 || 1 || Printing Style. Affects how text is printed on screen, though some values only have their intended function in specific contexts. Valid values are listed further below.
|-
| 0x07 || 1 || Determines where the message area is positioned on screen. Valid values are listed further below.
|-
| 0x08 || 1 || '''Unknown''', appears to be some kind of item ID, but trying to set an icon for the Get Item message box style through this doesn't work, so some other external context enables the selection of item icons for those messages.
|-
| 0x09 || 1 || '''Unknown''', set to <code>0x01</code> for every single Get Item message ''except'' the one for a completely filled Vessel of Light. Additionally set on messages for bugs you've already caught, and rupees you can't fit in your wallet. Otherwise zero.
|-
| 0x0A || 1 || Uncertain, seems to determine what effort (indistinct bit of speech/grunting a character does) plays at the start of printing. Affected by byte 0x04 and other external context.
|-
| 0x0B || 1 || Determines where the camera is located. Values uncertain.
|-
| 0x0C || 4 || '''Unknown'''
|}

=== Display Style ===

This attribute determines how the message is to be displayed on screen (for example, is it text on a sign, or the place name showing up in the corner of the screen as you enter the area?). Some of these values are set aside to indicate something about appearance in a very specific context, and for "standard" messages — those which appear as character dialogue, the vast majority of messages — they don't have a well-defined effect.

The values for this attribute that Twilight Princess accepts are:

{| class="wikitable"
|-
! Value !! Meaning
|-
| 0x00 || Standard dialogue box; dark background, white text, allows for typewriter text.
|-
| 0x01 || No background behind text, so it's drawn directly on the rendered 3D image.
|-
| 0x02 || Fullscreen sign board background, forces instant text.
|-
| 0x05 || Visually the same as 0x01 for standard messages. Used for the Ordon light spirit's "cutscene" dialogue (spoken over scenes of the world be overrun), the Cannon Manual, as well as one system message, and several voiceless messages.
|-
| 0x07 || No background, centered text, raised a bit compared to the normal bottom positioning. Used exclusively for credits.
|-
| 0x08 || Similar to 0x00, but the glow effect around the text starts out huge around each piece of text printed.
|-
| 0x09 || Get Item text box. Defaults to the bow icon unless conditions are right for displaying a chosen icon.
|-
| 0x0B || Looks like standard dialogue box when used in standard messages. Used exclusively on item names and item descriptions.
|-
| 0x0C || Header box, positioned at the top left of the screen with a unique font. Used to introduce newly-entered areas and hidden skills demos.
|-
| 0x0D || Like 0x00, but the default text color is a bright blue. Used for Midna's dialogue.
|-
| 0x0E || Like 0x00, but the default text color is a vibrant green. Used for animals when they talk to Wolf Link.
|-
| 0x0F || Like 0x00, but text is forced instant, and the box fades in with the text. Seems to only be used with non-modal messages (e.g. "Your hot water has cooled").
|-
| 0x10 || Seemingly same as 0x0F. Used for system messages (e.g. "Checking the memory card").
|-
| 0x11 || Wolf song interface. Does nothing, at least when accessed as human. UI text provided by message body in the one message this type is used.
|-
| 0x13 || No background, centered text, font like 0x0C. Used on messages introducing a boss's name and title.
|}

=== Printing Style ===

This attribute controls how text is printed on the screen. This includes things like whether the text pops up instantly or typewriter style, and the speed of typing. Acceptable attributes are:

{| class="wikitable"
|-
! Value !! Meaning
|-
| 0x00 || Typewriter text by default, can be overridden by display style or tags, player can skip text.
|-
| 0x01 || Forced instant text, player can skip printing.
|-
| 0x02 || Like 0x00, but disable print skipping.
|-
| 0x03 || Like 0x01, but first box's text fades in if not skipped.
|-
| 0x04 || Like 0x00, but disables the <code>{instant}</code> tag (forced instant still possible by display style), disables print skipping.
|-
| 0x05 || Like 0x00, but typing is slow (roughly 5x slower).
|-
| 0x06 || Appears to behave like 0x00 exactly. Only used in one message.
|-
| 0x07 || Appears to behave like 0x04 exactly. Used on some UI prompt messages. Decomp suggests it tells UI code to emphasize the text.
|-
| 0x09 || Appears to behave like 0x03 exactly. Used on Ordon spirit "cutscene" messages, and staff credits messages.
|}

=== Message Area Position ===

This attribute determines where to place the message area on screen, assuming that such at thing can be controlled for this message. For the standard display style at least, the accepted values have the following listed effects, along with notes on where the more unusual options do get used:

{| class="wikitable"
|-
! Value !! Meaning
|-
| 0x00 || At the bottom of the screen.
|-
| 0x01 || At the top of the screen.
|-
| 0x02 || In the center of the screen.
|-
| 0x03 || Seemingly the same as 0x00. Seems to be used exclusively for message surrounding the Ordon mayor, including sumo wrestling him in particular.
|-
| 0x05 || Seemingly the same as 0x00. Used on system and voiceless messages, as well as the Cannon Manual.
|}

== Tags ==

This section describes all of the tags that Twilight Princess defines for use in text. Each subsection is devoted to a particular tag, referred to by its tag group and tag number, formatted as <code>tag group/tag number</code>, with both values implicitly hexadecimal. A descriptive name is given as well, and each section illustrates the tag as if it were a typical C function call, with arguments given standard C types to make their usage clearer. The payload holds the given arguments, if any, in the order written.

=== 00/0000 : link ===

link()

Simply prints Link's name.

=== 00/0001 : instant ===

instant()

Switches to instant text mode, if possible.

=== 00/0002 : type ===

type()

Switches to typewriter text mode, if possible.

=== 00/0004 : autobox ===

autobox(uint16_t frame_count)

Advance to next box <code>frame_count</code> frames after the end of printing. Input is disabled, player must wait for the next box.

=== 00/0005 : boxatmost ===

boxatmost(uint16_t frame_count)

Advance to the next box <code>frame_count</code> frames after the end of printing. Player may advance the text themselves if desired, meaning this code effectively sets a maximum amount of time the box may be displayed.

=== 00/0007 : pause ===

pause(uint16_t frame_count)

Wait <code>frame_count</code> frames before continuing to type out text. If player skips typing, all remaining {pause}s in the box are skipped. Has no effect in instant text.

=== 00/0008 : oneof2 ===

oneof2(uint8_t choice)

Prefaces the text of an option in a two-choice prompt. Option text starts immediately after this code, and ends at the next {oneof2} or the end of the message. Text before the first {oneof2} in a message is displayed in the main message box as normal, except that preceding text on the same line as the first option is forced instant. The same <code>choice</code> value may be used in both options. The last option with a <code>choice</code> value of 01 will be selected by default, otherwise the first option is default. (The <code>choice</code> argument has no other effect on message display.)

Normally two of these are used to name both options. If more than two {oneof2} codes occur in a message, only the first two are used. If only one is used, the second option is blank. Options are always displayed in the order written.

Can be used interchangeably with {oneof3} to set option texts; which of these two codes is used first determines how many options are available. No other visual effect occurs from using these interchangeably, but other effects on the game are not known.

=== 00/0009 : oneof3 ===

oneof3(uint8_t choice)

Prefaces the text of an option in a three-choice prompt. Option text starts immediately after this code, and ends at the next {oneof3} or the end of the message. Text before the first {oneof3} in a message is displayed in the main message box as normal, except that preceding text on the same line as the first option is forced instant. The same <code>choice</code> value may be used in multiple options. The last option with a <code>choice</code> value of 01 will be selected by default, otherwise the first option is default. (The <code>choice</code> argument has no other effect on message display.)

Normally three of these are used to name all three options. If more than three {oneof3} codes occur in a message, only the first three are used. If less than three are used, the present options are followed by blank ones. Options are always displayed in the order written.

Can be used interchangeably with {oneof2} to set option texts; which of these two codes is used first determines how many options are available. No other visual effect occurs from using these interchangeably, but other effects on the game are not known.

=== 00/000A : A ===

A()

GameCube A button

=== 00/000B : B ===

B()

GameCube B button

=== 00/000C : C ===

C()

GameCube C stick

=== 00/000D : L ===

L()

GameCube L button

=== 00/000E : R ===

R()

GameCube R button

=== 00/000F : X ===

X()

GameCube X button

=== 00/0010 : Y ===

Y()

GameCube Y button

=== 00/0011 : Z ===

Z()

GameCube Z button

=== 00/0012 : D ===

D()

GameCube D-Pad

=== 00/0013 : AS-cross ===

AS-cross()

GameCube analog stick, animated movement to four directions

=== 00/0014 : left-arrow ===

left-arrow()

Left arrow, approx. ⬅

=== 00/0015 : right-arrow ===

right-arrow()

Right arrow, approx. ➡

=== 00/0016 : up-arrow ===

up-arrow()

Up arrow, approx. ⬆

=== 00/0017 : down-arrow ===

down-arrow()

Down arrow, approx. ⬇

=== 00/0018 : AS-up ===

AS-up()

GameCube analog stick, animated up movement

=== 00/0019 : AS-down ===

AS-down()

GameCube analog stick, animated down movement

=== 00/001A : AS-left ===

AS-left()

GameCube analog stick, animated left movement

=== 00/001B : AS-right ===

AS-right()

GameCube analog stick, animated right movement

=== 00/001C : AS-vertical ===

AS-vertical()

GameCube analog stick, animated up & down movement

=== 00/001D : AS-horizontal ===

AS-horizontal()

GameCube analog stick, animated left & right movement

=== 00/001E : inline-two-next ===

inline-two-next(uint8_t value)

Allocates space for the red right arrow selector for an inline 2-option choice, specifically the non-default option. <code>value</code> appears to have no effect on message display (note that it happens to always be 01 in provided messages). See {inline-two-first} for details on functionality.

=== 00/001F : inline-two-first ===

inline-two-first(uint8_t value)

Allocates space for the red right arrow selector for an inline 2-option choice, specifically the default option. <code>value</code> appears to have no effect on message display (and happens to always be set to 00 in provided messages).

This, alongside {inline-two-next}, is used to provide two options for the player to choose from, like {oneof2}, except that the options are presented within the main message box. These two "inline option" control codes only appear to differ for choosing the default option. Otherwise, these two codes are apparently identical when used properly, and are treated as such in the following description.

Lines featuring an inline option control code are centered within the message box, while other lines in the box are unaffected. Unlike {oneof2}, these codes do not take ownership of following text; rather, they only open up a space for a red right arrow to appear in. The player moves the arrow with analog stick left and right (even if the options are on different lines), with left selecting the first written option, and right the second.

If more than two codes are present in a box, then the additional codes have their space for the arrow, but they are not selectable. If only one code is present, then it acts as the first option, with the missing option conceptually to the right of the one present.

If enough additional text occurs in the message to generate more boxes after the one with these option codes, then the player will not be able to choose an option. However, the initial visual appearance of the options will be as expected (including where the arrow defaults to). Subsequent boxes in the message may contain option codes as well, which are treated independently from the other boxes.

Attempting to mix these inline option codes with {oneof2} or {oneof3} causes all text following the first {oneof2} or {oneof3} to be discarded from display, even if they occur before an inline option code, and no {oneof2}/{oneof3} option boxes are drawn.

=== 00/0020 : softnl ===

softnl()

Acts as a newline unless no text follows. Effect most apparent at the end of a box; a newline after the last line of a box forces another box, even if empty, while this code ensure an empty box won't appear.

In the game, this is only ever used at the end of question messages; since non-inline choices and their prompts are put in separate messages in the game, this code may have been necessary to ensure non-forced-instant text in the prompt, or was otherwise more visually apparent than the alternative plain newline. This code may also have other effects not yet known.

=== 00/0021 : nop000021 ===

nop000021()

Appears to do nothing? Consistently shows up ahead of ellipses followed by the player's name, but prints nothing and has no obvious effect thus far.

=== 00/0022 : epona ===

epona()

Simply prints Epona's name.

=== 00/0023 : red-target ===

red-target()

Animated icon for a selected clawshot/boomerang target.

=== 00/0024 : yellow-target ===

yellow-target()

Animated icon for a possible clawshot/boomerang target.

=== 00/0025 : payment ===

payment(uint32_t destination)

Allows the player to pay for something. It's expected to be in the last box of a message; if more boxes appear after the one with this code, then it will immediately advance to the next box, and the player can't interact with the counter in any way, but it will still be visible.

In game, a <code>destination</code> of zero refers to Trill's shop payment, while a <code>destination</code> of one is for Malo Mart's donation drives. (You can check on the latter with {mart-goal-left}.)

=== 00/0028 : odd-holdbox ===

odd-holdbox(uint32_t value)

Works like {holdbox}, but the time held is inconsistent on repeated viewings of the same message (it is, however, affected by the value in <code>value</code>, roughly as a number of frames). Only used in a few messages for the Ordon light spirit, during a cutscene showing scenes of Hyrule being taken over, and always uses the value 0x10E (270, which would be 9 seconds if a frame count).

=== 00/0029 : current-scent ===

current-scent()

Current learned scent. Prints nothing outside of specific messages.

=== 00/002B : warping-to ===

warping-to()

Name of chosen warp location. Prints nothing outside of specific messages.

=== 00/002C : warp-point ===

warp-point()

Warp point map icon.

=== 00/002D : bomb-name ===

bomb-name()

The name of the chosen bomb to be purchased/sold. Prints nothing outside of certain messages.

=== 00/002E : XorY ===

XorY()

Seems to indicate which item button an externally-chosen item is set to. Defaults to X.

=== 00/0030 : bomb-bag-icon ===

bomb-bag-icon(uint8_t bag)

Related to bomb bags, appears to just display a bomb bag icon? <code>bag</code> values have been observed to be in the range 0..3, but so far no distinction has arisen.

=== 00/0031 : bomb-count ===

bomb-count()

Displays a count of bombs determined externally, printed as <code>printf("%d bombs", i)</code>, defaults to zero. Used in bomb buy/sell messages.

=== 00/0032 : bomb-price ===

bomb-price()

Displays total price of chosen bombs, printed as <code>printf("%d Rupees", i)</code>, defaults to zero. Price determined externally.

=== 00/0033 : inline-three-next ===

inline-three-next(uint8_t value)

Allocates space for the right red arrow used in an inline 3-option choice, specifically a non-default option. The value of <code>value</code> appears to have no effect on the message display. Otherwise behaves just like its companion code, {inline-three-first}. See its documentation for more details.

=== 00/0034 : inline-three-first ===

inline-three-first(uint8_t value)

Allocates space for the right red arrow used in an inline 3-option choice, specifically the default option. The value of <code>value</code> appears to have no effect on message display. Aside from one choosing the default option, this and {inline-three-next} behave identically under normal operation, and the two will be treated as the same in the following description.

Lines on which these inline choice codes appear are centered, while other lines in the box are untouched. These options do not take ownership of the following text (unlike {oneof3} options), merely open up space within the message text for an arrow to appear. Players select an option by moving left and right with the analog stick, even when the options are spread across multiple lines. The first option is the leftmost, and the last option is the rightmost.

If more than three options are provided, space for an arrow is still given, but players cannot select them. If less than three are provided, the ones that are present represent the first available options, with missing options conceptually to the right of those present.

If additional boxes of text follow in the message, then the player can't interact with the options, though they still appear as described. Subsequent boxes may contain more inline option codes, with each box considered to contain a separate choice.

=== 00/0035 : nop000035 ===

nop000035()

Only occurs in one message on its own. When used prints nothing. Surrounded by credits and debug(?) messages. In the currently-available decomp, it just cryptically push a word to some stack. (Other, similar codes push more descriptively-named things to the stack, for comparison.)

=== 00/0036 : boxatleast ===

boxatleast(uint16_t frame_count)

Requires the current box to be displayed for at least <code>frame_count</code> frames after printing is finished before player can advance. Player may skip typing, but cannot advance beyond this box. Player is required to advance the text afterwards.

=== 00/0037 : bombcap ===

bombcap(uint8_t type)

Prints bomb capacity for a bomb bag that holds bombs of type <code>type</code>. Valid <code>type</code>s are:

{| class="wikitable"
|-
! Value !! Bomb Type
|-
| 0x00 || Normal
|-
| 0x01 || Underwater
|-
| 0x02 || Mobile
|}

=== 00/0038 : arrowcap ===

arrowcap()

Prints current quiver capacity.

=== 00/0039 : heart ===

heart()

Prints a ♥.

=== 00/003B : returned-bug ===

returned-bug()

Prints the name of the last bug you've returned to Agitha. Prints "♂ beetle" if you haven't turned in any bugs yet (or outside of Agitha messages in general?)

=== 00/003C : letter-sender ===

letter-sender()

Name of letter sender, only used when mailman has a single letter for you. Outside of that context, prints nothing.

=== 00/003E : current-letter-page ===

current-letter-page()

Prints the number of the current page of letters you're on. Outside of the normal place it appears, it displays the page you were on when you exited the letters screen. Prints "0" if you haven't looked at the letters screen since booting the game.

=== 00/003F : max-letter-page ===

max-letter-page()

Prints how many pages of letters you have in the letter screen. Prints "0" if you haven't looked at the letters screen since booting the game.

=== 01/0000 : nop010000 ===

nop010000()

Only used in a Yeto message. Possibly an effort that only works in certain maps?

=== 01/000A : nop01000A ===

nop01000A()

Only used in a couple of Shad messages. Possibly an effort that only works in certain maps?

=== 01/0014 : nop010014 ===

nop010014()

Consistently used before Midna's laughs, specifically where she says "Eee hee" in the text. Possibly a laugh sound, but the ones used in Ordon and Faron have no obvious effect even in their proper places.

=== 03/0000 : wii-divert-to-idx ===

wii-divert-to-idx(uint32_t idx)

Meaning unclear, but decomp shows that <code>idx</code> can be understood as an INF1 index into the same BMG file the using message appears in. While it's not certain, it seems to divert certain messages to Wii-specific ones (particularly those describing controls) for the Wii versions of the game.

=== 03/0001 : wiiA ===

wiiA()

Looks like GameCube A button, but context (including this tag group) suggests it's intended to be the Wii A button.

=== 03/0002 : wiiB ===

wiiB()

Slightly off Wii B button. (Gray instead of white, but otherwise square like you'd expect for Wii UI.)

=== 03/0003 : wiiHome ===

wiiHome()

Not actually used in the game. Draws the Wii HOME button.

=== 03/0004 : wiiMinus ===

wiiMinus()

Wii - button.

=== 03/0005 : wiiPlus ===

wiiPlus()

Wii + button.

=== 03/0006 : wii1 ===

wii1()

Wii 1 button.

=== 03/0007 : wii2 ===

wii2()

Wii 2 button.

=== 03/0008 : wiiD-WES ===

wiiD-WES()

Wii D-Pad, blinking red marks on West, East, and South directions.

=== 03/0009 : wiiD-N ===

wiiD-N()

Wii D-Pad, blinking red mark on North direction.

=== 03/000A : wiiD-S ===

wiiD-S()

Wii D-Pad, blinking red mark on South direction.

=== 03/000B : wiiD-WE ===

wiiD-WE()

Wii D-Pad, blinking red marks on West and East directions.

=== 03/000C : wiiD-E ===

wiiD-E()

Wii D-Pad, blinking red mark on East direction.

=== 03/000D : wiiD-W ===

wiiD-W()

Not actually used in the game. Wii D-Pad, blinking red mark on West direction.

=== 03/000E : wiimote ===

wiimote()

Wiimote controller (depicting upper half, top-down view). Visually identical to {wiimote2}, but is used way less often.

=== 03/000F : reticule ===

reticule()

Targeting reticule, seen when using motion controls.

=== 03/0010 : nunchuck ===

nunchuck()

Nunchuck controller (depicting upper portion, top-down view).

=== 03/0011 : wiimote2 ===

wiimote2()

Wiimote controller (depicting upper half, top-down view). Visually identical to {wiimote}, but is used way more often.

=== 03/0012 : fairy ===

fairy()

Not actually used in game. Animated blue fairy, flapping its wings.

=== 03/0013 : wiiC ===

wiiC()

Looks like GameCube C stick, but from actual usage and the tag group it's in, would appear to be intended as the Wii C button.

=== 03/0014 : wiiZ ===

wiiZ()

Looks like GameCube Z button, but from actual usage and the tag group it's in, would appear to be intended as the Wii Z button.

=== 05/0000 : timestat ===

timestat(uint8_t what)

Prints a time statistic. For the sledding and STAR minigames, the only <code>what</code> value used is 0, and of course prints the time. For goat herding, <code>what</code> can be either of these values:

{| class="wikitable"
|-
! Value !! Meaning
|-
| 0 || Time relative to record (for text like "1:23 slower than usual").
|-
| 1 || Absolute time.
|}

Prints nothing outside of specific contexts.

=== 05/0003 : bugstat ===

bugstat(uint8_t what)

Provides a statistic about Agitha's bug quest. Every option printed as <code>printf("%d bugs", i)</code>. Possible options for <code>what</code> are:
{| class="wikitable"
|-
! Value !! Meaning
|-
| 0 || Bugs returned
|-
| 1 || Bugs still missing
|}

=== 05/0007 : river-points ===

river-points()

Prints number of points earned from the Rapid Ride minigame. Defaults to zero, and prints as <code>printf("%d points", i)</code>.

=== 05/0008 : fish-length ===

fish-length()

Prints the length of a fish, in the form <code>printf("%d inches", i)</code>. Defaults to zero. Can be used to report the size of the just-caught fish, or the largest fish of a particular type caught, depending on context.

=== 05/0009 : mart-goal-left ===

mart-goal-left(uint16_t dummy, int16_t goal)

Print money still needed to reach the current Malo Mart donation goal. Text printed is equivalent to <code>printf("%d Rupees", goal - total_donated)</code>. The <code>goal</code> value is what determines the goal being referenced (and in fact does not need to correspond to an actual Malo Mart goal at all); the game simply chooses different messages to report on the progress towards different goals. <code>dummy</code> has no effect.

Note that in reality the game takes the tag's argument as a single 32-bit integer, which gets assigned to a signed 16-bit integer. This means that unsigned values larger than 0x7FFF are actually triggering implementation-defined behavior, which in this case appears to be just "always take the lower 16 bits as-is". The effect is that the single argument can be equivalently understood as two arguments, as described above.

=== 05/000A : letter-count ===

letter-count()

Number of letters mailman has for you, printed as <code>printf("%d letters", i)</code>. Defaults to zero.

=== 05/000B : poes-needed ===

poes-needed()

Number of Poe souls Jovani still needs returned, printed as <code>printf("%d ghosts", i)</code>. Set to 20 at the start of the game.

=== 05/000C : balloon-score ===

balloon-score(uint8_t which)

Reports a Fruit-Pop-Flight minigame score. <code>which</code> can be one of the following values:
{| class="wikitable"
|-
! Value !! Meaning
|-
| 0 || Score from this run.
|-
| 1 || High Score.
|}

=== 05/000D : fish-count ===

fish-count()

Prints number of fish caught, in the form <code>printf("%d fish", i)</code>. Used only the fishing journal, which reports number of fish caught per type.

=== 05/000E : at-rollgoal ===

at-rollgoal()

Prints current Rollgoal level, defaults to 0-0.

=== 06/0002 : male ===

male()

♂ symbol

=== 06/0003 : female ===

female()

♀ symbol

=== 06/0004 : star ===

star()

Star, approx. ★

=== 06/0005 : refmark ===

refmark()

※ symbol

=== 06/0006 : thin-left-arrow ===

thin-left-arrow()

Thin left arrow, approx. ←

=== 06/0007 : thin-right-arrow ===

thin-right-arrow()

Not actually used in game. Thin right arrow, approx. →

=== 06/0008 : thin-up-arrow ===

thin-up-arrow()

Not actually used in game. Thin up arrow, approx. ↑

=== 06/0009 : thin-down-arrow ===

thin-down-arrow()

Not actually used in game. Thin down arrow, approx. ↓

=== 06/000A : bullet ===

bullet()

Prints a bullet for introducing a list item, specifically a lozenge (approx. ⧫). Always a black color, used in item descriptions.

=== 06/000B : bullet-space ===

bullet-space()

Prints horizontal space equivalent to the space a {bullet} takes up. Used to line up subsequent lines of a list item in item descriptions.

=== FF/0000 : color ===

color(uint8_t hue)

Sets the color to the chosen hue. Color persists until the next {color} or the end of the message, though some control codes may ignore the color or otherwise be unaffected by it. Colors appear to be a variation of Wind Waker's colors. Possible <code>hue</code> values are:

{| class="wikitable"
|-
! Value || Color
|-
| 0 || style="background:#ffffff; color:black;"| Default text color (usually white)
|-
| 1 || style="background:#f07878; color:black;"| Red
|-
| 2 || style="background:#aadc8c; color:black;"| Green
|-
| 3 || style="background:#a0b4dc; color:black;"| Blue
|-
| 4 || style="background:#dcdc82; color:black;"| Yellow
|-
| 5 || style="background:#b4c8e6; color:black;"| Ever-so-slightly lighter blue
|-
| 6 || style="background:#c8a0dc; color:black;"| Lavender
|-
| 7 || style="background:#ffffff; color:black;"| Always white
|-
| 8 || style="background:#dcaa78; color:black;"| Orange
|}

=== FF/0001 : size ===

size(uint16_t pct)

Scales following text to <code>pct</code> percent the size of normal text in this type of message box. Scale persists until the next {size} or the end of the message. Pieces of text of different scales on one line are aligned on their centers.

TP:BMG - Revision history

ShimmerFairy: /* Tags */ Add handy index, and document a couple German-exclusive tags.

ShimmerFairy: /* Tags */ Add information on tags seen for the first time in JP text.

ShimmerFairy: Reorganized tags section to be far more compact, and easier to follow.

ShimmerFairy: All my notes on TP's messages. Tags could probably be organized in a more ToC-friendly way, but at least the notes are here.