List of Control Characters: Difference between revisions

Document internal colors
RRad (talk | contribs)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Stub}}
{{Stub}}
== Control Characters ==
{| class="wikitable"
!Character
!Hex
!Description
|-
|~
|0x7E
|Reads the following 2 characters '''as hex''' and prints the result using the game's [https://en.wikipedia.org/wiki/Windows-1252#Code_page_layout Windows-1252]-derived character encoding (see <code>FONT/kanji.dat</code> or <code>FONT/kanji_rd.dat</code> in SkyTemple for the game's customized code page). Can be used to print normally unprintable characters such as brackets and 0x7E itself. Example: <code>~5B ~5D</code> will result in <code>[ ]</code> in-game.<br>Note: <code>~7E</code> results in a second small tilde (<code>˜</code>) in-game. Use the Shift-JIS character described below for a full tilde.
|-
|
|0x81
|Shift-JIS activator. Used normally in Japanese, but the international versions also use it to display the following extra characters from <code>kanji.dat/table 129</code>:
{| class="wikitable"
!Character
!Hex
!Note
|-
|~
|0x8160
|The only way to display a full tilde in-game. To input in SkyTemple, enter a Japanese wave dash (<code>〜</code>).
|-
|→
|0x81A8
|This character can be entered normally in SkyTemple.
|-
|←
|0x81A9
|This character can be entered normally in SkyTemple.
|-
|↑
|0x81AA
|This character can be entered normally in SkyTemple.
|-
|↓
|0x81AB
|This character can be entered normally in SkyTemple.
|-
|♪
|0x81F4
|This character can be entered normally in SkyTemple.
|}
|}
== Lowercase Text Tags ==
<TODO: parameters, (technical) descriptions, potential organization>
<We should probably specify which of these tags pull from the preprocessor_args struct, and if so, what field. And explain what that means. (AKA: requires ASM to be useful for scripting).>
{| class="wikitable"
!Tag
!Description
|-
|[area:#]
|
|-
|[adverb:#]
|Unused.
|-
|[bank:#]
|
|-
|[bank_left:#]
|
|-
|[c_kind:<actor>]
|Prints the Pokémon species of the specified actor, using the light green text color for species (see [CS:K]).
|-
|[c_i:#]
|Seems to be used for ability names, based on the id in the preprocessor_args struct?
|-
|[c_name:<actor>]
|Prints the name of the actor, using the appropriate color text for that actor (usually [CS:N], but differs for special actors like the hero and partner)
|-
| style="white-space:nowrap" |[c_stammer:<actor>]
|Prints the first character of the specified actor's name. Used only in JP.
|-
|[class:#]
|Unused.
|-
|[digits:#]
|
|-
|[digits_c:#]
|
|-
|[dungeon:#]
|Substitutes a dungeon name with [CS:P], based on the preprocessor_args struct.
|-
|[equip_list]
|
|-
|[experience:#]
|
|-
|[floor:0]
|Prints the job's destination floor.
|-
|[gadget_bag]
|Prints the current name of the player's inventory. Used by the base game to specify the One-Item Inventory or Treasure Bag depending on the player's progress.
|-
|[gender:#]
|
|-
|[gold:#]
|
|-
|[gold_left:#]
|
|-
|[hero]
|Prints the hero's name. Special Episodes instead use <code>[c_name:NPC_HERO_FIRST]</code>.
|-
|[item:#]
|Substitutes a properly formatted item name, based on the preprocessor_args struct.
|-
|[kind:]<br>[kind:#]
|Same as c_kind, except uses the preprocessor_args struct.
|-
|[move:]<br>[move:#]
|
|-
|[me_play:#]
|Substitutes with an instance of [ME_PLAY:id], based on an id pulled from the preprocessor_args struct.
|-
|[move_hit_ratio]
|Used in move descriptions, to substitute in the actual move hit ratio (in stars) for the move.
|-
|[move_power]
|Used in move descriptions, to substitute in the actual move power (in stars) for the move.
|-
|[name:#]
|Same as n_kind, except uses the preprocessor_args struct.
|-
|[now_team]
|
|-
|[partner]
|Prints the partner's name. Special Episodes instead use <code>[c_name:NPC_PARTNER_FIRST]</code>.
|-
|[partner2]
|Unused. <code>[partner2]</code> and <code>[partner2:0]</code> both seem to invariably crash the game.
|-
|[player]
|Prints the current leader's name using a blue text color.
|-
|[purpose:#]
|Unused. Seems to print "Recover the stolen item." as seen within the "Mission objectives" menu inside Beach Cave on the first visit, regardless of the player's progress.
|-
|[rank:#]
|
|-
|[range:#]
|Unused.
|-
|[s_item:#]
|Substitutes this text tag with a properly formatted item given by slot in the set_Item family of opcodes.
|-
|[string0]
|
|-
|[string:#]
|Substitutes a generic string stored in the preprocessor_args struct.
|-
|[se_play:#]
|Substitutes with an instance of [SE_PLAY:id], based on an id pulled from the preprocessor_args struct.
|-
|[type:#]
|Substitutes a pokemon type name (Fire, Water, Grass, etc.), based on the preprocessor_args struct.
|-
|[trap:#]
|Substitutes a trap name with [CS:H], based on the preprocessor_args struct.
|-
|[tactics:#]
|Substitutes a team tactics name based on the preprocessor_args struct.
|-
|[team]<br>[team:]<br>[team:#]
|
|-
|[time:#]
|
|-
|[value0:#:#]
|
|-
|[value:#:#]
|
|-
|[value_i:#]<br>[value_i:#:#]
|Unused.
|-
|[weather:#]
|
|-
|[wiseness:]<br>[wiseness:#]
|Substitutes the tag with an IQ skill name by id, pulled from the preprocessor_args struct.
|}


== Capitalized Text Tags (Parse-on-Print) ==
== Capitalized Text Tags (Parse-on-Print) ==
Line 7: Line 206:
These text tags draw something that isn't text in the textbox.
These text tags draw something that isn't text in the textbox.
{| class="wikitable"
{| class="wikitable"
!Text Tag
!Tag
!Description
!Description
|-
|-
Line 302: Line 501:
|[M:T5]
|[M:T5]
|[M:65]
|[M:65]
|未 'Mi' (unfinished)
|未 'Mi' (unimplemented)
|colspan="2" style="text-align:center; background-color:#808080;" | [[File:M-T5.png]]
|colspan="2" style="text-align:center; background-color:#808080;" | [[File:M-T5.png]]
|-
|-
Line 348: Line 547:
These text tags alter the properties of normal text characters that follow them.
These text tags alter the properties of normal text characters that follow them.
{| class="wikitable"
{| class="wikitable"
!Text Tag
!Tag
!Description
!Description
|-
|-
Line 465: Line 664:
|[CS:L]
|[CS:L]
| style="color:black; background-color:#00E060;" |Green<br>#00E060
| style="color:black; background-color:#00E060;" |Green<br>#00E060
|The tag itself is effectively unused in the base game, but the same text color is used for [LS:x] hyperlinks in item/move descriptions. The kiosk demo uses the tag to note the title of the game.
|The tag itself is effectively unused in the base game, but the same text color is used for [LS:#] hyperlinks in item/move descriptions. The kiosk demo uses the tag to note the title of the game.
|None
|None
|0x6C
|0x6C
Line 549: Line 748:
|[CS:W]
|[CS:W]
| style="color:black; background-color:#F80000;" |Red<br>#F80000
| style="color:black; background-color:#F80000;" |Red<br>#F80000
|Only used for debug messages, particularly warnings.
|Used by item-boosted stats in a Pokémon's summary and a few debug messages, particularly warnings.
|[CS:B], [CS:r]
|[CS:B], [CS:r]
|0x28
|0x28
Line 579: Line 778:
These text tags insert different characters depending on the system language.
These text tags insert different characters depending on the system language.
{| class="wikitable"
{| class="wikitable"
!Text Tag
!Tag
!Description
!Description
|-
|-
Line 609: Line 808:
|[F:ER]
|[F:ER]
| -
| -
| colspan="2" rowspan="1" |er
| colspan="2" rowspan="1" |<sub>er</sub>
|0x96
|0x96
|0x96
|0x96
|e and r condensed into one character. Used in French when referring to Sky Peak Station Pass 1.
|e and r condensed into one superscript character, a masculine ordinal indicator for number 1. Used in French when referring to Sky Peak Station Pass 1.
|-
|-
|[F:RE]
|[F:RE]
| -
| -
| colspan="2" rowspan="1" |re
| colspan="2" rowspan="1" |<sup>re</sup>
|0x97
|0x97
|0x97
|0x97
|r and e condensed to one character. Unused
|r and e condensed to one superscript character, a feminine ordinal indicator for number 1. Used in a single preset phrase for Friend Rescues in French: <code>La 1[F:RE] équipe gagne!</code>
|-
|-
|[F:O]
|[F:O]
Line 626: Line 825:
|0xBA
|0xBA
|0xBA
|0xBA
|Masculine Ordinal Indicator. Unused?
|Masculine ordinal indicator for numbers 2+. Unused?
|-
|-
|[F:E]
|[F:E]
Line 633: Line 832:
|0x8D
|0x8D
|0x8D
|0x8D
|Superscript "e". Used in French when referring to Sky Peak Station Pass 2+
|Superscript "e", an ordinal indicator for numbers 2+. Used in French when referring to Sky Peak Station Pass 2+.
|-
|-
|[F:RQ]
|[F:RQ]
Line 640: Line 839:
|0xBF
|0xBF
|0xBF
|0xBF
|Reverse question mark. Unused?
|Reverse question mark. Unused, as the Spanish script simply writes out the character regularly.
|-
|-
|[F:S1]
|[F:S1]
Line 678: Line 877:
These text tags alter the rate that text is printed, and/or create a line break.
These text tags alter the rate that text is printed, and/or create a line break.
{| class="wikitable"
{| class="wikitable"
!Text Tag
!Tag
!Description
!Description
|-
|-
Line 709: Line 908:
These text tags alter the printing position of characters that follow them.
These text tags alter the printing position of characters that follow them.
{| class="wikitable"
{| class="wikitable"
!Text Tag
!Tag
!Description
!Description
|-
|-
Line 731: Line 930:
These text tags create audio effects when they are parsed, but do not affect the textbox visually.
These text tags create audio effects when they are parsed, but do not affect the textbox visually.
{| class="wikitable"
{| class="wikitable"
!Text Tag
!Tag
!Description
!Description
|-
|-