SkyTemple - User contributions [en]

How to change textbox graphics (Window Frames)

2026-02-23T03:28:48Z

Deltaflare: /* Gameplay Note */

''See also: [[How to edit Team Stats graphics]]''

The window frames can be customized using the files from the '''Misc. Graphics''' section. In a nutshell, there are 5 frame styles for the top and bottom screens. These are labeled <code>FONT/frameX.wte</code> and <code>FONT/frame_bX.chr</code> respectively, with X being a number from 0 to 4.

The visual design of the frames can be edited to your liking. But changing the colors as seen in-game requires editing certain color palettes, also called ''colormaps''. A colormap is a set of colors specified in the image data, which the game uses to "map" what color values should be shown-on screen. Due to system limitations, each frame graphic palette can only have 16 total values (numbered 0-15, plus a teal transparency color).

In the editor, each graphic can be viewed with the all 4 set of colors (by incrementing the "Palette Variant" number at the bottom of the image view). When exported, the image will reflect the ID chosen. For example, the image below was exported with ID 0 selected, causing it to appear blue.
[[File:Window frame colormap.png|alt=An image of a textbox window frame, showing the 4 available default colormaps|center|thumb|4 default palette rows, as seen in Libresprite]]
Each of these frames is exported from SkyTemple as an ''indexed image'' (where each color is assigned a number from 0 to 15) with 4 different palettes used in the colormap.

* '''ID 0''': blue (male default)
* '''ID 1''': pink (female default)
* '''ID 2''': green (Special Episode default, and certain sequences like the personality quiz and main menu)
* '''ID 3''': yellow (used to flash at low hunger)

Edit these colors to alter the given palette! Note that teal and black should remain the same, as the editor uses those for transparency colors.

== Tips ==
While the rows are unique, the colors share positions between palettes. This means that if the lightest blue is used anywhere in the frame, the lightest pink, green, and yellow respectively will appear in the same place when those palettes are used on-screen.
[[File:Frame window vertical example.png|center|thumb|160x160px|Color indices share same positions in every palette, from top down]]

== Gameplay Note ==
'''Note''' that the game is programmed to flash between the blue and pink palettes at low health. If these two are edited to be the same color, ''there will be no visual indicator of low health''!

Also, genderless or invalid species default to the using pink set of colors (palette index 1) while in Dungeon Mode.
[[Category:Tutorials]]

How to edit Team Stats graphics

2026-02-23T03:24:18Z

Deltaflare: team stats tutorial w images

''See also: [[How to change textbox graphics (Window Frames)]]''

The backgrounds for the Team Stats view can be edited in a similar way to the Window Frame graphics, though these are handled differently. Whereas the frame graphics had a single row for each color palette in use, the Team Stats graphics are split into two unique images: one indexed for male or female player use, and one for Special Episodes. These can be found in the '''Backgrounds''' section, as <code>DUNGEON/sub.bgp</code> and <code>DUNGEON/sub2bgp</code> respectfully. Export these by using '''Background > Export''' in the top of the image view.

The visual design of either can be edited to your liking. But changing the colors as seen in-game requires editing certain color palettes, also called ''colormaps''. A colormap is a set of colors specified in the image data, which the game uses to "map" what color values should be shown-on screen. These colormaps have three unique sets, as seen below.<gallery widths="200" heights="200">
File:Team Stats graphics mf.png|default Team Stats palette (blue/pink)
File:Team Stats graphics se.png|Special Episode Team Stats palette (only green used)
</gallery>Note that brown checkered pattern included in the PNG will appear tiled beneath ''all other window frames used'', aside from the Team Stats view itself. This can also be edited as needed, provided the pattern is the same size as the original.

The gold colors are used for the spotlight effect where the character sprite is displayed.

== Gameplay Note ==
As of now, it appears the use of the Team Stats graphics is limited to two colors (as opposed to the frames having four). As sub2.bpg is a separate image used for Special Episodes, genderless or invalid characters default to the blue set of colors. Also, the 1/2/3/4 number graphic is not able to be exported from SkyTemple.
[[Category:Tutorials]]

How to change textbox graphics (Window Frames)

2026-02-23T03:17:46Z

Deltaflare: /* Tips */

How to change textbox graphics (Window Frames)

2026-02-23T03:16:36Z

Deltaflare: invalid mon note

''See also: [[How to edit Team Stats graphics]]''

The window frames can be customized using the files from the '''Misc. Graphics''' section. In a nutshell, there are 5 frame styles for the top and bottom screens. These are labeled <code>FONT/frameX.wte</code> and <code>FONT/frame_bX.chr</code> respectively, with X being a number from 0 to 4.

The visual design of the frames can be edited to your liking. But changing the colors as seen in-game requires editing certain color palettes, also called ''colormaps''. A colormap is a set of colors specified in the image data, which the game uses to "map" what color values should be shown-on screen. Due to system limitations, each frame graphic palette can only have 16 total values (numbered 0-15, plus a teal transparency color).

In the editor, each graphic can be viewed with the all 4 set of colors (by incrementing the "Palette Variant" number at the bottom of the image view). When exported, the image will reflect the ID chosen. For example, the image below was exported with ID 0 selected, causing it to appear blue.
[[File:Window frame colormap.png|alt=An image of a textbox window frame, showing the 4 available default colormaps|center|thumb|4 default palette rows, as seen in Libresprite]]
Each of these frames is exported from SkyTemple as an ''indexed image'' (where each color is assigned a number from 0 to 15) with 4 different palettes used in the colormap.

* '''ID 0''': blue (male default)
* '''ID 1''': pink (female default)
* '''ID 2''': green (Special Episode default, and certain sequences like the personality quiz and main menu)
* '''ID 3''': yellow (used to flash at low hunger)

Edit these colors to alter the given palette! Note that teal and black should remain the same, as the editor uses those for transparency colors.

== Tips ==
While the rows are unique, the colors share positions between palettes. This means that if the lightest blue is used anywhere in the frame, the lightest pink, green, and yellow respectively will appear in the same place when those palettes are used on-screen.
[[File:Frame window vertical example.png|center|thumb|160x160px|Color indices share same positions in every palette, from top down]]

== Gameplay Note ==
'''Note''' that the game is programmed to flash between the blue and pink palettes at low health. If these two are edited to be the same color, ''there will be no visual indicator of low health''!

Also, genderless or invalid species default to the using blue set of colors (palette index 0).
[[Category:Tutorials]]

How to change textbox graphics (Window Frames)

2026-02-23T03:12:26Z

Deltaflare: weird phrasing fix

File:Team Stats graphics se.png

2026-02-23T03:06:14Z

Deltaflare:

File:Team Stats graphics mf.png

2026-02-23T03:05:19Z

Deltaflare:

How to change textbox graphics (Window Frames)

2026-02-23T02:51:02Z

Deltaflare: textbox tutorial w images

''See also: [[How to edit Team Stats graphics]]''

The window frames can be customized using the files from the '''Misc. Graphics''' section. In a nutshell, there are 5 frame styles for the top and bottom screens. These are labeled <code>FONT/frameX.wte</code> and <code>FONT/frame_bX.chr</code> respectively, with X being a number from 0 to 4.

The visual design of the frames can be edited as desired. But changing the colors as seen in-game requires editing certain color palettes, also called ''colormaps''. A colormap is a set of colors specified in the image data, which the game uses to "map" what color values should be shown-on screen. Due to system limitations, each frame graphic palette can only have 16 total values (numbered 0-15, plus a teal transparency color).

In the editor, each graphic can be viewed with the all 4 set of colors (by incrementing the "Palette Variant" number at the bottom of the image view). When exported, the image will reflect the ID chosen. For example, the image below was exported with ID 0 selected, causing it to appear blue.
[[File:Window frame colormap.png|alt=An image of a textbox window frame, showing the 4 available default colormaps|center|thumb|4 default palette rows, as seen in Libresprite]]
Each of these frames is exported from SkyTemple as an ''indexed image'' (where each color is assigned a number from 0 to 15) with 4 different palettes used in the colormap.

* '''ID 0''': blue (male default)
* '''ID 1''': pink (female default)
* '''ID 2''': green (Special Episode default, and certain sequences like the personality quiz and main menu)
* '''ID 3''': yellow (used to flash at low hunger)

Edit these colors to alter the given palette! Note that teal and black should remain the same, as the editor uses those for transparency colors.

== Tips ==
While the rows are unique, the colors share positions between palettes. This means that if the lightest blue is used anywhere in the frame, the lightest pink, green, and yellow respectively will appear in the same place when those palettes are used on-screen.
[[File:Frame window vertical example.png|center|thumb|160x160px|Color indices share same positions in every palette, from top down]]

== Gameplay Note ==
'''Note''' that the game is programmed to flash between the blue and pink palettes at low health. If these two are edited to be the same color, ''there will be no visual indicator of low health''!
[[Category:Tutorials]]

File:Frame window vertical example.png

2026-02-23T02:40:38Z

Deltaflare:

Color indices share same positions, from top down

File:Window frame colormap.png

2026-02-23T02:16:32Z

Deltaflare:

4 palette colormaps, as seen in Libresprite

Item/Trap Graphics

2025-12-26T22:23:43Z

Deltaflare: /* Sprite Slots */ missed arrow icon, clarified dungeon palette

Within the [[SkyTemple]] editor, graphics used by the game to render items and traps (including the Wonder Tile and stairs) can be edited.

== Item Sprites ==
EoS has 120 slots (numbered 0 - 119) used for items and effect sprites in dungeons. Not all are permanent entries, some are updated at runtime with certain animations. In SkyTemple, slots 0 - 63 can always be seen. These are the sprites used for existing floor items. Slot 63 is unnused in the base game, and appears in SkyTemple as a blank, transparent sprite.

=== Sprite Slots ===
It is possible to add custom item sprites without interfering with most existing ones. The valid, usable slots are ''italicized''.

* '''Slots 0 - 62''' are existing floor item sprites
** '''''Slots 9, 45 and 48''', containing the gear, shell and bone sprites, are unused in the vanilla game and can be replaced with new item sprites '''(3)'''''
* '''''Slot 63''' can be given a new item sprite '''(1)'''''
* '''Slots 64 - 81''' will always be replaced by the game at runtime with status animation sprites
* '''''Slots 82 - 95''' can be given new item sprites '''(14)'''''
* Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row. Creating entries for these slots in SkyTemple (even if adding the correct sprites) ''will force the new sprites to use Palette 0 of the "dungeon effects palette"'' with no reliable way to change the ID''.'' If trying to change Palette 0 to reflect desired colors, this can affect entries that may have had different colors originally assigned to them. These entries include slots:
** 96: small enemy shadow (black)
** 97: big enemy shadow (black)
** 98: small ally shadow (yellow)
** 99: big ally shadow (yellow)
** 100: big ally shadow (yellow)
** 101: small arrow showing direction player is facing (seen when pressing Y)
** 102: small arrow showing direction player is facing (seen when pressing Y)
** 103: beta "for HP" text
* '''''Slots 104 - 107''' can be given new item sprites '''(4)'''''
* '''Slots 108 - 110''' will always be replaced by the game at runtime with water shadow animation sprites
* '''''Slots 111 - 119''' can be given new item sprites '''(9)'''''

Any new entry after that slot (120+) will roll over into the next set of tiles, which will overwrite attack animation sprites. In total, there are '''31 slots''' available for custom item sprites.

== Trap Sprites ==
''Explorers of Sky'' has 35 slots (numbered 0 - 34) used for trap sprites in dungeons. Note that some interactive elements like Wonder Tiles and stairs are considered traps, though they are obviously not malicious. The sprites can be seen in ''Dungeon Graphics > Traps''. These sprites only have 2 [[Item Data#Category and IDs|Palette IDs]] available.

=== Sprite Slots ===

# Blank (solid blue image)
# Mud Trap (uses Palette 1)
# Sticky Trap (uses Palette 1)
# Grimy Trap (uses Palette 1)
# Summon Trap (uses Palette 1)
# Pitfall Trap - unbroken (uses Palette 0)
# Warp Trap (uses Palette 1)
# Gust Trap (uses Palette 1)
# Spin Trap (uses Palette 1)
# Slumber Trap (uses Palette 1)
# Slow Trap (uses Palette 1)
# Seal Trap (uses Palette 1)
# Poison Trap (uses Palette 1)
# Selfdestruct Trap (uses Palette 1)
# Explosion Trap (uses Palette 1)
# PP-Zero Trap (uses Palette 1)
# Chestnut Trap (uses Palette 0)
# Wonder Tile (uses Palette 0)
# Pokémon Trap (uses Palette 1)
# Spiked Tile (uses Palette 0)
# Stealth Rock Trap (uses Palette 1)
# Toxic Spikes Trap (uses Palette 1)
# Trip Trap (uses Palette 0)
# Random Trap (uses Palette 1)
# Grudge Trap (uses Palette 1)
# Yellow floor grid outline (seen when pressing Y) (uses Palette 1)
# Pink floor grid outline showing direction player is facing (seen when pressing Y) (uses Palette 1)
# Stairs Down (uses Palette 0 or 1)
# Stairs Up (uses Palette 0 or 1)
# "P" Flag (uses Palette 1)
# Kecleon Shop carpet (uses Palette 1)
# Key Door (uses Palette 0 or 1)
# Pitfall Trap - broken (uses Palette 0)
# Blocked tile (uses Palette 1)
# Blank (solid blue image)

{{NavSkyTemple}}

Item/Trap Graphics

2025-12-26T20:36:26Z

Deltaflare: added trap sprite slots

Within the [[SkyTemple]] editor, graphics used by the game to render items and traps (including the Wonder Tile and stairs) can be edited.

== Item Sprites ==
EoS has 120 slots (numbered 0 - 119) used for items and effect sprites in dungeons. Not all are permanent entries, some are updated at runtime with certain animations. In SkyTemple, slots 0 - 63 can always be seen. These are the sprites used for existing floor items. Slot 63 is unnused in the base game, and appears in SkyTemple as a blank, transparent sprite.

=== Sprite Slots ===
It is possible to add custom item sprites without interfering with most existing ones. The valid, usable slots are ''italicized''.

* '''Slots 0 - 62''' are existing floor item sprites
** '''''Slots 9, 45 and 48''', containing the gear, shell and bone sprites, are unused in the vanilla game and can be replaced with new item sprites '''(3)'''''
* '''''Slot 63''' can be given a new item sprite '''(1)'''''
* '''Slots 64 - 81''' will always be replaced by the game at runtime with status animation sprites
* '''''Slots 82 - 95''' can be given new item sprites '''(14)'''''
* Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row. Creating entries for these slots in SkyTemple (even if adding the correct sprites) ''will force the sprites to use Palette 0.'' This can affect entries that may have had different a palette originally assigned to them. For example, the ally shadows will no longer be shaded yellow, turning magenta instead. These entries include:
** 96: small enemy shadow (black)
** 97: big enemy shadow (black)
** 98: small ally shadow (yellow)
** 99: big ally shadow (yellow)
** 100: big ally shadow (yellow)
** 101: small arrow?
** 102: small arrow?
** 103: beta "for HP" text
* '''''Slots 104 - 107''' can be given new item sprites '''(4)'''''
* '''Slots 108 - 110''' will always be replaced by the game at runtime with water shadow animation sprites
* '''''Slots 111 - 119''' can be given new item sprites '''(9)'''''

Any new entry after that slot (120+) will roll over into the next set of tiles, which will overwrite attack animation sprites. In total, there are '''31 slots''' available for custom item sprites.

== Trap Sprites ==
''Explorers of Sky'' has 35 slots (numbered 0 - 34) used for trap sprites in dungeons. Note that some interactive elements like Wonder Tiles and stairs are considered traps, though they are obviously not malicious. The sprites can be seen in ''Dungeon Graphics > Traps''. These sprites only have 2 [[Item Data#Category and IDs|Palette IDs]] available.

=== Sprite Slots ===

# Blank (solid blue image)
# Mud Trap (uses Palette 1)
# Sticky Trap (uses Palette 1)
# Grimy Trap (uses Palette 1)
# Summon Trap (uses Palette 1)
# Pitfall Trap - unbroken (uses Palette 0)
# Warp Trap (uses Palette 1)
# Gust Trap (uses Palette 1)
# Spin Trap (uses Palette 1)
# Slumber Trap (uses Palette 1)
# Slow Trap (uses Palette 1)
# Seal Trap (uses Palette 1)
# Poison Trap (uses Palette 1)
# Selfdestruct Trap (uses Palette 1)
# Explosion Trap (uses Palette 1)
# PP-Zero Trap (uses Palette 1)
# Chestnut Trap (uses Palette 0)
# Wonder Tile (uses Palette 0)
# Pokémon Trap (uses Palette 1)
# Spiked Tile (uses Palette 0)
# Stealth Rock Trap (uses Palette 1)
# Toxic Spikes Trap (uses Palette 1)
# Trip Trap (uses Palette 0)
# Random Trap (uses Palette 1)
# Grudge Trap (uses Palette 1)
# Yellow floor grid outline (seen when pressing Y) (uses Palette 1)
# Pink floor grid outline showing direction player is facing (seen when pressing Y) (uses Palette 1)
# Stairs Down (uses Palette 0 or 1)
# Stairs Up (uses Palette 0 or 1)
# "P" Flag (uses Palette 1)
# Kecleon Shop carpet (uses Palette 1)
# Key Door (uses Palette 0 or 1)
# Pitfall Trap - broken (uses Palette 0)
# Blocked tile (uses Palette 1)
# Blank (solid blue image)

{{NavSkyTemple}}

Item Data

2025-12-26T19:12:02Z

Deltaflare: /* Text */ , missed word, context for action item vals

The ''Items'' section shows all items available in-game. SkyTemple offers the following sections for editing item properties.

== Category and IDs ==

* '''Sprite ID''': sprite used when displaying this object in a dungeon
* '''Palette ID''': set of colors used when displaying this object in a dungeon
* '''Item ID''': self-explanatory
* '''Category''': these are used when setting the item spawn settings on a dungeon floor
* '''Buy Price''': Poké price at Kecleon Market
* '''Sell Price''': Poké price at Kecleon Market

=== Categories Available ===

* Thrown – Pierce (item moves in a straight line)
* Thrown – Rock (item flies in an arc)
* Berries, Seeds, Vitamins
* Food, Gummies
* Hold (held items only)
* TMs, HMs
* Poké (Money)
* Unknown 7
* Other
* Orbs
* Link Boxes
* Used TM
* Treasure Box 1
* Treasure Box 2
* Treasure Box 3
* Exclusive Items

== Text ==

* '''Name''': self-explanatory
* '''Short description''': used when hovering over the item in the Treasure Bag
* '''Long description''': used when viewing the Info menu

== General ==

* '''Move ID''': The ID of a move that is associated with this item. ''Unless making a TM/HM, this should stay '''0'''.'' Example of TM Focus Punch vs. Stick (a stackable item):
<gallery mode="packed" widths="420" heights="150">
File:ST TM Example.png|alt=SkyTemple UI showing the General settings for the Focus Punch TM. This highlights that the Move ID field is set to 75, corresponding to the move Focus Punch.|Move ID is set to 75 (the ID for Focus Punch)
File:ST Stick Example Settings.png|alt=SkyTemple UI showing the General settings for the Stick item. This highlights that the Move ID field is set to 0 (no move is associated with it), and that it has stackable settings.|Move ID is set to 0
</gallery>
* '''Min Amount (for stackable items)''': indicates the minimum amount you can get for 1 instance of that item.
* '''Max Amount (for stackable items)''': indicates the maximum amount you can get for 1 instance of that item.
* '''Action Name''': String displayed in dungeon menus. These can be changed in “Text Strings.”

=== Default Action Item Values ===

* 0: Use
* 1: Hurl
* 2: Throw
* 3: Equip
* 4: Eat
* 5: Ingest
* 6: Peel (meant for use with the ''Banana'' item seen in Rescue Team, which was removed in Explorers)
* 7: Use
* 8: Use
* 9: Use
* 10: Use
* 11 Equip
* 12: Equip
* 13: Use
* 14: Use
* 15: Use

== Flags ==

* '''Is Valid''': ''This should always be on if you want to use the item!'' Otherwise it cannot be added to the dungeon spawn menus, and will show up as a nonfunctional Plain Seed if manually added to the Treasure Bag.
* '''Is T/D''': Is this item originally present in Time or Darkness versions?
* '''AI Flag: Throw at enemies''': Do you want allies to throw this item at enemies? (ex: Gravelerocks or Sticks)
* '''AI Flag: Throw at allies''': Do you want allies to throw this item at you or other allies? (ex: healing items)
* '''AI Flag: Use on self''': Do you want allies to use this item on themselves? (ex: healing items)
{{NavSkyTemple}}

User:Deltaflare

2025-05-28T16:31:27Z

Deltaflare: Blanked the page

List of Opcodes

2025-04-22T01:04:36Z

Deltaflare: /* 0xaa - message_SwitchMenu */

The scripting engine used in Explorers of Sky has different opcodes. [[ExplorerScript]] translates most of them literally, preserving the same parameters and functionality. However, some opcodes are translated to [[ExplorerScript]] constructs, such as if statements.

This article documents the different opcodes, their purpose and parameters. The purpose of unkX parameters is unknown.

== What is an opcode? ==
An opcode is an instruction to the machine (it tells the machine to 'do' something). In modern programming, it would be most similar to a [https://en.wikipedia.org/wiki/Function_(computer_programming) function]. For a more technical description, see [https://en.wikipedia.org/wiki/Opcode here].

== Types of parameters ==
* uint: An unsigned integer (a number without decimals). It cannot be negative. It is possible that in the game's code, there are only signed integers and no unsigned integers, but not enough research has been done on the matter. For the most part, it shouldn't matter.
* sint: A signed integer (a number without decimals). It can be either positive or negative.
* bitfield: A bitfield is uint where each bits (0 or 1) are treated independantly. They are used to store multiple binary (boolean) values efficiently. Opcodes that use it usually come in the <code>Set</code> and <code>Reset</code> variant. The <code>Set</code> variant define to true the values which are 1 in the input bitfield (while leaving the others untouched), and <code>Reset</code> define to false the values which are 1 in the input bitfield (while also leaving the others untouched).
* String: Text (i.e dialogue). There should always be a quotation mark (") at the beginning and end.
* ConstString: Same as String.
* Routine: Any of the 701 coroutines from [[Unionall]]. Always begins with "CORO_"
* Entity: An actor, performer. (not an object!)
* Object: An object in a scene. (not an actor or perfomer!)
* Level: Any level from the [[Script Engine|Level List]]. Will always begin with "LEVEL_".
* Bgm: Any music in the game. Will always begin with "BGM_". (example: BGM_CRAGGY_COAST)
* PositionMark: A position. Will be written as "Position<'MarkName', x, y>". Once a position mark is written in a script, SkyTemple will show an option to place it visually in the scene.
* Face: A portrait expression. Will always begin with "FACE_". (examples: FACE_NORMAL, FACE_HAPPY, FACE_PAIN)
* FaceMode: A portrait position. Will always begin with "FACE_MODE_".
* Direction: A direction for an entity to move in or turn to. Will always begin with "DIR_". (examples: DIR_UP, DIR_RIGHT)
* ProcessSpecial: One of the games special processes. Can be referred to by its number, or name.
* Effect: A graphical effect.
* GameVar: Any of the game's [[List of Script Variables|Script Variables]]. Will always begin with "$".

== Relevant Opcodes ==
These opcodes can be directly called from ExplorerScript.

=== 0x0 - Null ===
Does nothing.

No parameters.
=== 0x1 - back_ChangeGround ===
Sets the Map Background from a Level without changing the chunks from the currently loaded Map Background. Entities such as actors, objects, and performers will not be deleted when this opcode is executed.

This has very few uses in the game—a notable use is how Wigglytuff's Chamber has its door open, as seen via LEVEL_G01P04A and LEVEL_G01P04A2.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x2 - back_SetBackEffect ===
Performs various effects related to the currently loaded Animation Palettes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x3 - back_SetBackScrollOffset ===
Shifts the background by a certain number of pixels, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level is hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level is hardcoded.
|}

=== 0x4 - back_SetBackScrollSpeed ===
Continuously scrolls the background at a certain speed, without affecting entities such as actors, objects, or performers. Backgrounds used with this opcode will display a "loop" effect, i.e., it has the appearance of scrolling forever.

This opcode seems to only work for only a few Levels, such as LEVEL_P13P01A, LEVEL_S13P06A, and LEVEL_V03P11A.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint16
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint16
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x5 - back_SetBanner ===
Displays broken text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x6 - back_SetBanner2 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is typically used for chapter introductions, which includes chapter text and a subtitle displayed over a Map Background. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|-
|2
|uint
|unk1
|Currently unknown. Typically, the game uses 0 for this parameter, but it seems to have no effect.
|-
|3
|uint
|x
|The pixel position the camera will center the Map Background on its X-axis.
|-
|4
|uint
|y
|The pixel position the camera will center the Map Background on its Y-axis.
|-
|5
|sint
|chapter_number
|The chapter number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|6
|String
|title
|The title of the chapter, e.g., "A Storm At Sea" for Chapter 1.
|}
=== 0x7 - back_SetEffect ===
Performs various effects related to the current Map Background's layers across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x8 - back_SetDungeonBanner ===
Displays a specific string using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. The text chosen is defined in Dungeons tab as a dungeon's <code>back_SetDungeonBanner</code> string. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|The ID of a dungeon, as listed in the Dungeons tab of SkyTemple.
|-
|2
|uint
|unk1
|Currently unknown. Does not seem to affect much.
|}
=== 0x9 - back_SetGround ===
Sets the Map Background from a Level. Upon using this opcode, the variable <code>$GROUND_MAP</code> will be updated to match the ID of the chosen Level. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0xa - back_SetSpecialEpisodeBanner ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is used for Special Episodes 1-3. This opcode plays a short animation of a green line shooting across the screen, followed by text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xb - back_SetSpecialEpisodeBanner2 ===
Displays text using the <code>FONT/banner_c.bin:FONT/b_pal_r.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 4. This opcode features an elaborate animation featuring hearts and sparkles, along with text scrolling across the screen horizontally from opposite directions. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xc - back_SetSpecialEpisodeBanner3 ===
Displays text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode is only used for Special Episode 5. This opcode features no animation, but the end result is similar to the opcode <code>back_SetSpecialEpisodeBanner</code>. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|episode_number
|The episode number displayed for the banner. A value of -1 will be "Final Chapter".
|-
|2
|String
|title
|The title of the episode, e.g., "Bidoof's Wish" for Special Episode 1.
|}
=== 0xd - back_SetTitleBanner ===
Displays user-defined text using the <code>FONT/banner.bin:FONT/b_pal.bin</code> font, editable in the Misc. Graphics tab of SkyTemple. This opcode will delete any actors, objects, and performers that are currently loaded.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|y
|The Y-axis pixel position of the title.
|-
|2
|String
|title
|The title displayed on the Touch Screen.
|}
=== 0xe - back_SetWeather ===
Displays a weather effect that overlays the current Map Background.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}
=== 0xf - back_SetWeatherEffect ===
Currently unknown. The only values this opcode accepts seems to be 1, 2, and 3. Its only known use is in V00P02/m01a04a.ssb, which is a test script used by the developers.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x10 - back_SetWeatherScrollOffset ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x11 - back_SetWeatherScrollSpeed ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x12 - back2_SetBackEffect ===
The same as <code>back_SetBackEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect_id
|
# The default state of the Animation Palette.
# Plays the Animation Palette in a loop.
# Plays the Animation Palette once.
# Freezes the Animation Palette at its current frame.
# Resumes the Animation Palette.
|}
=== 0x13 - back2_SetBackScrollOffset ===
The same as <code>back_SetBackScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|offset0
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|offset1
|The number of pixels to shift either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}

=== 0x14 - back2_SetBackScrollSpeed ===
The same as <code>back_SetBackScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|speed0
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 X-axis.
* The Map Background's Layer 1 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|-
|2
|sint
|speed1
|The speed to scroll either:

* The Map Background's Layer 1 and Layer 2 Y-axis.
* The Map Background's Layer 2 X-axis.

Which one the game performs for a given Level seems to be hardcoded.
|}
=== 0x15 - back2_SetData ===
Currently unknown. This opcode is not used in the base game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x16 - back2_SetEffect ===
The same as <code>back_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|effect
|
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 2 to Layer 1.
* Fades in Layer 1 from total darkness.
* Transitions from Layer 1 to Layer 2.
* Fades out Layer 1 to total darkness.
* Merges Layer 1 onto Layer 2, but fades in Layer 1 from total darkness.
* Fades in Layer 1 from total darkness.
* Merges Layer onto Layer 2, but fades out Layer 1 to total darkness.
* Fades out Layer 1 to total darkness.
|-
|2
|uint
|duration
|The number of frames used to play a given effect.

|}
=== 0x17 - back2_SetGround ===
Mostly the same as <code>back_SetGround</code>, but for the Top Screen. This opcode only works if <code>back2_SetMode(4);</code> is used prior to this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. This opcode will pull from the Level's Map Background.
|}
=== 0x18 - back2_SetMode ===
Determines a hardcoded status of the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|A value of 0 is no mode. A negative value seems to set the Top Screen to the overworld's current Top Screen setting.

# Fades out the Top Screen.
# Team Stats.
# The Map Background S01P01A with the hero idling on a World Map Marker.
# Allows for the Top Screen to display a Map Background from a Level using the <code>back2_SetGround</code> opcode.
# Splits the Map Background used in the Level defined by <code>back_SetGround</code> equally between the Top and Touch Screen.
#Splits the Map Background used in the Level defined by <code>back_SetGround</code> between the Top and Touch Screen.
|}
=== 0x19 - back2_SetSpecialActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0x1a - back2_SetWeather ===
The same as <code>back_SetWeather</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|weather_id
|Values of 0 and below mean no weather effect is to be displayed.

# Dark, unmoving clouds.
# Dark, unmoving clouds.
# Clouds.
# No weather.
# Clouds.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Fog.
# No weather.
# Unknown; does not seem to have a visible effect, but it loads something into memory.
# Unknown; seems to either softlock the game or drastically change the current Map Background.
# Purple smog.
|}

=== 0x1b - back2_SetWeatherEffect ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x1c - back2_SetWeatherScrollOffset ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollOffset</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1d - back2_SetWeatherScrollSpeed ===
Currently unknown. Potentially has similar functionality as <code>back_SetWeatherScrollSpeed</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x1e - bgm_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x1f - bgm_Play ===
Instantly plays a BGM on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x20 - bgm_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x21 - bgm_Stop ===
Instantly stops the BGM that is currently playing on the first BGM track.

No parameters.
=== 0x22 - bgm_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the first BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x23 - bgm2_FadeOut ===
Fades out the BGM that is currently playing over a certain period of time on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out and silence a given BGM.
|}
=== 0x24 - bgm2_Play ===
Instantly plays a BGM on the second BGM track.
{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|}
=== 0x25 - bgm2_PlayFadeIn ===
Starts playing a BGM over a certain period of time and at a certain volume on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A music track defined in SOUND/BGM of the ROM.
|-
|2
|uint
|duration
|The number of frames used to fade in the BGM.
|-
|3
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x26 - bgm2_Stop ===
Instantly stops the BGM that is currently playing on the second BGM track.

No parameters.
=== 0x27 - bgm2_ChangeVolume ===
Changes the volume of the BGM that is currently playing on the second BGM track.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames to change the BGM's volume.
|-
|2
|uint
|volume
|The volume that the BGM will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0x38 - CallCommon ===
Jumps to the specified Unionall Coroutine, runs its code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the Coroutine). This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub).

If used in the context of an actor/object/performer, this should not be used in with-statements.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x39 - camera_Move2Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3a - camera_Move2MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3b - camera_Move2Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x3c - camera_Move2PositionMark ===
Moves the camera to one or more Position Marks without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x3d - camera_Move2PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x3e - camera_Move3Default ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x3f - camera_Move3MyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x40 - camera_Move3Myself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x41 - camera_Move3PositionMark ===
Moves the camera to one or more Position Marks in a rapid, strange motion.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x42 - camera_Move3PositionMark ===
Moves the camera to a Position Mark without restricting the angles used.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x43 - camera_MoveDefault ===
Moves the camera toward an active Type 1 actor (e.g., ACTOR_PLAYER) while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x44 - camera_MoveMyPosition ===
Moves the camera toward a specific entity's position (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x45 - camera_MoveMyself ===
Moves the camera toward a specific entity (i.e., an actor, object, or performer) while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x46 - camera_MovePositionMark ===
Moves the camera to one or more Position Marks while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x47 - camera_MovePositionMark ===
Moves the camera to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x48 - camera_SetDefault ===
Instantly sets the camera to a Type 1 actor (e.g., ACTOR_PLAYER).

No parameters.
=== 0x49 - camera_SetEffect ===
Continuously shakes the camera at specified intensities. Entities will be affected by the camera shaking, but not textboxes and portraits. The camera will continue to shake even if it is moved using another opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x4a - camera_SetMyPosition ===
Instantly sets the camera toward a specific entity's position (i.e., an actor, object, or performer).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4b - camera_SetMyself ===
Instantly sets the camera to a specific entity (i.e., an actor, object, or performer). Once performed, the camera will now follow the entity wherever it moves.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x4c - camera_SetPositionMark ===
Instantly sets the camera to a Position Mark.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x4d - camera2_Move2Default ===
The same as <code>camera_Move2Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4e - camera2_Move2MyPosition ===
The same as <code>camera_Move2MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x4f - camera2_Move2Myself ===
The same as <code>camera_Move2Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x50 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x51 - camera2_Move2PositionMark ===
The same as <code>camera_Move2PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x52 - camera2_Move3Default ===
The same as <code>camera_Move3Default</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x53 - camera2_Move3MyPosition ===
The same as <code>camera_Move3MyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x54 - camera2_Move3Myself ===
The same as <code>camera_Move3Myself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|}
=== 0x55 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x56 - camera2_Move3PositionMark ===
The same as <code>camera_Move3PositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Supposedly movement speed based off of similar opcodes, but does not seem to affect much.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x57 - camera2_MoveDefault ===
The same as <code>camera_MoveDefault</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x58 - camera2_MoveMyPosition ===
The same as <code>camera_MoveMyPosition</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x59 - camera2_MoveMyself ===
The same as <code>camera_MoveMyself</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|}
=== 0x5a - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x5b - camera2_MovePositionMark ===
The same as <code>camera_MovePositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0x5c - camera2_SetDefault ===
The same as <code>camera_SetDefault</code>, but for the Top Screen.

No parameters.
=== 0x5d - camera2_SetEffect ===
The same as <code>camera_SetEffect</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Values of 0 or 3+ mean the camera will not shake.

# Erratic, jerky shaking.
# Subdued, smoother shaking.
|-
|2
|uint
|intensity
|The intensity of the shake. Higher values will result in a more intense shake.
|-
|3
|uint
|speed
|Movement speed. Higher values result in a slower speed.
|}
=== 0x5e - camera2_SetMyPosition ===
The same as <code>camera_SetMyPosition</code>, but for the Top Screen.

No parameters.
=== 0x5f - camera2_SetMyself ===
The same as <code>camera_SetMyself</code>, but for the Top Screen.

No parameters.
=== 0x60 - camera2_SetPositionMark ===
The same as <code>camera_SetPositionMark</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0x61 - CancelCut ===
Reverses the effects of the opcode <code>CancelRecoverCommon</code>, i.e., disallows the game from reloading Unionall at a Coroutine by pressing the Start button.

No parameters.
=== 0x62 - CancelRecoverCommon ===
Allows reloading Unionall at a specified Coroutine by pressing the Start button. This can be done in a cutscene and the overworld.

Once the Start button is pressed, the game will stop the current script, fade out the entire screen, and reload Unionall and begin running code at the specified Coroutine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x6a - debug_Assert ===
Does nothing in the final game.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x6b - debug_Print ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6c - debug_PrintFlag ===
Does nothing in the final game.

If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with the value of the specified script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. Indexed variables are not encouraged to use, since the Debug Log will only read from the first index.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6d - debug_PrintScenario ===
If the script is running using SkyTemple's debugger and the "Script Debug" checkbox is ticked, the specified string will be printed to the Debug Log, along with two indices of the specified script variable.

This opcode's Debug Log implementation currently seems broken, as it prints the first index of the specified variable twice.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|One of the 115 possible script variables. A two-indexed variable (e.g., <code>$SCENARIO_MAIN</code>) is encouraged to use.
|-
|2
|ConstString
|txt
|A string to be printed to the Debug Log.
|}
=== 0x6f - Destroy ===
Instantly removes an active entity (i.e., an actor, object, or performer) from memory.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.

=== 0x71 - EndAnimation ===
Stops an actor or object's looping animation once it reaches the end of its animation frames.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

No parameters.
=== 0x72 - ExecuteActing ===
Currently unknown.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0x73 - ExecuteCommon ===
Jumps to a Unionall Coroutine, runs its code, and returns to the line in which this opcode was called. This opcode should be called if the specified Coroutine ends with <code>hold;</code>. Typically, the base game uses this command with Coroutines whose names end with "FUNC_SERIES".

This opcode does not have a parameter for an entity, as it must be used in a with-statement.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|-
|2
|uint
|unk1
|Unknown.
|}
=== 0x81 - Flash ===
Zeroes-out the return address used by the <code>Return</code> opcode. This opcode is not used in the base game.

No parameters.
=== 0x83 - item_GetVariable ===
Saves the value in a specific item slot (set by <code>item_Set</code>) to a script variable.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the indexed variables. Non-indexed values causes the IndexError.
|}
=== 0x84 - item_Set ===
Sets an item into an item slot, which can be used by other various <code>item_</code> opcodes.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

Item slots 0-3 are safe to use, but item slots 4 and beyond will begin to overwrite other memory!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|item_id
|The ID of the item, where all are listed in the Items tab of SkyTemple.
|-
|3
|uint
|item_stack
|The stack count of an item, if it belongs to a Thrown category. Treasure Boxes will also use this as the item earned when opening the box at Xatu's Appraisal.
|}
=== 0x85 - item_SetTableData ===
Sets a random item from predefined tables into an item slot, which can be used by other various <code>item_</code> opcodes. This opcode is used mainly in Spinda's Cafe, for redeeming a random Recycle Shop prize and for receiving items from Treasure Town NPCs after giving them Sky Gifts.

Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|uint
|table
|Some unknown item tables related to Spinda's Cafe.
|}
=== 0x86 - item_SetVariable ===
Saves the value of a script variable to an item slot. Items in slot 0 may also be added to the player's bag and storage with hardcoded menus, such as <code>message_Menu(MENU_GIVE_ITEM);</code> and <code>message_Menu(MENU_GIVE_ITEM2);</code>, respectively. Additionally, the text tag <code>[s_item:X]</code> will display the item's name, where X is the item slot number.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|slot
|An item slot used by many <code>item_</code> opcodes.
|-
|2
|GameVar
|var
|One of the 115 possible script variables.
|}
=== 0x88 - JumpCommon ===
Jumps to the specified Unionall Coroutine and runs its code, without returning to the line in which this opcode was first used. This opcode can be used in any script, no matter the type (Common, Enter, Acting, or Sub), but is mostly used by the base game in Unionall.

If attempting to execute a Unionall Coroutine from inside an Enter, Acting, or Sub script to play Acting scripts, use <code>supervision_ExecuteCommon</code> instead.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|One of the 701 possible Unionall Coroutines.
|}
=== 0x8a - LoadPosition ===
Sets various attributes of an entity (i.e., an actor, object, or performer) to the values of all indexed <code>$POSITION_</code> script variables. These include changing the entity's X and Y coordinates, height, and direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0x8b - Lock ===
Suspends the current routine until the opcode <code>Unlock</code> is called with the same ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x8c - main_EnterAdventure ===
Performs various functions related to entering a dungeon using the crossroads menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|mode
|Most modes are not known, but:

* 32767 opens the dungeon selection menu.
* 251 stops the current script to reload Unionall starting from the Coroutine CORO_MOVE_WORLD_MAP.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x8d - main_EnterDungeon ===
Attempts to exit ground mode and begins dungeon mode at a specific dungeon.

If attempting to run this opcode before selecting any option from the Top Menu, the game will not enter any dungeon and instead attempt to load a DEMO Unionall coroutine or the Top Menu.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|dungeon_id
|The dungeon ID to enter, which are all listed in the Dungeons tab of SkyTemple. A value of -1 actually enters dungeon mode—it is insufficient to use this opcode a single time to enter a specific dungeon.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8e - main_EnterGround ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: Set to 0.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x8f - main_EnterGroundMulti ===
Stops the current script to reload Unionall starting from the Coroutine CORO_EVENT_DIVIDE. This opcode also updates the following script variables:

* <code>$GROUND_ENTER</code>: This opcode's ''level_id_enter'' parameter.
* <code>$GROUND_ENTER_LINK</code>: This opcode's ''level_id_link'' parameter.
* <code>$GROUND_GETOUT</code>: The value of <code>$GROUND_ENTER</code> prior to using this opcode.
* <code>$GROUND_MAP</code>: The Level ID used to display the Map Background.
* <code>$GROUND_PLACE</code>: The World Map Marker ID that determines where the player appears on the Top Screen when selecting "Map and team" in the overworld.
* <code>$GROUND_START_MODE</code>: Set to 3.

In the base game, using this opcode allows for transitioning between Levels in the Overworld, as the game will eventually run the <code>supervision_ExecuteEnter</code> opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id_enter
|An entry in the Level List. Ideally, this opcode would load the specified Level's Enter00 script.
|-
|2
|uint
|duration
|The number of frames used to fade out the screens.
|-
|3
|Level
|level_id_link
|An entry in the Level List. Used to update <code>$GROUND_ENTER_LINK</code>.
|}
=== 0x90 - main_EnterRescueUser ===
Exits ground mode and begins dungeon mode while taking an SOS Mail. Dungeon selection seems to be determined by the SOS Mail chosen via <code>message_Menu(MENU_S_O_S_MAIL_PICKER);</code>.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade out the screens.
|}
=== 0x91 - main_EnterTraining ===
Performs various functions related to entering a dungeon using Marowak Dojo.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens the generic dojo selection menu
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x92 - main_EnterTraining2 ===
Performs various functions related to entering a dungeon using Marowak Dojo's Final Maze.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Most modes are not known, but:

* 32767 opens a dojo selection menu that only involves Final Maze.
* 251 goes to the Coroutine CORO_GOTO_TRAINING_DUNGEON, which later stops the current script to reload Unionall starting from the Coroutine CORO_ENTER_TRAINING_DUNGEON.
|-
|2
|uint
|unk1
|Currently unknown.
|}
=== 0x93 - main_SetGround ===
Updates the following variables' values to be this opcode's ''level_id'' parameter:

* <code>$GROUND_ENTER</code>
* <code>$GROUND_GETOUT</code>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level_id
|An entry in the Level List.
|}
=== 0x94 - me_Play ===
Instantly plays a special [[sound effect]] that can seamlessly interrupt any BGM tracks that are currently playing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|me_id
|A sound effect defined in SOUND/ME of the ROM.
|}
=== 0x95 - me_Stop ===
Instantly stops the currently-playing special [[sound effect]] called with <code>me_Play</code>.

No parameters.
=== 0x96 - message_Close ===
Suspends the current routine and allows for closing an active textbox (and portrait, if active) set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

By pressing the A Button, B Button, or tapping the textbox via the Touch Screen. Once the textbox is closed, the current routine resumes.

No parameters.
=== 0x97 - message_CloseEnforce ===
Instantly closes an active textbox (and portrait, if active) once the game finishes displaying a string set by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

No parameters.
=== 0x98 - message_Explanation ===
Displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine.

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x99 - message_FacePositionOffset ===
Offsets the active portrait in pixels by multiples of 8.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|The offset to shift the portrait box across the X-axis.
|-
|2
|sint
|y
|The offset to shift the portrait box across the Y-axis.
|}
=== 0x9a - message_ImitationSound ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9b - message_KeyWait ===
If an active textbox has finished displaying its string and was created by one of the following opcodes:

* <code>message_ImitationSound</code>
* <code>message_Mail</code>
* <code>message_Monologue</code>
* <code>message_Notice</code>
* <code>message_SpecialTalk</code>
* <code>message_Talk</code>

This opcode suspends the current routine until the A Button, B Button or textbox is pressed (via the Touch Screen). Once done so, the textbox will not close, but the current routine will resume.

No parameters.
=== 0x9c - message_Mail ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9d - message_Menu ===
Executes various hardcoded "menu" functionalities given a certain ID. Some IDs result in an actual menu, while others simply perform a silent task.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Menu
|menu_id
|The ID of a menu, the list of which can be seen by typing <code>MENU_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x9e - message_Monologue ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. No sound will emit from the text scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0x9f - message_Narration ===
Fades in the screen and instantly displays the string defined in the ''txt'' parameter centered in the middle of the Touch Screen. The string will appear without any frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple). This opcode does not need <code>message_Close</code> to suspend the routine. Once the routine is resumed (by pressing the A Button, B Button, or text via the Touch Screen), the screen will fade out, including the string.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to fade in/out the Touch Screen.
|-
|2
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa0 - message_Notice ===
Instantly displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode does not support displaying a portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xa1 - message_EmptyActor ===
Disallows a portrait from appearing alongside a textbox, along with disallowing a name to appear in the textbox if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa2 - message_ResetActor ===
Disallows a portrait from appearing alongside a textbox, along with setting a speech bubble (the text tag [M:T1]) to the start of next script string if <code>message_Talk</code> follows this opcode.

No parameters.
=== 0xa3 - message_SetActor ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xa4 - message_SetFace ===
Sets the specified actor's name to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa5 - message_SetFaceEmpty ===
Displays a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa6 - message_SetFaceOnly ===
Sets a speech bubble (the text tag [M:T1]) to the start of the next script string if <code>message_Talk</code> follows this opcode. Will also display a portrait of the actor's species at a specified position if <code>message_Talk</code> or <code>message_Monologue</code> follow this opcode.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|-
|2
|Face
|face_id
|The ID of a portrait, the list of which can be seen by typing FACE_ in SkyTemple's Script Engine Debugger.
|-
|3
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa7 - message_SetFacePosition ===
Re-positions an actor's portrait.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|FaceMode
|face_mode
|The position of a portrait, the list of which can be seen by typing <code>FACE_POS_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xa8 - message_SetWaitMode ===
Makes strings displayed with a <code>message_</code> opcode auto-scroll. For both parameters, a value of -1 means the auto-scroll will stop.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|duration0
|Sets the frame count for a textbox auto-advancing, once the end of the string has been displayed and the following opcode is <code>message_KeyWait();</code>.
|-
|2
|sint
|duration1
|Sets the frame count for text tags such as [K] auto-advancing.
|}
=== 0xa9 - message_SpecialTalk ===
Displays a random Text String based off of the actor ACTOR_TALK_SUB's Talk Group.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|category
|A category of Text String.

* 0 seems to use Text Strings while not in a dungeon (e.g., teammates waiting at Spinda's Cafe).
* 1 seems to be use Text Strings while mid-dungeon (e.g., teammates at Amp Plains).
|}
=== 0xae - message_Talk ===
Displays the string defined in the ''txt'' parameter at the bottom of the Touch Screen. The string will appear surrounded by a player-chosen frame defined in <code>FONT/frameX.wte</code> (as seen in the Misc. Graphics tab of SkyTemple).

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|Text to be displayed on the Touch Screen.
|}
=== 0xaf - Move2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb0 - Move2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without restricting the angles used.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb1 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0xb2 - Move2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xb3 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xb4 - Move2PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xb5 - Move2PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xb6 - Move3Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xb7 - Move3PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor in a rapid, strange motion.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xb8 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xb9 - Move3PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xba - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xbb - Move3PositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xbc - Move3PositionOffsetRandom ===
Continuously and randomly offsets an entity (i.e., an actor, object, or performer) from its current position across both axes in a rapid, strange motion.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|Determines something about the random pixel value chosen to apply to the X-axis; somewhat unknown.
|-
|3
|sint
|y
|Determines something about the random pixel value chosen to apply to the Y-axis; somewhat unknown.
|}
=== 0xbd - MoveDirection ===
Offsets an entity (i.e., an actor, object, or performer) by a certain number of pixels based on a given direction. Movement is performed while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|offset
|The pixel offset to shift the entity relative to the entity's direction.
|-
|3
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0xbe - MoveHeight ===
Moves an entity (i.e., an actor, object, or performer) to a certain pixel height, displacing it from its shadow. When used, the entity's animation and direction will not change.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
|-
|2
|sint
|height
|The pixel height to set the entity relative to their shadow.
|}
=== 0xbf - MovePosition ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}
=== 0xc0 - MovePositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0xc1 - MovePositionLivesTime ===
Moves an entity (i.e., an actor, object, or performer) to an actor while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the actor or after a certain number of frames have passed—whichever comes first.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|Entity
|actor_id
|An entry in the Actor List.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc2 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}
=== 0xc3 - MovePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}
=== 0xc4 - MovePositionMarkTime ===
Moves an entity (i.e., an actor, object, or performer) to an Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Movement will end once either the entity reaches the Position Mark or after a certain number of frames have passed—whichever comes first.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|-
|3
|uint
|duration
|The number of frames used to move the entity.
|}
=== 0xc5 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|sint
|x, y
|The pixel offset to shift the entity across the X or Y-axis.
This parameter may be repeated multiple times.
|}
=== 0xc6 - MovePositionOffset ===
Offsets an entity (i.e., an actor, object, or performer) from its current position across both axes while restricting movement by eight angles—as if movement was performed using the D-Pad.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|sint
|x
|The pixel offset to shift the entity across the X-axis.
|-
|3
|sint
|y
|The pixel offset to shift the entity across the Y-axis.
|}
=== 0xc7 - MoveSpecial ===
Currently unknown. Seems to move an entity (i.e., an actor, object, or performer) based on some hardcoded behaviors.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|mode
|Determines the kind of action.

# Spin and move in a circular motion.
# Spin and move in a circular motion.
# Currently unknown.
# Currently unknown.
# Currently unknown. Seems to be the most commonly-used value, as a part of the Unionall Coroutine CORO_LIVES_REPLY_NOMRAL.
|-
|2
|uint
|unk1
|Currently unknown. Seems to affect how far the entity will move?
|-
|3
|uint
|unk2
|Currently unknown.
|}
=== 0xc8 - MoveTurn ===
Moves an entity (i.e., an actor, object, or performer) based on a certain pattern. Unlike other <code>Move</code> opcodes, this opcode will make the entity interact with the currently loaded Map Background's collision (i.e., the entity stops when hitting a wall).

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|distance
|How far the entity will move. Higher values result in greater distance being covered.
|-
|2
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.

This parameter also seems to affect the distance traveled.
|-
|3
|uint
|pattern
|A hardcoded pattern to move in.

# Moves in a circle clockwise.
# Moves in a circle counterclockwise.
# Moves in a square clockwise.
# Moves in a square counterclockwise.
# Zig-zags back and forth.

Values 6 and above seem to be variations of random movement.
|}
=== 0xca - PauseEffect ===
Instantly pauses the current graphical effect of an entity (i.e., an actor, object, or performer). The effect will freeze mid-frame.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xcc - ProcessSpecial ===
Executes one of the game's Special Processes. The return value of a Special Process can be checked by encasing this opcode in a <code>switch</code> statement. A negative return value is not acceptable and will cause the game to suspend indefinitely.

This opcode cannot be used in targeted routines.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ProcessSpecial
|process_id
|One of the game's Special Processes.
|-
|2
|sint
|process_param1
|The first parameter used by the Special Process.
|-
|3
|sint
|process_param2
|The first parameter used by the Special Process.
|}
=== 0xcd - PursueTurnLives ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xce - PursueTurnLives2 ===
Causes an entity (i.e., an actor, object, or performer) to continuously turn toward an actor for a certain number of frames.

This opcode must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames used to make the entity turn. A value of 0 will make the entity turn forever.
|-
|2
|uint
|speed
|Turning speed. Higher values result in a slower speed.
|-
|3
|Entity
|actor_id
|The actor to turn toward.
|-
|4
|uint
|rotation
|
# Clockwise.
# Counterclockwise.

A value of 10 will make the entity choose the nearest rotation.
|}
=== 0xcf - ResetAttribute ===
Currently unknown. Seems to get ignored when parsed in the scripting engine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Currently unknown.
|}
=== 0xd0 - ResetFunctionAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "function" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|function_bitfield
|Most bits' purposes are unknown. Bit 1 appears to be the bit used for allowing an entity to follow a Type 1 actor, like the actor ACTOR_ATTENDANT1 in the overworld.
|}
=== 0xd1 - ResetHitAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "hit" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|hit_bitfield
|Most bits' purposes are unknown.

* 2: Entity collision.
* 6: Talk Script upon collision.
* 7: Talk Script upon pressing the A Button near the entity.
|}
=== 0xd2 - ResetOutputAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "output" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|output_bitfield
|
# Underlay below entities.
# Overlay above entities.
# Overlay above the current Map Background's Layer 2.
# Overlay above the game's canvas system, which includes the textbox, portrait, and some <code>screen_</code> commands that do not end in <code>All</code>.
# Flicker.
# Transparency.
# Invisibility.
# Displays shadow.
|}
=== 0xd3 - ResetReplyAttribute ===
Sets certain bits of an entity's (i.e., an actor, object, or performer) "reply" attribute to 0.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|reply_bitfield
|Most bits' purposes are unknown.

* 1: Talk Script upon collision.
* 2: Talk Script upon pressing the A Button near the entity.
* 6: Underlay below entities.
* 7: Overlay above entities.
|}
=== 0xd4 - ResumeEffect ===
Resumes the current graphical effect of an entity (i.e., an actor, object, or performer) that has been paused with <code>PauseEffect</code> prior to using this opcode.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|A graphical effect to display relative to an entity.
|}
=== 0xd6 - SavePosition ===
Saves various attributes of an entity (i.e., an actor, object, or performer) to the following script variables:

* <code>$POSITION_X</code>: The pixel position of the entity on the X-axis multiplied by 256.
* <code>$POSITION_Y</code>: The pixel position of the entity on the Y-axis multiplied by 256.
* <code>$POSITION_HEIGHT</code>: The pixel height (i.e., displacement of the entity from their shadow) of the entity multiplied by 256.
* <code>$POSITION_DIRECTION</code>: The direction the entity is facing.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|Index used by all <code>$POSITION_</code> script variables, ranged from 0-2 (inclusive).
|}
=== 0xd7 - screen_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd8 - screen_FadeChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xd9 - screen_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xda - screen_FadeInAll ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdb - screen_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdc - screen_FadeOutAll ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xdd - screen_FlushChange ===
Does nothing.
{| class="wikitable"
|+Parameters
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}

=== 0xde - screen_FlushIn ===
Changes the color of the screen from a specific state (given by the opcode's parameters, which affect the Touch Screen instantly) to its default state across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xdf - screen_FlushOut ===
Changes the color of the screen across a certain number of frames. This opcode will affect all entities (i.e., actors, objects, and performers) on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Touch Screen.
# Completely turns the Touch Screen to a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with a certain color.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Touch Screen?
# Overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
# Instantly overlays the Touch Screen with hardcoded color bytes: All 255. The Touch Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xe0 - screen_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe1 - screen_WhiteChangeAll ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xe2 - screen_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOut</code>, use <code>screen_FadeIn</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe3 - screen_WhiteInAll ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen_WhiteOutAll</code>, use <code>screen_FadeInAll</code> to restore the Touch Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xe4 - screen_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will not affect:

* Entities who have had their 4th "output" bit set to 1 (e.g., by using <code>SetOutputAttribute(16);</code> with them).
* Portraits.
* Textboxes.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe5 - screen_WhiteOutAll ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Touch Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Touch Screen's brightness.
|}
=== 0xe6 - screen2_FadeChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and 1 is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a black screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a white screen.
|}
=== 0xe7 - screen2_FadeChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xe8 - screen2_FadeIn ===
Changes the brightness of the screen to its default state across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xe9 - screen2_FadeInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xea - screen2_FadeOut ===
Changes the brightness of the screen to its minimum (i.e., a black screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xeb - screen2_FadeOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xec - screen2_FlushChange ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|-
|5
|uint
|unk4
|Does nothing.
|-
|6
|uint
|unk5
|Does nothing.
|-
|7
|uint
|unk6
|Does nothing.
|-
|8
|uint
|unk7
|Does nothing.
|}
=== 0xed - screen2_FlushIn ===
The same as <code>screen_FlushIn</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xee - screen2_FlushOut ===
The same as <code>screen_FlushOut</code>, but for the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's color.
|-
|3
|uint
|mode
|
# Completely darkens the Top Screen.
# Completely turns the Top Screen to a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with a certain color.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 144, 144, and 255.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: 255, 192, and 128.
# Instantly darkens the Top Screen?
# Overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
# Instantly overlays the Top Screen with hardcoded color bytes: All 255. The Top Screen is not turned completely white.
|-
|4
|uint
|r
|Unused if ''mode'' is not 2 or 4. Byte used for the color red. Has a minimum of 0 and a maximium of 255.
|-
|5
|uint
|g
|Unused if ''mode'' is not 2 or 4. Byte used for the color green. Has a minimum of 0 and a maximium of 255.
|-
|6
|uint
|b
|Unused if ''mode'' is not 2 or 4. Byte used for the color blue. Has a minimum of 0 and a maximium of 255.
|}
=== 0xef - screen2_WhiteChange ===
Changes the brightness of the screen across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|-
|3
|uint
|start_brightness
|The brightness level the opcode will begin at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|-
|4
|uint
|end_brightness
|The brightness level the opcode will end at.

* The minimum brightness is 0, which results in a white screen.
* The default brightness is 256.
* The maximum brightness is 512, which results in a black screen.
|}
=== 0xf0 - screen2_WhiteChangeAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|-
|3
|uint
|unk2
|Does nothing.
|-
|4
|uint
|unk3
|Does nothing.
|}
=== 0xf1 - screen2_WhiteIn ===
Does nothing. Do not be deceived by this opcode's name: After using <code>screen2_WhiteOut</code>, use <code>screen2_FadeIn</code> to restore the Top Screen's brightness level!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf2 - screen2_WhiteInAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf3 - screen2_WhiteOut ===
Changes the brightness of the screen to its maximum (i.e., a white screen) across a certain number of frames. This opcode will affect everything on the Top Screen.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|suspension_flag
|Determines whether the script will suspend until this opcode's operation is complete. 0 is false and anything else is true.
|-
|2
|uint
|duration
|The number of frames used to change the Top Screen's brightness.
|}
=== 0xf4 - screen2_WhiteOutAll ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|-
|2
|uint
|unk1
|Does nothing.
|}
=== 0xf5 - se_ChangePan ===
Changes the panning of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's panning.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xf6 - se_ChangeVolume ===
Changes the volume of the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to change the SE's volume.
|-
|3
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xf7 - se_FadeOut ===
Fades out the currently-playing [[sound effect]] across a certain number of frames.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|duration
|The number of frames used to fade out and silence a given SE.
|}
=== 0xf8 - se_Play ===
Instantly plays a [[sound effect]].

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xf9 - se_PlayFull ===
Instantly plays a [[sound effect]] at a specified volume and panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|-
|3
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfa - se_PlayPan ===
Instantly plays a [[sound effect]] at a specified panning.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|pan
|The panning of the SE. This parameter gets recalculated internally as <code>((''pan'' * 0x3f + ((''pan'' * 0x3f >> 7) >> 0x18)) >> 8) + 0x40</code>, which is eventually split up into two halfwords, then recalculated further into a signed byte.
What this means is that:

* A ''pan'' parameter of 260 will result in sound panning only to the right channel.
* A ''pan'' parameter of 261 will result in sound panning only to the left channel.

More research on this parameter may be needed.
|}
=== 0xfb - se_PlayVolume ===
Instantly plays a [[sound effect]] at a specified volume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|-
|2
|uint
|volume
|The volume that the SE will play at. It has a maximum of 256 and a minimum of 0.
|}
=== 0xfc - se_Stop ===
Instantly stops a specified sound effect.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|A sound effect defined in SOUND/SE of the ROM. Actually encoded as <code>sound_bank_id << 8 + sound_id</code>, but it can also be represented as an integer.
|}
=== 0xfd - SetAnimation ===
Plays a sprite's animation, optionally changing its speed and animation flags.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|id
|Animation table index. Converted to an [[Animation ID]] for the current sprite using the [https://docs.google.com/spreadsheets/d/11xHv80Def5mtF60ZsfI1lF1eNX0dBE2It837Q08AlRk/htmlview SetAnimation table].
|}
=== 0xfe - SetAttribute ===
Does nothing.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|Does nothing.
|}
=== 0xff - SetBlink ===
Sets a specific entity (i.e., an actor, object, or performer) to continuously flicker in and out of view at a certain interval.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|visible_interval
|The number of frames to wait for while the entity is visible.
|-
|2
|uint
|invisible_interval
|The number of frames to wait for while the entity is invisible.
|}
=== 0x100 - SetDirection ===
Instantly sets a specific entity (i.e., an actor, object, or performer) to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|The type of direction, the list of which can be seen by typing <code>DIR_</code> in SkyTemple's Script Engine Debugger.
|}
=== 0x101 - SetDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x102 - SetEffect ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Effect
|effect_id
|
|-
|2
|uint
|position_marker_id?
|
|}
=== 0x103 - SetFunctionAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x104 - SetHeight ===
Moves an actor "vertically" by distancing it from its shadow.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|number of pixels to move up or down by.
|}
=== 0x105 - SetHitAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x106 - SetMoveRange ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|-
|5
|uint
|unk4
|
|-
|6
|uint
|unk5
|
|}
=== 0x107 - SetOutputAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x108 - SetPosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|x
|
|-
|2
|uint
|y
|
|}
=== 0x109 - SetPositionInitial ===
<TO DO: Opcode description>

No parameters.
=== 0x10a - SetPositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x10b - SetPositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x10c - SetPositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10d - SetPositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|x
|
|-
|2
|sint
|y
|
|}
=== 0x10e - SetReplyAttribute ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|bitfield
|unk0
|
|}
=== 0x10f - SetupOutputAttributeAndAnimation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x110 - Slide2Position ===
Moves an entity (i.e., an actor, object, or performer) to a specific pixel position without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|x
|The pixel position on the X-axis.
|-
|3
|uint
|y
|The pixel position on the Y-axis.
|}

=== 0x111 - Slide2PositionLives ===
Moves an entity (i.e., an actor, object, or performer) to an actor without animation. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|uint
|actor_id
|The ID of the actor to move the entity to.
|}

=== 0x112 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to one or more Position Marks without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x113 - Slide2PositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark without animation, and without restricting the angles used.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed. Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_mark
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x114 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x115 - Slide2PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x116 - Slide2PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x117 - Slide3Position ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x118 - Slide3PositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|uint
|actor_id
|
|}
=== 0x119 - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|PositionMark
|pos_marker
|This parameter may be repeated multiple times
|}
=== 0x11a - Slide3PositionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x11b - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
| rowspan="2" |These two parameters may be repeated multiple times
|-
|3+
|sint
|y
|}
=== 0x11c - Slide3PositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11d - Slide3PositionOffsetRandom ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x11e - SlideHeight ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x11f - SlidePosition ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|x
|
|-
|3
|uint
|y
|
|}
=== 0x120 - SlidePositionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x121 - SlidePositionLivesTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x122 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|The number of parameters to read from this opcode.
|-
|2+
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
This parameter may be repeated multiple times.
|}

=== 0x123 - SlidePositionMark ===
Moves an entity (i.e., an actor, object, or performer) to a Position Mark while restricting movement by eight angles—as if movement was performed using the D-Pad. Unlike MovePositionMark, this will not turn the entity to face the direction they are moving in.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|Movement speed. Higher values result in a faster speed.
Values starting at 32770 and above will be slower than a value of 1.
|-
|2
|PositionMark
|pos_marker
|A structure consisting of a name, X unit, and Y unit. Units are defined as 8 pixels.
|}

=== 0x124 - SlidePositionMarkTime ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|}
=== 0x125 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|num_parameters
|
|-
|2+
|sint
|x
|This parameter may be repeated multiple times
|}
=== 0x126 - SlidePositionOffset ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|
|-
|2
|sint
|x
|
|-
|3
|sint
|y
|
|}
=== 0x127 - sound_FadeOut ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x128 - sound_Stop ===
<TO DO: Opcode description>

No parameters.
=== 0x129 - StopAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x12a - supervision_Acting ===
Loads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12b - supervision_ActingInvisible ===
Loads a sector of the Acting scene. Actors and objects in this sector will be invisible.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to load.
|}

=== 0x12c - supervision_ExecuteActing ===
Loads a specified Acting script from the specified level from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}

=== 0x12d - supervision_ExecuteActingSub ===
Loads a specified Acting script from the specified level from within Unionall

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}

=== 0x12e - supervision_ExecuteCommon ===
Loads a specified Unionall coroutine from within Enter/Acting/Sub scripts.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Routine
|coro_id
|
|}

=== 0x12f - supervision_ExecuteEnter ===
Loads an Enter script from the specified level.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|level_id
|An entry in the Level list.
|}

=== 0x130 - supervision_ExecuteStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x131 - supervision_ExecuteStationCommon ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x132 - supervision_ExecuteStationCommonSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|uint
|unk1
|
|}
=== 0x133 - supervision_ExecuteStationSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|-
|3
|uint
|unk2
|
|}
=== 0x134 - supervision_ExecuteExport ===
Loads a specified Acting scene of the level S00P01A

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|script_id
|
|}

=== 0x135 - supervision_ExecuteExportSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|ConstString
|const
|
|}
=== 0x136 - supervision_LoadStation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Level
|level
|
|-
|2
|ConstString
|script_id
|
|}
=== 0x137 - supervision_Remove ===
Unloads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x138 - supervision_RemoveActing ===
Unloads a sector of the Acting scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x139 - supervision_RemoveCommon ===
Unloads a sector of the Enter scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|layer_id
|The ID of the sector to unload.
|}

=== 0x13a - supervision_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x13b - supervision_Station ===
Loads a sector of the Sub scene.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13c - supervision_StationCommon ===
Loads a sector of the Enter scene.

Can be used to call sectors of an enter scene within acting scenes!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|station_id
|The ID of the sector to load.
|}

=== 0x13d - supervision_Suspend ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|sint
|unk0
|
|}
=== 0x13e - supervision2_SpecialActing ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14c - Turn2Direction ===
Makes an actor rotate to a specified direction.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Direction
|direction
|The direction that the actor will turn to face.
|}

=== 0x14d - Turn2DirectionLives ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|Entity
|actor_id
|The target actor that the actor will turn to face.
|}

=== 0x14e - Turn2DirectionLives2 ===
Makes an actor rotate to face another actor. Must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|actor_id
|ID of the target actor from Level List that the actor will turn to face.
|}

=== 0x14f - Turn2DirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|PositionMark
|pos_marker
|
|-
|4
|uint
|unk6
|
|-
|5
|uint
|unk7
|
|}
=== 0x150 - Turn2DirectionTurn ===
Makes an actor turn at a certain angle.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|speed
|How fast the actor turns. The higher the number, the slower the turn.
|-
|2
|uint
|rotationdirection
|The way that the actor will turn to face the specified direction. 1 = clockwise, 2 = counterclockwise, 10 = the most efficient direction to turn.
|-
|3
|uint
|angle
|1: 45 degrees left, 2: 45 degrees right, 3: 90 degrees right, 4: 90 degrees left, 5: 180 degrees
|}

=== 0x151 - Turn3 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|unk3
|
|}
=== 0x152 - TurnDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x153 - TurnDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x154 - TurnDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x155 - TurnDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|PositionMark
|pos_marker
|
|}
=== 0x156 - Unlock ===
Resumes the routine that was suspended when <code>Lock</code> was called with the specified ''lock_id''.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|The ID of a Lock, ranged from 0-19 (inclusive).
|}
=== 0x157 - Wait ===
Pauses the routine for a set number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration
|The number of frames that the routine will wait for before resuming.
|}

=== 0x158 - WaitAnimation ===
Pauses the routine until the specified actor has finished its animation. After the actor finishes its animation, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x159 - WaitBackEffect ===
Pauses the current routine until [[List of Opcodes#0x2 - back SetBackEffect|back_SetBackEffect]] is called.

No parameters.
=== 0x15a - WaitBack2Effect ===
Pauses the current routine until [[List of Opcodes#0x12 - back2 SetBackEffect|back2_SetBackEffect]] is called.

No parameters.

=== 0x15b - WaitBgm ===
Pauses the current routine until the specified BGM on the first BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15c - WaitBgm2 ===
Pauses the current routine until the specified BGM on the second BGM track has ended. After the BGM ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Bgm
|bgm_id
|A non-looped music track defined in SOUND/BGM of the ROM. Looped music tracks softlocks the game.
|}

=== 0x15d - WaitBgmSignal ===
Pauses the routine until a DSE event with ID 0xF6 on the current BGM track is triggered. This can be used to sync certain parts of the scene to the background music.

No parameters.
=== 0x15e - WaitEffect ===
Pauses the routine until the effect on the specified actor/peformer has ended. After the effect ends, the routine will resume.

This opcode does not have a parameter for an entity, as it must be used in a with-statement or a targeted routine.

=== 0x15f - WaitEndAnimation ===
<TO DO: Opcode description>

No parameters.
=== 0x160 - WaitExecuteLives ===
Pauses the routine until the specified actor has finished its action (Move2Position, Slide2Position, etc.). After the actor finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|The actor that the routine will wait for.
|}

=== 0x161 - WaitExecuteObject ===
Pauses the current routine until the specified object has finished its action (Move2Position, Slide2Position, etc.). After the object finishes its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|The ID of the object that the routine will wait for.
|}

=== 0x162 - WaitExecutePerformer ===
Pauses the current routine until the specified performer has finished its current action (Move2Position, Slide2Position, etc.) After the performer has finished its action, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|The ID of the performer that the routine will wait for.
|}

=== 0x163 - WaitFadeIn ===
Pauses the current routine and waits for the screen to fade in. After the screen fades in, the routine will resume.

No parameters.

=== 0x164 - WaitLockLives ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified actor's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Entity
|actor
|
|}

=== 0x165 - WaitLockObject ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified object's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|Object
|object
|
|}

=== 0x166 - WaitLockPerformer ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in the specified performer's targeted routine. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|-
|2
|uint
|performer
|
|}

=== 0x167 - WaitLockSupervision ===
Pauses the current routine until a [[List of Opcodes#0x8b - Lock|Lock]] opcode with the specified ''lock_id'' is reached in <code>def 0</code>. After the lock is reached, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|lock_id
|
|}

=== 0x168 - WaitMe ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x169 - WaitMoveCamera ===
<TO DO: Opcode description>

No parameters.
=== 0x16a - WaitMoveCamera2 ===
<TO DO: Opcode description>

No parameters.
=== 0x16b - WaitRandom ===
Pauses the routine for a random number of frames. After the number of frames, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|duration_min
|Minimum number of frames that the routine will wait for before resuming.
|-
|2
|uint
|duration_max
|Maximum number of frames that the routine will wait for before resuming.
|}

=== 0x16c - WaitScreenFade ===
Waits until screen_FadeIn finishes executing.

No parameters.
=== 0x16d - WaitScreenFadeAll ===
Waits until screen_FadeInAll finishes executing.

No parameters.
=== 0x16e - WaitScreen2Fade ===
Waits until screen2_FadeIn finishes executing.

No parameters.
=== 0x16f - WaitSe ===
Pauses the current routine until the specified sound effect has ended. After the sound effect ends, the routine will resume.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|se_id
|The ID of the sound to wait for the end of before resuming the routine.
|}

=== 0x170 - WaitSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x171 - WaitSubScreen ===
<TO DO: Opcode description>

No parameters.
=== 0x172 - WaitSubSpecialActing ===
<TO DO: Opcode description>

No parameters.
=== 0x173 - worldmap_BlinkMark ===
Shows a blinking world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x174 - worldmap_ChangeLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x175 - worldmap_DeleteArrow ===
Remove the yellow arrow from the world map.

No parameters.

=== 0x176 - worldmap_MoveCamera ===
Moves the camera to the specified world map marker.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x177 - worldmap_OffMessage ===
Removes a textbox with the world map marker's name from the Top Screen

No parameters.

=== 0x178 - worldmap_SetArrow ===
Shows an arrow pointing to a specified world map marker

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x179 - worldmap_SetCamera ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x17a - worldmap_SetLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x17b - worldmap_SetMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x17c - worldmap_SetMessage ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x17d - worldmap_SetMessagePlace ===
Shows a textbox on the Top Screen with the specified world map marker's name.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|world_map_marker_id
|
|}

=== 0x17e - worldmap_SetMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}

== Other Opcodes ==
These opcodes cannot be directly called from ExplorerScript, since they are represented as higher-level constructs.

=== 0x28 - Branch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x29 - BranchBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2a - BranchDebug ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2b - BranchEdit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2c - BranchExecuteSub ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|jump_address
|
|}
=== 0x2d - BranchPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x2e - BranchScenarioNow ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x2f - BranchScenarioNowAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x30 - BranchScenarioNowBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x31 - BranchScenarioAfter ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x32 - BranchScenarioBefore ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x33 - BranchSum ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|-
|4
|uint
|jump_address
|
|}
=== 0x34 - BranchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|uint
|value
|
|-
|4
|uint
|jump_address
|
|}
=== 0x35 - BranchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|operator
|
|-
|3
|GameVar
|cmp_var
|
|-
|4
|uint
|jump_address
|
|}
=== 0x36 - BranchVariation ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|param
|
|-
|2
|uint
|jump_address
|
|}
=== 0x37 - Call ===
Jumps to the specified address, runs code, and returns to the line of code in which this opcode was used (only if <code>return;</code> was used in the routine this opcode calls). Only one call can be stored at a time!

Use within macros is ill-advised, as using <code>return;</code> within a macro will just end the macro!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|The address to call, e.g., <code>call @label_0;</code> if <code>§label_0;</code> is defined in the script.
|}
=== 0x63 - Case ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|uint
|jump_address
|
|}
=== 0x64 - CaseMenu ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|choice
|
|-
|2
|uint
|jump_address
|
|}
=== 0x65 - CaseMenu2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint?
|choice?
|
|-
|2
|uint
|jump_address
|
|}
=== 0x66 - CaseScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x67 - CaseText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|value
|
|-
|2
|String
|display
|
|}
=== 0x68 - CaseValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|uint
|value
|
|-
|3
|uint
|jump_address
|
|}
=== 0x69 - CaseVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|operator
|
|-
|2
|GameVar
|var
|
|-
|3
|uint
|jump_address
|
|}
=== 0x6e - DefaultText ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|String
|txt
|
|}
=== 0x70 - End ===
<TO DO: Opcode description>

No parameters.
=== 0x74 - flag_CalcBit ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|index
|
|-
|3
|uint
|value
|
|}
=== 0x75 - flag_CalcValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|uint
|value
|
|}
=== 0x76 - flag_CalcVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|calc_operator
|
|-
|3
|GameVar
|var_to_set_from
|
|}
=== 0x77 - flag_Clear ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x78 - flag_Initial ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x79 - flag_Set ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|value
|
|}
=== 0x7a - flag_ResetDungeonResult ===
<TO DO: Opcode description>

No parameters.
=== 0x7b - flag_ResetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x7c - flag_SetAdventureLog ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x7d - flag_SetDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|-
|2
|DungeonMode
|dungen_mode
|
|}
=== 0x7e - flag_SetDungeonResult ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|-
|2
|uint
|unk1
|
|}
=== 0x7f - flag_SetPerformance ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|index
|
|-
|2
|uint
|value
|
|}
=== 0x80 - flag_SetScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|scenario_value
|
|-
|3
|uint
|level_value
|
|}
=== 0x82 - Hold ===
Will stall a script forever.

No parameters.
=== 0x87 - Jump ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|jump_address
|
|}
=== 0x89 - lives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|
|}
=== 0xaa - message_SwitchMenu ===
Enclose within a switch case, and generates a dialogue prompt with the options present in subsequent "case menu("text"):"

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|}
=== 0xab - message_SwitchMenu2 ===
Same as message_SwitchMenu, but it also takes an argument for a bitfield, and will only display dialogue options for which the corresponding bit is enabled (set to 1).

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|cancel
|If player can use the B button to back out of a menu. 0 for false, 1 for true.
|-
|2
|uint
|init
|Entry number to start the cursor at, starting at 1
|-
|3
|uint
|unk2
|Bitfield $VAR
|}
=== 0xac - message_SwitchMonologue ===
Structured similarly to a switch statement. Typically uses <code>$HERO_TALK_KIND</code> as an argument, and uses multiple cases to display certain dialogue strings.

<code>case 4:</code> used when the player is male or genderless

<code>case 5:</code> used when the player is female

<code>default:</code> used when <code>$HERO_TALK_KIND</code>'s Talk Group has a value other than 4 or 5

This opcode supports displaying a portrait. No sound effect is used when text is scrolling.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xad - message_SwitchTalk ===
Same as _SwitchMonologue, but typically uses <code>$PARTNER_TALK_KIND</code> as an argument, and the cases used vary.

Of the vanilla game partner options:

<code>case 1:</code> used if Squirtle, Tododile, Chimchar, Meowth, or Munchlax

<code>case 2:</code> used for all other male partners

<code>case 3:</code> used for all female partners

<code>default:</code> used when <code>$PARTNER_TALK_KIND</code>'s Talk Group has a value other than 1, 2, or 3

This opcode supports displaying a portrait. The [[sound effect]] 16133 will emit from the each character scrolling in the text.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|<code>$x_TALK_KIND</code>, contains Talk Group number
|}
=== 0xc9 - object ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Object
|object_id
|
|}
=== 0xcb - performer ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|performer_id
|
|}
=== 0xd5 - Return ===
If run from within a macro, ends the macro.

If run after the "call" opcode was used, will return to the address of the call opcode.

If used within a script, ends the script.

No parameters.
=== 0x13f - Switch ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x140 - SwitchDirection ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Direction
|direction
|
|}
=== 0x141 - SwitchDirectionLives ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x142 - SwitchDirectionLives2 ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|unk0
|
|}
=== 0x143 - SwitchDirectionMark ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|PositionMark
|pos_marker
|
|}
=== 0x144 - SwitchDungeonMode ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|dungeon_id
|
|}
=== 0x145 - SwitchLives ===
If inside a Switch Case, take the case equal to the species ID of the specified Actor!

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|Entity
|actor_id
|An entry in the Actor List.
|}
=== 0x146 - SwitchRandom ===
To be used in a switch statement. Will switch to a case of a random number below the specified integer.

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|uint
|max_value
|Largest random output, plus 1
|}
=== 0x147 - SwitchScenario ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x148 - SwitchScenarioLevel ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|}
=== 0x149 - SwitchSector ===
<TO DO: Opcode description>

No parameters.
=== 0x14a - SwitchValue ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
=== 0x14b - SwitchVariable ===
<TO DO: Opcode description>

{| class="wikitable"
|+Parameters
|-
!#
!Type
!Name
!Description
|-
|1
|GameVar
|var
|
|-
|2
|uint
|unk1
|
|-
|3
|uint
|unk2
|
|}
{{NavScriptTerms}}
[[Category:Documentation]]

How to use GfxCrunch (Animated Object Sprites)

2025-04-19T17:56:36Z

Deltaflare: /* <Frame> */ simplified formatting, added decimal formats for clarification

'''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not fully confirmed info).

Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking.

XML uses '''tags''' to list this data in the format of:

<code><TagName> content here </TagName></code>

GfxCrunch uses the following folders and files to generate object sprites.

== imgs Folder ==
This is a folder of all image sprites used in the animations. Images are labeled from <code>0000.png</code>, <code>0001.png</code>, <code>0002.png</code>, etc. These images have to be ''indexed images'' and fit within GfxCrunch’s sizes (16 x 16 or multiples of that are safe starting points).

== palette.pal ==
Contains the image palette. The indexes correspond with the color indexes of the sprites in the <code>imgs</code> folder. Must contain 16 colors, including a transparent color. To obtain this, it's recommend to import one of your images into SkyTemple as a ''static sprite'', then export from SkyTemple.

== frames.xml ==
Contains data for image frames.

A <code><FrameGroup></code> is made up of x amount of <code><Frame></code> images, ''if'' it needs to form a bigger sprite. If a sprite is going to be just one image (eg: one PNG from the <code>imgs</code> folder), each PNG that will be used for animations ''needs to be in its own <code><FrameGroup></code>. If not, this will cause memory issues and/or crashes when displaying the object in cutscenes.''

See the definitions of the XML tags below.

=== <FrameGroup> ===
Indicates a group of frames. Multiple frames can be layered on top of each other or be aligned side-to-side to create a "bigger sprite."

=== <Frame> ===
Indicates a single image sprite.

==== <ImageIndex> ====
The image index of the frame. This correlates with the image number in the <code>imgs</code> folder.

==== <Unk0> ====
Unknown. Value seems to always be 0x0 (0 in hexadecimal).

==== <Offset> ====
Determines the image offset of the frame which will affect where it is positioned on-screen. Recommend to base offset values off of other frame offsets.

==== <Unk1> ====
Unknown. Value seems to always be 0xc (12 in hexadecimal).

==== <Unk15> ====
Correlates to ''each '''Frame''''' in ''one'' '''FrameGroup''', used for memory allocation and layering. If there are '''multiple''' '''Frames''' in a '''FrameGroup''', '''increment''' this value in each entry.

Value needed to start with and/or increment depends on the resolution size of the sprite. Ideally:

* 8x8 frame (smallest size) requires <code>0x1</code> (1 in decimal)
* 16x32 frame requires <code>0x2</code> (2 in decimal)
* 32x64 frame requires <code>0x8</code> (8 in decimal)
* 32x32 frame requires <code>0x4</code> (4 in decimal)
* 64x64 frame (largest size) requires <code>0x10</code> (16 in decimal)

The number is represented in hexadecimal, so 0x0 is 0... 0xc is 12, 0x10 is 16, etc.

'''For more information on why this is important, see the [[How to use GfxCrunch (Animated Object Sprites)#spriteinfo.xml|spriteinfo.xml]] section.'''

===== <Resolution> =====
Uses '''<Width>''' and '''<Height>''' tags. Signals how large the image is in pixels.

==== <VFlip> & <HFlip> ====
Determines whether to flip the frame image vertically or horizontally, respectively. 0 does not flip the image while 1 does. '''Typically 0.'''

== animations.xml ==
Contains data for animations.

=== <AnimGroupTable> ===
Container for the '''AnimGroup'''.

==== <AnimGroup> ====
Group containing a list of all '''AnimSequenceIndexes''' associated with the sprite. Lists out animation sequence indexes from 0, 1, 2, all the way to 7. This number correlates to the SetAnimation scripting function. A more detailed explanation about this can be seen [[How to use GfxCrunch (Animated Object Sprites)#How to Use with SetAnimation()|below]].
[[File:Gfxcrunch tutorial animgroup.png|center]]

=== <AnimSequenceTable> ===
Container for each '''AnimSequence entry'''.

==== <AnimSequence> ====
Indicates an animation sequence, which is made up of individual '''AnimFrames''' defined in sequential order. Each '''AnimSequence''' should have an index in the '''AnimGroupTable'''. Remember that there is a maximum of '''8''' allowed, numbered 0 - 7.

An '''AnimSequence''' can be made up of as little as one frame, to as many as needed, provided the total amount of frames defined in <code>frames.xml</code> fit the memory allocation constraints (explained in the [[How to use GfxCrunch (Animated Object Sprites)#spriteinfo.xml|spriteinfo.xml]] section).

===== <AnimFrame> =====
Indicates a single animation frame.

===== <Duration> =====
Determines the duration of the frame, in frames.

===== <MetaFrameGroupIndex> =====
Determines the meta-frame the '''AnimFrame''' uses. ''This correlates to the frame’s index in <code>frames.xml</code>'', starting from 0.

===== <Sprite> & <Shadow> =====
Unknown. Presumably they determine the offset of the sprite and shadow, respectively.

== imgsinfo.xml ==
{{StubSection}}
Typically this file is pretty empty, like shown. This may differ in newer versions of SkyTemple.
[[File:Gfxcrunch tutorial imgsInfo example.png|center|thumb]]

== spriteinfo.xml ==
The most important tag here is '''<Unk6>'''. As noted from the XML comments:

''"Nb of "blocks" the image takes up in tile memory. Affects where things like the relic fragment will be loaded. If too low, item not loaded and replaced with parts of character sprite."''

This value comes from adding up the hexadecimal values of '''[[How to use GfxCrunch (Animated Object Sprites)#<Unk16>|<Unk16>]]''' in <code>frames.xml</code>.

The maximum amount of "blocks" allowed for one sprite is '''255''' ('''0xFF''' in hexadecimal). Anything over this value will crash the game. As noted, anything lower may allow the game to run sub-optimally with glitched graphics.

== offsets.xml ==
{{StubSection}}
Typically this file is pretty empty, like shown.[[File:GFXC tutorial offsets.xml example.png|center|thumb]]

== How to Use with SetAnimation() ==
This is the [[ExplorerScript]] function that lets you change the animation of an object, with an integer taken in as an argument. When using the function, it should be called as <code>SetAnimation<entity ENTITY>(x)</code>, where '''x''' is the Animation ID defined below.

Depending on how many '''AnimationSequenceIndexes''' you have defined and which behavior you want, the argument will differ as follows:

* '''1 - 8''' will cause a specific animation to ''loop'', with '''1''' denoting ''Animation 0'' and '''8''' denoting ''Animation 7''.
* '''9 - 16''' will play ''Animation 0'' and then play the first frame of the signified animation, with '''9''' denoting ''Animation 0'' and '''16''' denoting ''Animation 7''.
* '''17 - 24''' will play a specific animation ''without'' ''looping'', with '''17''' denoting ''Animation 0'' and '''24''' denoting ''Animation 7''.

== Example ==
For reference, here is a link to a sample folder: [https://drive.google.com/drive/u/2/folders/1ENtmeUDNhBbnaetIaDcaEUOS648NoowJ External Link to Google Drive]
[[Category:Tutorials]]

How to use GfxCrunch (Animated Object Sprites)

2025-04-19T17:48:10Z

Deltaflare: /* Imgs Folder */ formatting

'''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not fully confirmed info).

Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking.

XML uses '''tags''' to list this data in the format of:

<code><TagName> content here </TagName></code>

GfxCrunch uses the following folders and files to generate object sprites.

== imgs Folder ==
This is a folder of all image sprites used in the animations. Images are labeled from <code>0000.png</code>, <code>0001.png</code>, <code>0002.png</code>, etc. These images have to be ''indexed images'' and fit within GfxCrunch’s sizes (16 x 16 or multiples of that are safe starting points).

== palette.pal ==
Contains the image palette. The indexes correspond with the color indexes of the sprites in the <code>imgs</code> folder. Must contain 16 colors, including a transparent color. To obtain this, it's recommend to import one of your images into SkyTemple as a ''static sprite'', then export from SkyTemple.

== frames.xml ==
Contains data for image frames.

=== <FrameGroup> ===
Indicates a group of frames. Multiple frames can be layered on top of each other or be aligned side-to-side to create a "bigger sprite."

=== <Frame> ===
Indicates a single image sprite.

A <code><FrameGroup></code> is made up of x amount of <code><Frame></code> images, ''if'' it needs to form a bigger sprite. If a sprite is going to be just one image (eg: one PNG from the <code>imgs</code> folder), each PNG that will be used for animations ''needs to be in its own <code><FrameGroup></code>. If not, this will cause memory issues and/or crashes when displaying the object in cutscenes.''

==== <ImageIndex> ====
The image index of the frame. This correlates with the image number in the imgs folder.

==== <Unk0> ====
Unknown. Value seems to always be 0x0 (0 in hexadecimal).

==== <Offset> ====
Determines the image offset of the frame which will affect where it is positioned on-screen. Recommend to base offset values off of other frame offsets.

==== <Unk1> ====
Unknown. Value seems to always be 0xc (12 in hexadecimal).

==== <Unk15> ====
Correlates to ''each <code><Frame></code>'' in '''one''' <code><FrameGroup></code>, used for memory allocation and layering. If there are multiple <code><Frames></code> in a <<code>FrameGroup></code> , increment this value.

Value needed to start with/increment depends on the size of the sprite. Ideally:

* 8x8 frame (smallest size) requires <code>0x1</code>
* 16x32 frame requires <code>0x2</code>
* 32x64 frame requires <code>0x8</code>
* 32x32 frame requires <code>0x4</code>
* 64x64 frame (largest size) requires <code>0x10</code>

The number is represented in hexadecimal, so 0x0 is 0... 0xc is 12, 0x10 is 16, etc.

'''For more information on why this is important, see the [[How to use GfxCrunch (Animated Object Sprites)#spriteinfo.xml|spriteinfo.xml]] section.'''

===== <Resolution> =====
Uses '''<Width>''' and '''<Height>''' tags. Signals how large the image is in pixels.

==== <VFlip> & <HFlip> ====
Determines whether to flip the frame image vertically or horizontally, respectively. 0 does not flip the image while 1 does. '''Typically 0.'''

== animations.xml ==
Contains data for animations.

=== <AnimGroupTable> ===
Container for the '''AnimGroup'''.

==== <AnimGroup> ====
Group containing a list of all '''AnimSequenceIndexes''' associated with the sprite. Lists out animation sequence indexes from 0, 1, 2, all the way to 7. This number correlates to the SetAnimation scripting function. A more detailed explanation about this can be seen [[How to use GfxCrunch (Animated Object Sprites)#How to Use with SetAnimation()|below]].
[[File:Gfxcrunch tutorial animgroup.png|center]]

=== <AnimSequenceTable> ===
Container for each '''AnimSequence entry'''.

==== <AnimSequence> ====
Indicates an animation sequence, which is made up of individual '''AnimFrames''' defined in sequential order. Each '''AnimSequence''' should have an index in the '''AnimGroupTable'''. Remember that there is a maximum of '''8''' allowed, numbered 0 - 7.

An '''AnimSequence''' can be made up of as little as one frame, to as many as needed, provided the total amount of frames defined in <code>frames.xml</code> fit the memory allocation constraints (explained in the [[How to use GfxCrunch (Animated Object Sprites)#spriteinfo.xml|spriteinfo.xml]] section).

===== <AnimFrame> =====
Indicates a single animation frame.

===== <Duration> =====
Determines the duration of the frame, in frames.

===== <MetaFrameGroupIndex> =====
Determines the meta-frame the '''AnimFrame''' uses. ''This correlates to the frame’s index in <code>frames.xml</code>'', starting from 0.

===== <Sprite> & <Shadow> =====
Unknown. Presumably they determine the offset of the sprite and shadow, respectively.

== imgsinfo.xml ==
{{StubSection}}
Typically this file is pretty empty, like shown. This may differ in newer versions of SkyTemple.
[[File:Gfxcrunch tutorial imgsInfo example.png|center|thumb]]

== spriteinfo.xml ==
The most important tag here is '''<Unk6>'''. As noted from the XML comments:

''"Nb of "blocks" the image takes up in tile memory. Affects where things like the relic fragment will be loaded. If too low, item not loaded and replaced with parts of character sprite."''

This value comes from adding up the hexadecimal values of '''[[How to use GfxCrunch (Animated Object Sprites)#<Unk16>|<Unk16>]]''' in <code>frames.xml</code>.

The maximum amount of "blocks" allowed for one sprite is '''255''' ('''0xFF''' in hexadecimal). Anything over this value will crash the game. As noted, anything lower may allow the game to run sub-optimally with glitched graphics.

== offsets.xml ==
{{StubSection}}
Typically this file is pretty empty, like shown.[[File:GFXC tutorial offsets.xml example.png|center|thumb]]

== How to Use with SetAnimation() ==
This is the [[ExplorerScript]] function that lets you change the animation of an object, with an integer taken in as an argument. When using the function, it should be called as <code>SetAnimation<entity ENTITY>(x)</code>, where '''x''' is the Animation ID defined below.

Depending on how many '''AnimationSequenceIndexes''' you have defined and which behavior you want, the argument will differ as follows:

* '''1 - 8''' will cause a specific animation to ''loop'', with '''1''' denoting ''Animation 0'' and '''8''' denoting ''Animation 7''.
* '''9 - 16''' will play ''Animation 0'' and then play the first frame of the signified animation, with '''9''' denoting ''Animation 0'' and '''16''' denoting ''Animation 7''.
* '''17 - 24''' will play a specific animation ''without'' ''looping'', with '''17''' denoting ''Animation 0'' and '''24''' denoting ''Animation 7''.

== Example ==
For reference, here is a link to a sample folder: [https://drive.google.com/drive/u/2/folders/1ENtmeUDNhBbnaetIaDcaEUOS648NoowJ External Link to Google Drive]
[[Category:Tutorials]]

How to use GfxCrunch (Animated Object Sprites)

2025-04-19T17:47:09Z

Deltaflare: simplified headers, added memory explanation

'''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not fully confirmed info).

Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking.

XML uses '''tags''' to list this data in the format of:

<code><TagName> content here </TagName></code>

GfxCrunch uses the following folders and files to generate object sprites.

== Imgs Folder ==
This is a folder of all image sprites used in the animations. Images are labeled from <code>0000.png</code>, <code>0001.png</code>, <code>0002.png</code>, etc. These images have to be i''ndexed images'' and fit within GfxCrunch’s sizes (16 x 16 or multiples of that are safe starting points).

== palette.pal ==
Contains the image palette. The indexes correspond with the color indexes of the sprites in the <code>imgs</code> folder. Must contain 16 colors, including a transparent color. To obtain this, it's recommend to import one of your images into SkyTemple as a ''static sprite'', then export from SkyTemple.

== frames.xml ==
Contains data for image frames.

=== <FrameGroup> ===
Indicates a group of frames. Multiple frames can be layered on top of each other or be aligned side-to-side to create a "bigger sprite."

=== <Frame> ===
Indicates a single image sprite.

A <code><FrameGroup></code> is made up of x amount of <code><Frame></code> images, ''if'' it needs to form a bigger sprite. If a sprite is going to be just one image (eg: one PNG from the <code>imgs</code> folder), each PNG that will be used for animations ''needs to be in its own <code><FrameGroup></code>. If not, this will cause memory issues and/or crashes when displaying the object in cutscenes.''

==== <ImageIndex> ====
The image index of the frame. This correlates with the image number in the imgs folder.

==== <Unk0> ====
Unknown. Value seems to always be 0x0 (0 in hexadecimal).

==== <Offset> ====
Determines the image offset of the frame which will affect where it is positioned on-screen. Recommend to base offset values off of other frame offsets.

==== <Unk1> ====
Unknown. Value seems to always be 0xc (12 in hexadecimal).

==== <Unk15> ====
Correlates to ''each <code><Frame></code>'' in '''one''' <code><FrameGroup></code>, used for memory allocation and layering. If there are multiple <code><Frames></code> in a <<code>FrameGroup></code> , increment this value.

Value needed to start with/increment depends on the size of the sprite. Ideally:

* 8x8 frame (smallest size) requires <code>0x1</code>
* 16x32 frame requires <code>0x2</code>
* 32x64 frame requires <code>0x8</code>
* 32x32 frame requires <code>0x4</code>
* 64x64 frame (largest size) requires <code>0x10</code>

The number is represented in hexadecimal, so 0x0 is 0... 0xc is 12, 0x10 is 16, etc.

'''For more information on why this is important, see the [[How to use GfxCrunch (Animated Object Sprites)#spriteinfo.xml|spriteinfo.xml]] section.'''

===== <Resolution> =====
Uses '''<Width>''' and '''<Height>''' tags. Signals how large the image is in pixels.

==== <VFlip> & <HFlip> ====
Determines whether to flip the frame image vertically or horizontally, respectively. 0 does not flip the image while 1 does. '''Typically 0.'''

== animations.xml ==
Contains data for animations.

=== <AnimGroupTable> ===
Container for the '''AnimGroup'''.

==== <AnimGroup> ====
Group containing a list of all '''AnimSequenceIndexes''' associated with the sprite. Lists out animation sequence indexes from 0, 1, 2, all the way to 7. This number correlates to the SetAnimation scripting function. A more detailed explanation about this can be seen [[How to use GfxCrunch (Animated Object Sprites)#How to Use with SetAnimation()|below]].
[[File:Gfxcrunch tutorial animgroup.png|center]]

=== <AnimSequenceTable> ===
Container for each '''AnimSequence entry'''.

==== <AnimSequence> ====
Indicates an animation sequence, which is made up of individual '''AnimFrames''' defined in sequential order. Each '''AnimSequence''' should have an index in the '''AnimGroupTable'''. Remember that there is a maximum of '''8''' allowed, numbered 0 - 7.

An '''AnimSequence''' can be made up of as little as one frame, to as many as needed, provided the total amount of frames defined in <code>frames.xml</code> fit the memory allocation constraints (explained in the [[How to use GfxCrunch (Animated Object Sprites)#spriteinfo.xml|spriteinfo.xml]] section).

===== <AnimFrame> =====
Indicates a single animation frame.

===== <Duration> =====
Determines the duration of the frame, in frames.

===== <MetaFrameGroupIndex> =====
Determines the meta-frame the '''AnimFrame''' uses. ''This correlates to the frame’s index in <code>frames.xml</code>'', starting from 0.

===== <Sprite> & <Shadow> =====
Unknown. Presumably they determine the offset of the sprite and shadow, respectively.

== imgsinfo.xml ==
{{StubSection}}
Typically this file is pretty empty, like shown. This may differ in newer versions of SkyTemple.
[[File:Gfxcrunch tutorial imgsInfo example.png|center|thumb]]

== spriteinfo.xml ==
The most important tag here is '''<Unk6>'''. As noted from the XML comments:

''"Nb of "blocks" the image takes up in tile memory. Affects where things like the relic fragment will be loaded. If too low, item not loaded and replaced with parts of character sprite."''

This value comes from adding up the hexadecimal values of '''[[How to use GfxCrunch (Animated Object Sprites)#<Unk16>|<Unk16>]]''' in <code>frames.xml</code>.

The maximum amount of "blocks" allowed for one sprite is '''255''' ('''0xFF''' in hexadecimal). Anything over this value will crash the game. As noted, anything lower may allow the game to run sub-optimally with glitched graphics.

== offsets.xml ==
{{StubSection}}
Typically this file is pretty empty, like shown.[[File:GFXC tutorial offsets.xml example.png|center|thumb]]

== How to Use with SetAnimation() ==
This is the [[ExplorerScript]] function that lets you change the animation of an object, with an integer taken in as an argument. When using the function, it should be called as <code>SetAnimation<entity ENTITY>(x)</code>, where '''x''' is the Animation ID defined below.

Depending on how many '''AnimationSequenceIndexes''' you have defined and which behavior you want, the argument will differ as follows:

* '''1 - 8''' will cause a specific animation to ''loop'', with '''1''' denoting ''Animation 0'' and '''8''' denoting ''Animation 7''.
* '''9 - 16''' will play ''Animation 0'' and then play the first frame of the signified animation, with '''9''' denoting ''Animation 0'' and '''16''' denoting ''Animation 7''.
* '''17 - 24''' will play a specific animation ''without'' ''looping'', with '''17''' denoting ''Animation 0'' and '''24''' denoting ''Animation 7''.

== Example ==
For reference, here is a link to a sample folder: [https://drive.google.com/drive/u/2/folders/1ENtmeUDNhBbnaetIaDcaEUOS648NoowJ External Link to Google Drive]
[[Category:Tutorials]]

File:Gfxcrunch tutorial animgroup.png

2025-04-19T17:20:33Z

Deltaflare:

screenshot showing animgroup layout

File:Gfxcrunch tutorial imgsInfo example.png

2025-04-19T17:15:44Z

Deltaflare:

Screenshot of imgsinfo.xml

How to use GfxCrunch (Animated Object Sprites)

2025-04-19T16:46:14Z

Deltaflare: Created page with "{{Stub}} '''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not confirmed). Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking. XML uses tags to list this data in the format of: <code><TagName> content here </TagName></code> GfxCrunch uses the following folders and files to generate object sprites. == Imgs Folder == This is a folder of all image sprites used in..."

{{Stub}}

'''XML''' is a markup language for data. '''GfxCrunch''' uses this data to create object sprites for EoS (not confirmed).

Recommend export to a static sprite from SkyTemple and then editing the exported files to your liking.

XML uses tags to list this data in the format of:

<code><TagName> content here </TagName></code>

GfxCrunch uses the following folders and files to generate object sprites.

== Imgs Folder ==
This is a folder of all image sprites used in the animations. Images are labeled from <code>0000.png</code>, <code>0001.png</code>, <code>0002.png</code>, etc. These images have to be i''ndexed images'' and fit within GfxCrunch’s sizes (16 x 16 or multiples of that are safe starting points).

== palette.pal ==
Contains the image palette. The indexes correspond with the color indexes of the sprites in the <code>imgs</code> folder. Must contain 16 colors at most, including a transparent color. To obtain this, it's recommend to import one of your images into SkyTemple as a ''static sprite'', then export from SkyTemple.

== frames.xml ==
Contains data for image frames.

=== XML Tags ===

==== <FrameGroup> ====
Indicates a group of frames. Multiple frames can be layered on top of each other or be aligned side-to-side to create a "bigger sprite."

==== <Frame> ====
Indicates a single image sprite.

A <code><FrameGroup></code> is made up of x amount of <code><Frame></code> images, ''if'' it needs to form a bigger sprite. If a sprite is going to be just one image (eg: one PNG from the <code>imgs</code> folder), each PNG that will be used for animations ''needs to be in its own <code><FrameGroup></code>. If not, this will cause memory issues and/or crashes when displaying the object in cutscenes.''

===== <ImageIndex> =====
The image index of the frame. This correlates with the image number in the imgs folder.

== imgsinfo.xml ==

== spriteinfo.xml ==
- todo: explanation of memory allowance in spriteinfo.xml

== offsets.xml ==
[[File:GFXC tutorial offsets.xml example.png|center|thumb]]

== How to Use with SetAnimation() ==
This is the [[ExplorerScript]] function that lets you change the animation of an object, with an integer taken in as an argument. When using the function, it should be called as <code>SetAnimation<entity ENTITY>(x)</code>.

Depending on how many AnimationSequenceIndexes you have defined, the argument will differ as follows:

* '''1 - 8''' will cause a specific animation to ''loop'', with '''1''' denoting ''Animation 0'' and '''8''' denoting ''Animation 7''.
* '''9 - 16''' will play ''Animation 0'' and then play the first frame of the signified animation, with '''9''' denoting ''Animation 0'' and '''16''' denoting ''Animation 7''.
* '''17 - 24''' will play a specific animation ''without'' ''looping'', with '''17''' denoting ''Animation 0'' and '''24''' denoting ''Animation 7''.

== Example ==
For reference, here is a link to a sample folder: [https://drive.google.com/drive/u/2/folders/1ENtmeUDNhBbnaetIaDcaEUOS648NoowJ External Link to Google Drive]

When finished, add to Tutorials

File:GFXC tutorial offsets.xml example.png

2025-04-19T16:44:08Z

Deltaflare:

Screenshot of the basic setup of offsets.xml

How to add custom Items

2025-04-11T12:57:49Z

Deltaflare: /* Possible Errors (& Fixes) */ rephrase

Adding custom items can be broken down into two parts: setting item properties and adding a sprite (if needed).

== Item Settings ==
The following will walk you through how to customize the properties and behavior of your item.

=== Text ===
To begin, find a “dummy item” in the ''Items'' section of SkyTemple that has a name <code>[M:D1]$$$</code>. Double-clicking opens the item’s settings, defaulting to the '''Text''' tab. From there you can enter a name, descriptions, category, buy price, and sell price. For more detailed descriptions of these options, see [[Item Data]]. There are also options to set a Sprite ID and Palette ID. Cycling through these changes the item sprite, and the colors used when displaying it.
[[File:Image tutorial 1 item text.png|alt=Screenshot of SkyTemple showing Item ID settings and dummy text|center|thumb|Example of default dummy text]]

=== General ===
Switch to the '''General''' tab. These settings generally affect how this Item behaves in menus, including the Move ID field. ''Unless making a TM/HM, this should stay set to '''0'''.'' For more examples and detailed descriptions of these options, see [[Item Data#General|Item Data - General]].
[[File:Item tutorial 2 general.png|alt=Screenshot of SkyTemple with default General settings|center|thumb|Example of general settings for a non-stackable food item]]

=== Flags ===
This tab has flags used to determine AI behavior in-game it looks like this . Depending on which ID you choose to edit, the ''"Is Valid"'' or ''"Is in T/D''" switches could be flipped or not. Either way, all switches will be shown like this:
[[File:Item tutorial 3 flags.png|alt=Screenshot of SkyTemple's list of item flags, with all of them disabled/turned off|center|thumb|Example with all flags disabled (default dummy configuration)]]
The most important one to note is “'''Is Valid.'''” ''This should always be on if you want to use the item!'' Otherwise it cannot be added to the dungeon spawn menus, and will show up as a nonfunctional Plain Seed if manually added to the Treasure Bag.

For more detailed descriptions of these options, see [[Item Data#Flags|Item Data - Flags]].

Toggle these to fit your desired behavior. Once satisfied with these settings, save before continuing.

=== Item Effects Code (Behavior in Dungeons) ===
The ''effects code'' controls what the item does when used in a dungeon. The table containing these can be found in ''Patches > ASM > Item Effects''. Viewing this requires the [[ExtractItemCode]] patch.
[[File:Item tutorial 4 item effects nav.png|alt=Navigation/nested menu for Item Effects entry|center]]
The items are sorted ''alphabetically''. If you do not see your new item in the list, you may need to reload the ROM first. This table on the (default) '''Item''' '''Effects''' tab is where you can edit the Effect ID. By default, dummy items have an Effect ID of ''86''. Double-click on the number next to your item to enter a new one.

Switching to the '''Effects Code''' tab has a dropdown menu where you can better see which effect is associated with what item.
[[File:Item tutorial 5 effect dropdown.png|alt=Screenshot showing 2 items sharing an Effect ID|center|thumb|Example of 2 items sharing an Effect ID]]

==== Adding Custom Effects ====
If you want to add any custom effects that don’t exist in the base game, that requires ASM code. You can add a new Effect ID by clicking the plus (+) button next to the Effect ID menu, which creates a new entry in the dropdown menu. Selecting it shows the “Used By” table is empty because no item is assigned to it when first created. Import the ASM file; once successful, switch back to the '''Item''' '''Effects''' tab to assign the new Effect ID to an item.

== Item Sprites ==
The following will walk you through how to create an import an image that fits EoS's dungeon sprite restrictions.

=== Preparing an Image ===
Item sprites in EoS must be 16 x 16 pixels, set as indexed PNGs using a specific set of colors. The image below is an ''example'' of the full colormap used by all floor item sprites (don't download it from this page, it's been compressed).
[[File:Item tutorial 6 colormap ex.png|alt=Screenshot of dungeon colormap|center]]
Each of the rows makes up ''one'' individual palette, 15 in total (numbered 0-14). When creating sprites, you must pick a row to use and stick with it—using colors from multiple rows will cause SkyTemple to reject the import with an error. This is where the Palette ID number from the ''Items Settings'' comes in. It determines which row (and its corresponding colors) will be used. Switching to a different Palette ID (ex: from 2 to 3, or row 3 to row 4) will still reference the same positions, but with the color mappings of the new row. ''This includes the transparency color (blue) and outline color (black).''
[[File:Image tutorial 7 pal ex.png|alt=Example of indexes carrying over between palettes, arrows drawn between Palette 2 and 3|center|thumb|Palette 2 -> Palette 3]]
A more in-depth example of this is shown below as we extract the colormap for our use.

It is recommended to start sprinting with the full colormap imported into your sprite editor, so that there are no issues with the indexes later. The easiest way to get the colormap is to export an existing sprite! Navigate to the '''Dungeon Graphics''' dropdown, and you will see a list of items for ''Tilesets, Backgrounds (used for [[Fixed Room|Fixed Rooms]], with a tutorial on those [[Fixed Room Guide|here]]), Traps, Items, and Color Map.'' The one we are interested in is '''Items'''.
[[File:Item tutorial dungeon graphics nav.png|alt=Screenshot of ST dropdown for Dungeon Graphics, with Item sprites located there|center]]
''Important: The colormap seen in this section is different compared to the one exported with items. Do not use the "Color Map" entry from this dropdown unless you know what you're doing.''

Exporting the Stick with the Palette ID set to '''1''' shows this message:[[File:Item tutorial 8 exporting stick.png|alt=Screenshot of Stick sprite with the Palette ID set to 1|center|border]](Note: all ST screenshots are cropped to save space, the editor does not shrink this much)[[File:Item tutorial 9 export dialog.png|alt=Screenshot of export dialog ("This exports currently selected image with the currently selected palette. image will contain all palettes")|center|border]]
This means that the sprite of the Stick will ''look'' brown, but still have the full colormap in its data. Opening the PNG in a sprite editor shows which colors will be used in each variation of the palette. Using an eyedrop tool or color selection mechanic can highlight the index of the brown being used (index 25). Finding the other shades of brown from there gives a point of reference for each row.
[[File:Item tutorial 10 stick index example.png|alt=Screenshot of Stick PNG open in sprite editor, showing which colors share the same columns|center|thumb|408x408px|These 3 colors share the same positions within every palette]]
This is useful if you make a sprite that you want ''multiple variants'' of (Stick, Iron Thorn, Apple, Golden Apple, etc.).

From there, you can save the colormap in your sprite editor to load as needed and create your sprite with your chosen colors. Note that you ''can'' make/import a custom palette, but that may affect existing sprites, and is out of scope of this tutorial at the moment.

Here is an example of a Cheri Berry sprite, not intended to have variants. You can see the sprite only uses colors from Palette 3 (row 4 of the colormap).
[[File:Item tutorial 11 full row use example.png|alt=Screenshot of a cheri berri (red and green), Example of using almost all colors in a palette|center|thumb|Example of using almost all colors in a palette (sprite credit: deltaflare)]]

=== Importing an Image into Slot 63 ===
Each item sprite in the game takes up one “slot” that is reserved for use in dungeons. To see which slots are valid to use, see the list in [[Item/Trap Graphics]]. Slots 0 – 62 are used for existing items, with slot 63 being unused in the base game. Given this, it looks like a blank blue square in SkyTemple, free to be used.
[[File:Item tutorial 12 slot 63 default.png|alt=Screenshot of slot 63 (blank unused sprite)|center|300x300px]]
Before clicking “Import,” make sure to set the Palette ID to the number you want to use for the ''new'' item. This helps the sprite look “as intended” to check that everything looks correct. Make sure to have the “import palettes” option turned '''off''', and the “insert as NEW image” option turned '''off''' (because this is replacing a currently blank sprite with your image).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]
Remember that a single sprite can have multiple color variations (Berries, Sticks, etc.), so there is no need for duplicates if you have the desired color indexes matching between rows. If you are only importing ''one'' sprite, feel free to skip to [[How to add custom Items#Setting the Sprite|Setting the Sprite]]. If you plan to import more sprites, ''read the “'''Importing Past Slot 63'''” section below''.

==== Possible Errors (& Fixes) ====
Here are some examples of errors that could happen, with the tile details removed to help explain the cause.

'''“Expected colors are from Palette 0” when using a non-0 palette'''
[[File:Item tutorial 14 error 1.png|alt=Screenshot of error that could happen when importing into Slot 63 specifically|center|400x400px]]
Even with the Palette ID number set in the UI, '''the tool first looks at the index number of the ''transparent'' color to start checking the rest.''' This means if you mistakenly used the transparent color from Palette 0 when making your sprite, the editor ''now expects everything to come from'' ''Palette 0''. “Color 49” is the black outline color in ''Palette 3''. Because “color 49” is not an expected color ("color 1" is the s the black outline color in Palette 0), the editor rejects the image.

'''“Expected colors are from Palette x”'''
[[File:Item tutorial 15 error 2.png|alt=Error for uploading to slot 63|center|400x400px]]
Even with the transparency and outline colors corrected, you may still get an “expected colors” error, despite them matching the palette at a glance. Note that Palettes 1 and 3 share a set of greens (index 27, and index 59). Using the “incorrect green” causes the error (especially if indexing a RGB-mode sprite; the drawing program could attempt to auto-assign incorrect indexes). This is why it's recommended to work directly with the colormap.

To fix any of these errors, correct the offending colors in your PNG and import again.

=== Importing Past Slot 63 ===
As noted in [[Item/Trap Graphics#Sprite Slots]], '''slots 64 - 81''' will always be replaced by the game with status sprites. This means whatever you import into these slots is ''not permanent,'' and the next valid slot is '''82'''.

By default, SkyTemple only shows entries for the existing slots. In order to reach slot, you need to import “blank” sprites. Create a PNG that uses the dungeon item colormap, filled with Palette 0’s blue transparency color. When importing, make sure to have “insert a new entry” option turned '''on''', so slot 63 isn’t replaced.
[[File:Item tutorial 16 import settings past 63.png|alt=Screenshot of import settings to add a new entry|center|300x300px]]
[[File:Item tutorial 17 slot 64.png|alt=Example of what slot 64 should look like (blank blue image)|center|300x300px]]
Now a new entry exists at '''slot 64'''! Continue doing this until you reach '''slot 81'''. Once you have imported a blank sprite into slot 81, you can import a proper sprite with the “insert a new entry” option turned '''on'''. This will create a permanent sprite in '''slot 82'''.

You can freely continue this process with '''slots 83 – 95''', as needed.

==== Possible Error (& Fix) ====
[[File:Item tutorial uncaught error ex.png|alt=Screenshot of uncaught error that happens when importing with incorrect colors|center|thumb|400x400px|Uncaught error that happens when importing with incorrect colors]]
If you have any “expected color” issues, SkyTemple first will give an error showing the incorrect index, then throw an uncaught TypeError exception. This is slightly different from the error with slot 63 because SkyTemple first creates an entry, then cannot process the color data when importing. So the entry becomes invalid while the editor still tries to display it. ''Don’t panic! You can correct this without having to reload/close without saving!'' Correct the color errors and import as ''replacing'' ''current entry'' (i.e.: replacing the invalid entry with colors that the editor can properly validate).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]

==== Current Limitations - Important! ====
{{Main|Item/Trap Graphics#Sprite Slots}}
Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row (this includes things like Pokémon shadows).

=== Setting the Sprite ===
Now that the sprite has been imported, you can set it to be associated with your new item!

Go back to the ''Items > [item name]'' , and set the Sprite ID to '''63''' (or whatever index you inserted it at). Increment the Palette ID, and you will see the sprite change colors depending on the ones you used (remember the IDs start at 0).
[[Category:Tutorials]]

How to add custom Items

2025-04-11T12:54:32Z

Deltaflare: /* Preparing an Image */ clarifying Dungeon Graphics nav

Adding custom items can be broken down into two parts: setting item properties and adding a sprite (if needed).

== Item Settings ==
The following will walk you through how to customize the properties and behavior of your item.

=== Text ===
To begin, find a “dummy item” in the ''Items'' section of SkyTemple that has a name <code>[M:D1]$$$</code>. Double-clicking opens the item’s settings, defaulting to the '''Text''' tab. From there you can enter a name, descriptions, category, buy price, and sell price. For more detailed descriptions of these options, see [[Item Data]]. There are also options to set a Sprite ID and Palette ID. Cycling through these changes the item sprite, and the colors used when displaying it.
[[File:Image tutorial 1 item text.png|alt=Screenshot of SkyTemple showing Item ID settings and dummy text|center|thumb|Example of default dummy text]]

=== General ===
Switch to the '''General''' tab. These settings generally affect how this Item behaves in menus, including the Move ID field. ''Unless making a TM/HM, this should stay set to '''0'''.'' For more examples and detailed descriptions of these options, see [[Item Data#General|Item Data - General]].
[[File:Item tutorial 2 general.png|alt=Screenshot of SkyTemple with default General settings|center|thumb|Example of general settings for a non-stackable food item]]

=== Flags ===
This tab has flags used to determine AI behavior in-game it looks like this . Depending on which ID you choose to edit, the ''"Is Valid"'' or ''"Is in T/D''" switches could be flipped or not. Either way, all switches will be shown like this:
[[File:Item tutorial 3 flags.png|alt=Screenshot of SkyTemple's list of item flags, with all of them disabled/turned off|center|thumb|Example with all flags disabled (default dummy configuration)]]
The most important one to note is “'''Is Valid.'''” ''This should always be on if you want to use the item!'' Otherwise it cannot be added to the dungeon spawn menus, and will show up as a nonfunctional Plain Seed if manually added to the Treasure Bag.

For more detailed descriptions of these options, see [[Item Data#Flags|Item Data - Flags]].

Toggle these to fit your desired behavior. Once satisfied with these settings, save before continuing.

=== Item Effects Code (Behavior in Dungeons) ===
The ''effects code'' controls what the item does when used in a dungeon. The table containing these can be found in ''Patches > ASM > Item Effects''. Viewing this requires the [[ExtractItemCode]] patch.
[[File:Item tutorial 4 item effects nav.png|alt=Navigation/nested menu for Item Effects entry|center]]
The items are sorted ''alphabetically''. If you do not see your new item in the list, you may need to reload the ROM first. This table on the (default) '''Item''' '''Effects''' tab is where you can edit the Effect ID. By default, dummy items have an Effect ID of ''86''. Double-click on the number next to your item to enter a new one.

Switching to the '''Effects Code''' tab has a dropdown menu where you can better see which effect is associated with what item.
[[File:Item tutorial 5 effect dropdown.png|alt=Screenshot showing 2 items sharing an Effect ID|center|thumb|Example of 2 items sharing an Effect ID]]

==== Adding Custom Effects ====
If you want to add any custom effects that don’t exist in the base game, that requires ASM code. You can add a new Effect ID by clicking the plus (+) button next to the Effect ID menu, which creates a new entry in the dropdown menu. Selecting it shows the “Used By” table is empty because no item is assigned to it when first created. Import the ASM file; once successful, switch back to the '''Item''' '''Effects''' tab to assign the new Effect ID to an item.

== Item Sprites ==
The following will walk you through how to create an import an image that fits EoS's dungeon sprite restrictions.

=== Preparing an Image ===
Item sprites in EoS must be 16 x 16 pixels, set as indexed PNGs using a specific set of colors. The image below is an ''example'' of the full colormap used by all floor item sprites (don't download it from this page, it's been compressed).
[[File:Item tutorial 6 colormap ex.png|alt=Screenshot of dungeon colormap|center]]
Each of the rows makes up ''one'' individual palette, 15 in total (numbered 0-14). When creating sprites, you must pick a row to use and stick with it—using colors from multiple rows will cause SkyTemple to reject the import with an error. This is where the Palette ID number from the ''Items Settings'' comes in. It determines which row (and its corresponding colors) will be used. Switching to a different Palette ID (ex: from 2 to 3, or row 3 to row 4) will still reference the same positions, but with the color mappings of the new row. ''This includes the transparency color (blue) and outline color (black).''
[[File:Image tutorial 7 pal ex.png|alt=Example of indexes carrying over between palettes, arrows drawn between Palette 2 and 3|center|thumb|Palette 2 -> Palette 3]]
A more in-depth example of this is shown below as we extract the colormap for our use.

It is recommended to start sprinting with the full colormap imported into your sprite editor, so that there are no issues with the indexes later. The easiest way to get the colormap is to export an existing sprite! Navigate to the '''Dungeon Graphics''' dropdown, and you will see a list of items for ''Tilesets, Backgrounds (used for [[Fixed Room|Fixed Rooms]], with a tutorial on those [[Fixed Room Guide|here]]), Traps, Items, and Color Map.'' The one we are interested in is '''Items'''.
[[File:Item tutorial dungeon graphics nav.png|alt=Screenshot of ST dropdown for Dungeon Graphics, with Item sprites located there|center]]
''Important: The colormap seen in this section is different compared to the one exported with items. Do not use the "Color Map" entry from this dropdown unless you know what you're doing.''

Exporting the Stick with the Palette ID set to '''1''' shows this message:[[File:Item tutorial 8 exporting stick.png|alt=Screenshot of Stick sprite with the Palette ID set to 1|center|border]](Note: all ST screenshots are cropped to save space, the editor does not shrink this much)[[File:Item tutorial 9 export dialog.png|alt=Screenshot of export dialog ("This exports currently selected image with the currently selected palette. image will contain all palettes")|center|border]]
This means that the sprite of the Stick will ''look'' brown, but still have the full colormap in its data. Opening the PNG in a sprite editor shows which colors will be used in each variation of the palette. Using an eyedrop tool or color selection mechanic can highlight the index of the brown being used (index 25). Finding the other shades of brown from there gives a point of reference for each row.
[[File:Item tutorial 10 stick index example.png|alt=Screenshot of Stick PNG open in sprite editor, showing which colors share the same columns|center|thumb|408x408px|These 3 colors share the same positions within every palette]]
This is useful if you make a sprite that you want ''multiple variants'' of (Stick, Iron Thorn, Apple, Golden Apple, etc.).

From there, you can save the colormap in your sprite editor to load as needed and create your sprite with your chosen colors. Note that you ''can'' make/import a custom palette, but that may affect existing sprites, and is out of scope of this tutorial at the moment.

Here is an example of a Cheri Berry sprite, not intended to have variants. You can see the sprite only uses colors from Palette 3 (row 4 of the colormap).
[[File:Item tutorial 11 full row use example.png|alt=Screenshot of a cheri berri (red and green), Example of using almost all colors in a palette|center|thumb|Example of using almost all colors in a palette (sprite credit: deltaflare)]]

=== Importing an Image into Slot 63 ===
Each item sprite in the game takes up one “slot” that is reserved for use in dungeons. To see which slots are valid to use, see the list in [[Item/Trap Graphics]]. Slots 0 – 62 are used for existing items, with slot 63 being unused in the base game. Given this, it looks like a blank blue square in SkyTemple, free to be used.
[[File:Item tutorial 12 slot 63 default.png|alt=Screenshot of slot 63 (blank unused sprite)|center|300x300px]]
Before clicking “Import,” make sure to set the Palette ID to the number you want to use for the ''new'' item. This helps the sprite look “as intended” to check that everything looks correct. Make sure to have the “import palettes” option turned '''off''', and the “insert as NEW image” option turned '''off''' (because this is replacing a currently blank sprite with your image).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]
Remember that a single sprite can have multiple color variations (Berries, Sticks, etc.), so there is no need for duplicates if you have the desired color indexes matching between rows. If you are only importing ''one'' sprite, feel free to skip to [[How to add custom Items#Setting the Sprite|Setting the Sprite]]. If you plan to import more sprites, ''read the “'''Importing Past Slot 63'''” section below''.

==== Possible Errors (& Fixes) ====
Here are some examples of errors that could happen, with the tile details removed to help explain the cause.

'''“Expected colors are from Palette 0” when using a non-0 palette'''
[[File:Item tutorial 14 error 1.png|alt=Screenshot of error that could happen when importing into Slot 63 specifically|center|400x400px]]
Even with the Palette ID number set in the UI, '''the tool first looks at the index number of the ''transparent'' color to start checking the rest.''' This means if you mistakenly used the transparent color from Palette 0 when making your sprite, the editor ''now expects everything to come from'' ''Palette 0''. “Color 49” is the black outline color in ''Palette 3''. Because “color 49” is not an expected color, the editor rejects the image.

'''“Expected colors are from Palette x”'''
[[File:Item tutorial 15 error 2.png|alt=Error for uploading to slot 63|center|400x400px]]
Even with the transparency and outline colors corrected, you may still get an “expected colors” error, despite them matching the palette at a glance. Note that Palettes 1 and 3 share a set of greens (index 27, and index 59). Using the “incorrect green” causes the error (especially if indexing a previously-RGB-mode sprite; the drawing program could attempt to auto-assign incorrect indexes). This is why it's recommended to work directly with the colormap.

To fix any of these errors, correct the offending colors in your PNG and import again.

=== Importing Past Slot 63 ===
As noted in [[Item/Trap Graphics#Sprite Slots]], '''slots 64 - 81''' will always be replaced by the game with status sprites. This means whatever you import into these slots is ''not permanent,'' and the next valid slot is '''82'''.

By default, SkyTemple only shows entries for the existing slots. In order to reach slot, you need to import “blank” sprites. Create a PNG that uses the dungeon item colormap, filled with Palette 0’s blue transparency color. When importing, make sure to have “insert a new entry” option turned '''on''', so slot 63 isn’t replaced.
[[File:Item tutorial 16 import settings past 63.png|alt=Screenshot of import settings to add a new entry|center|300x300px]]
[[File:Item tutorial 17 slot 64.png|alt=Example of what slot 64 should look like (blank blue image)|center|300x300px]]
Now a new entry exists at '''slot 64'''! Continue doing this until you reach '''slot 81'''. Once you have imported a blank sprite into slot 81, you can import a proper sprite with the “insert a new entry” option turned '''on'''. This will create a permanent sprite in '''slot 82'''.

You can freely continue this process with '''slots 83 – 95''', as needed.

==== Possible Error (& Fix) ====
[[File:Item tutorial uncaught error ex.png|alt=Screenshot of uncaught error that happens when importing with incorrect colors|center|thumb|400x400px|Uncaught error that happens when importing with incorrect colors]]
If you have any “expected color” issues, SkyTemple first will give an error showing the incorrect index, then throw an uncaught TypeError exception. This is slightly different from the error with slot 63 because SkyTemple first creates an entry, then cannot process the color data when importing. So the entry becomes invalid while the editor still tries to display it. ''Don’t panic! You can correct this without having to reload/close without saving!'' Correct the color errors and import as ''replacing'' ''current entry'' (i.e.: replacing the invalid entry with colors that the editor can properly validate).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]

==== Current Limitations - Important! ====
{{Main|Item/Trap Graphics#Sprite Slots}}
Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row (this includes things like Pokémon shadows).

=== Setting the Sprite ===
Now that the sprite has been imported, you can set it to be associated with your new item!

Go back to the ''Items > [item name]'' , and set the Sprite ID to '''63''' (or whatever index you inserted it at). Increment the Palette ID, and you will see the sprite change colors depending on the ones you used (remember the IDs start at 0).
[[Category:Tutorials]]

File:Item tutorial dungeon graphics nav.png

2025-04-11T12:35:10Z

Deltaflare:

Screenshot of ST dropdown for Dungeon Graphics

How to add custom Items

2025-04-10T18:30:44Z

Deltaflare: slight wording changes, added category

Adding custom items can be broken down into two parts: setting item properties and adding a sprite (if needed).

== Item Settings ==
The following will walk you through how to customize the properties and behavior of your item.

=== Text ===
To begin, find a “dummy item” in the ''Items'' section of SkyTemple that has a name <code>[M:D1]$$$</code>. Double-clicking opens the item’s settings, defaulting to the '''Text''' tab. From there you can enter a name, descriptions, category, buy price, and sell price. For more detailed descriptions of these options, see [[Item Data]]. There are also options to set a Sprite ID and Palette ID. Cycling through these changes the item sprite, and the colors used when displaying it.
[[File:Image tutorial 1 item text.png|alt=Screenshot of SkyTemple showing Item ID settings and dummy text|center|thumb|Example of default dummy text]]

=== General ===
Switch to the '''General''' tab. These settings generally affect how this Item behaves in menus, including the Move ID field. ''Unless making a TM/HM, this should stay set to '''0'''.'' For more examples and detailed descriptions of these options, see [[Item Data#General|Item Data - General]].
[[File:Item tutorial 2 general.png|alt=Screenshot of SkyTemple with default General settings|center|thumb|Example of general settings for a non-stackable food item]]

=== Flags ===
This tab has flags used to determine AI behavior in-game it looks like this . Depending on which ID you choose to edit, the ''"Is Valid"'' or ''"Is in T/D''" switches could be flipped or not. Either way, all switches will be shown like this:
[[File:Item tutorial 3 flags.png|alt=Screenshot of SkyTemple's list of item flags, with all of them disabled/turned off|center|thumb|Example with all flags disabled (default dummy configuration)]]
The most important one to note is “'''Is Valid.'''” ''This should always be on if you want to use the item!'' Otherwise it cannot be added to the dungeon spawn menus, and will show up as a nonfunctional Plain Seed if manually added to the Treasure Bag.

For more detailed descriptions of these options, see [[Item Data#Flags|Item Data - Flags]].

Toggle these to fit your desired behavior. Once satisfied with these settings, save before continuing.

=== Item Effects Code (Behavior in Dungeons) ===
The ''effects code'' controls what the item does when used in a dungeon. The table containing these can be found in ''Patches > ASM > Item Effects''. Viewing this requires the [[ExtractItemCode]] patch.
[[File:Item tutorial 4 item effects nav.png|alt=Navigation/nested menu for Item Effects entry|center]]
The items are sorted ''alphabetically''. If you do not see your new item in the list, you may need to reload the ROM first. This table on the (default) '''Item''' '''Effects''' tab is where you can edit the Effect ID. By default, dummy items have an Effect ID of ''86''. Double-click on the number next to your item to enter a new one.

Switching to the '''Effects Code''' tab has a dropdown menu where you can better see which effect is associated with what item.
[[File:Item tutorial 5 effect dropdown.png|alt=Screenshot showing 2 items sharing an Effect ID|center|thumb|Example of 2 items sharing an Effect ID]]

==== Adding Custom Effects ====
If you want to add any custom effects that don’t exist in the base game, that requires ASM code. You can add a new Effect ID by clicking the plus (+) button next to the Effect ID menu, which creates a new entry in the dropdown menu. Selecting it shows the “Used By” table is empty because no item is assigned to it when first created. Import the ASM file; once successful, switch back to the '''Item''' '''Effects''' tab to assign the new Effect ID to an item.

== Item Sprites ==
The following will walk you through how to create an import an image that fits EoS's dungeon sprite restrictions.

=== Preparing an Image ===
Item sprites in EoS must be 16 x 16 pixels, set as indexed PNGs using a specific set of colors. The image below is an ''example'' of the full colormap used by all floor item sprites (don't download it from this page, it's been compressed).
[[File:Item tutorial 6 colormap ex.png|alt=Screenshot of dungeon colormap|center]]
Each of the rows makes up ''one'' individual palette, 15 in total (numbered 0-14). When creating sprites, you must pick a row to use and stick with it—using colors from multiple rows will cause SkyTemple to reject the import with an error. This is where the Palette ID number from the ''Items Settings'' comes in. It determines which row (and its corresponding colors) will be used. Switching to a different Palette ID (ex: from 2 to 3, or row 3 to row 4) will still reference the same positions, but with the color mappings of the new row. ''This includes the transparency color (blue) and outline color (black).''
[[File:Image tutorial 7 pal ex.png|alt=Example of indexes carrying over between palettes, arrows drawn between Palette 2 and 3|center|thumb|Palette 2 -> Palette 3]]
A more in-depth example of this is shown below as we extract the colormap for our use.

It is recommended to start sprinting with the full colormap imported into your sprite editor, so that there are no issues with the indexes later. The easiest way to get the colormap is to export an existing sprite. As an example, exporting the Stick with the Palette ID set to '''1''' shows this message:

(Note: all ST screenshots are cropped to save space)
[[File:Item tutorial 8 exporting stick.png|alt=Screenshot of Stick sprite with the Palette ID set to 1|center|border]]
[[File:Item tutorial 9 export dialog.png|alt=Screenshot of export dialog ("This exports currently selected image with the currently selected palette. image will contain all palettes")|center|border]]
This means that the sprite of the Stick will ''look'' brown, but still have the full colormap in its data. Opening the PNG in a sprite editor shows which colors will be used in each variation of the palette. Using an eyedrop tool or color selection mechanic can highlight the index of the brown being used (index 25). Finding the other shades of brown from there gives a point of reference for each row.
[[File:Item tutorial 10 stick index example.png|alt=Screenshot of Stick PNG open in sprite editor, showing which colors share the same columns|center|thumb|408x408px|These 3 colors share the same positions within every palette]]
This is useful if you make a sprite that you want ''multiple variants'' of (Stick, Iron Thorn, Apple, Golden Apple, etc.).

From there, you can save the colormap in your sprite editor to load as needed and create your sprite with your chosen colors. Note that you ''can'' make/import a custom palette, but that may affect existing sprites, and is out of scope of this tutorial at the moment.

Here is an example of a Cheri Berry sprite, not intended to have variants. You can see the sprite only uses colors from Palette 3 (row 4 of the colormap).
[[File:Item tutorial 11 full row use example.png|alt=Screenshot of a cheri berri (red and green), Example of using almost all colors in a palette|center|thumb|Example of using almost all colors in a palette (sprite credit: deltaflare)]]

=== Importing an Image into Slot 63 ===
Each item sprite in the game takes up one “slot” that is reserved for use in dungeons. To see which slots are valid to use, see the list in [[Item/Trap Graphics]]. Slots 0 – 62 are used for existing items, with slot 63 being unused in the base game. Given this, it looks like a blank blue square in SkyTemple, free to be used.
[[File:Item tutorial 12 slot 63 default.png|alt=Screenshot of slot 63 (blank unused sprite)|center|300x300px]]
Before clicking “Import,” make sure to set the Palette ID to the number you want to use for the ''new'' item. This helps the sprite look “as intended” to check that everything looks correct. Make sure to have the “import palettes” option turned '''off''', and the “insert as NEW image” option turned '''off''' (because this is replacing a currently blank sprite with your image).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]
Remember that a single sprite can have multiple color variations (Berries, Sticks, etc.), so there is no need for duplicates if you have the desired color indexes matching between rows. If you are only importing ''one'' sprite, feel free to skip to [[How to add custom Items#Setting the Sprite|Setting the Sprite]]. If you plan to import more sprites, ''read the “'''Importing Past Slot 63'''” section below''.

==== Possible Errors (& Fixes) ====
Here are some examples of errors that could happen, with the tile details removed to help explain the cause.

'''“Expected colors are from Palette 0” when using a non-0 palette'''
[[File:Item tutorial 14 error 1.png|alt=Screenshot of error that could happen when importing into Slot 63 specifically|center|400x400px]]
Even with the Palette ID number set in the UI, '''the tool first looks at the index number of the ''transparent'' color to start checking the rest.''' This means if you mistakenly used the transparent color from Palette 0 when making your sprite, the editor ''now expects everything to come from'' ''Palette 0''. “Color 49” is the black outline color in ''Palette 3''. Because “color 49” is not an expected color, the editor rejects the image.

'''“Expected colors are from Palette x”'''
[[File:Item tutorial 15 error 2.png|alt=Error for uploading to slot 63|center|400x400px]]
Even with the transparency and outline colors corrected, you may still get an “expected colors” error, despite them matching the palette at a glance. Note that Palettes 1 and 3 share a set of greens (index 27, and index 59). Using the “incorrect green” causes the error (especially if indexing a previously-RGB-mode sprite; the drawing program could attempt to auto-assign incorrect indexes). This is why it's recommended to work directly with the colormap.

To fix any of these errors, correct the offending colors in your PNG and import again.

=== Importing Past Slot 63 ===
As noted in [[Item/Trap Graphics#Sprite Slots]], '''slots 64 - 81''' will always be replaced by the game with status sprites. This means whatever you import into these slots is ''not permanent,'' and the next valid slot is '''82'''.

By default, SkyTemple only shows entries for the existing slots. In order to reach slot, you need to import “blank” sprites. Create a PNG that uses the dungeon item colormap, filled with Palette 0’s blue transparency color. When importing, make sure to have “insert a new entry” option turned '''on''', so slot 63 isn’t replaced.
[[File:Item tutorial 16 import settings past 63.png|alt=Screenshot of import settings to add a new entry|center|300x300px]]
[[File:Item tutorial 17 slot 64.png|alt=Example of what slot 64 should look like (blank blue image)|center|300x300px]]
Now a new entry exists at '''slot 64'''! Continue doing this until you reach '''slot 81'''. Once you have imported a blank sprite into slot 81, you can import a proper sprite with the “insert a new entry” option turned '''on'''. This will create a permanent sprite in '''slot 82'''.

You can freely continue this process with '''slots 83 – 95''', as needed.

==== Possible Error (& Fix) ====
[[File:Item tutorial uncaught error ex.png|alt=Screenshot of uncaught error that happens when importing with incorrect colors|center|thumb|400x400px|Uncaught error that happens when importing with incorrect colors]]
If you have any “expected color” issues, SkyTemple first will give an error showing the incorrect index, then throw an uncaught TypeError exception. This is slightly different from the error with slot 63 because SkyTemple first creates an entry, then cannot process the color data when importing. So the entry becomes invalid while the editor still tries to display it. ''Don’t panic! You can correct this without having to reload/close without saving!'' Correct the color errors and import as ''replacing'' ''current entry'' (i.e.: replacing the invalid entry with colors that the editor can properly validate).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]

==== Current Limitations - Important! ====
{{Main|Item/Trap Graphics#Sprite Slots}}
Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row (this includes things like Pokémon shadows).

=== Setting the Sprite ===
Now that the sprite has been imported, you can set it to be associated with your new item!

Go back to the ''Items > [item name]'' , and set the Sprite ID to '''63''' (or whatever index you inserted it at). Increment the Palette ID, and you will see the sprite change colors depending on the ones you used (remember the IDs start at 0).
[[Category:Tutorials]]

Item/Trap Graphics

2025-04-10T18:22:31Z

Deltaflare: /* Sprite Slots */ remove attr

{{Stub}}

Within the [[SkyTemple]] editor, graphics used by the game to render items and traps (including the Wonder Tile and stairs) can be edited.

== Item Sprites ==
EoS has 120 slots (numbered 0 - 119) used for items and effect sprites in dungeons. Not all are permanent entries, some are updated at runtime with certain animations. In SkyTemple, slots 0 - 63 can always be seen. These are the sprites used for existing floor items. Slot 63 is unnused in the base game, and appears in SkyTemple as a blank, transparent sprite.

=== Sprite Slots ===
It is possible to add custom item sprites without interfering with most existing ones. The valid, usable slots are ''italicized''.

* '''Slots 0 - 62''' are existing floor items
* '''''Slot 63''' can be given a new item sprite '''(1)'''''
* '''Slots 64 - 81''' will always be replaced by the game at runtime with status animation sprites
* '''''Slots 82 - 95''' can be given new item sprites '''(14)'''''
* Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row. Creating entries for these slots in SkyTemple (even if adding the correct sprites) ''will force the sprites to use Palette 0.'' This can affect entries that may have had different a palette originally assigned to them. For example, the ally shadows will no longer be shaded yellow, turning magenta instead. These entries include:
** 96: small enemy shadow (black)
** 97: big enemy shadow (black)
** 98: small ally shadow (yellow)
** 99: big ally shadow (yellow)
** 100: big ally shadow (yellow)
** 101: small arrow?
** 102: small arrow?
** 103: beta "for HP" text
* '''''Slots 104 - 107''' can be given new item sprites '''(4)'''''
* '''Slots 108 - 110''' will always be replaced by the game at runtime with water shadow animation sprites
* '''''Slots 111 - 119''' can be given new item sprites '''(9)'''''

Any new entry after that slot (120+) will roll over into the next set of tiles, which will overwrite attack animation sprites. In total, there are '''28 slots''' available for custom item sprites.{{NavSkyTemple}}

How to add custom Items

2025-04-10T04:16:22Z

Deltaflare: minor formatting fixes, linking to sections

Adding custom items can be broken down into two parts: setting item properties and adding a sprite (if needed).

== Item Settings ==
The following will walk you through how to customize the properties and behavior of your item.

=== Text ===
To begin, find a “dummy item” in the ''Items'' section of SkyTemple that has a name <code>[M:D1]$$$</code>. Double-clicking opens the item’s settings, defaulting to the '''Text''' tab. From there you can enter a name, descriptions, category, buy price, and sell price. For more detailed descriptions of these options, see [[Item Data]]. There are also options to set a Sprite ID and Palette ID. Cycling through these changes the item sprite, and the colors used when displaying it.
[[File:Image tutorial 1 item text.png|alt=Screenshot of SkyTemple showing Item ID settings and dummy text|center|thumb|Example of default dummy text]]

=== General ===
Switch to the '''General''' tab. These settings generally affect how this Item behaves in menus, including the Move ID field. ''Unless making a TM/HM, this should stay set to '''0'''.'' For more examples and detailed descriptions of these options, see [[Item Data#General|Item Data - General]].
[[File:Item tutorial 2 general.png|alt=Screenshot of SkyTemple with default General settings|center|thumb|Example of general settings for a non-stackable food item]]

=== Flags ===
This tab has flags used to determine AI behavior in-game it looks like this . Depending on which ID you choose to edit, the ''"Is Valid"'' or ''"Is in T/D''" switches could be flipped or not. Either way, all switches will be shown like this:
[[File:Item tutorial 3 flags.png|alt=Screenshot of SkyTemple's list of item flags, with all of them disabled/turned off|center|thumb|Example with all flags disabled (default dummy configuration)]]
The most important one to note is “'''Is Valid.'''” ''This should always be on if you want to use the item!'' Otherwise it cannot be added to the dungeon spawn menus, and will show up as a nonfunctional Plain Seed if manually added to the Treasure Bag.

For more detailed descriptions of these options, see [[Item Data#Flags|Item Data - Flags]].

Toggle these to fit your desired behavior. Once satisfied with these settings, save before continuing.

=== Item Effects Code (Behavior in Dungeons) ===
The ''effects code'' controls what the item does when used in a dungeon. The table containing these can be found in ''Patches > ASM > Item Effects''. Viewing this requires the [[ExtractItemCode]] patch.
[[File:Item tutorial 4 item effects nav.png|alt=Navigation/nested menu for Item Effects entry|center]]
The items are sorted ''alphabetically''. If you do not see your new item in the list, you may need to reload the ROM first. This table on the (default) '''Item''' '''Effects''' tab is where you can edit the Effect ID. By default, dummy items have an Effect ID of ''86''. Double-click on the number next to your item to enter a new one.

Switching to the '''Effects Code''' tab has a dropdown menu where you can better see which effect is associated with what item.
[[File:Item tutorial 5 effect dropdown.png|alt=Screenshot showing 2 items sharing an Effect ID|center|thumb|Example of 2 items sharing an Effect ID]]

==== Adding Custom Effects ====
If you want to add any custom effects that don’t exist in the base game, that requires ASM code. You can add a new Effect ID by clicking the plus (+) button next to the Effect ID menu, which creates a new entry in the dropdown menu. Selecting it shows the “Used By” table is empty because no item is assigned to it when first created. Import the ASM file; once successful, switch back to the '''Item''' '''Effects''' tab to assign the new Effect ID to an item.

== Item Sprites ==
The following will walk you through how to create an import an image that fits EoS's dungeon sprite restrictions.

=== Preparing an Image ===
Item sprites in EoS must be 16 x 16 pixels, set as indexed PNGs using a specific set of colors. The image below is an ''example'' of the full colormap used by all floor item sprites (don't download it from this page, it's been compressed).
[[File:Item tutorial 6 colormap ex.png|alt=Screenshot of dungeon colormap|center]]
Each of the rows makes up ''one'' individual palette, 15 in total (numbered 0-14). When creating sprites, you must pick a row to use and stick with it—using colors from multiple rows will cause SkyTemple to reject the import with an error. This is where the Palette ID number from the ''Items Settings'' comes in. It determines which row (and its corresponding colors) will be used. Switching to a different Palette ID (ex: from 2 to 3, or row 3 to row 4) will still reference the same positions, but with the color mappings of the new row. ''This includes the transparency color (blue) and outline color (black).''
[[File:Image tutorial 7 pal ex.png|alt=Example of indexes carrying over between palettes, arrows drawn between Palette 2 and 3|center|thumb|Palette 2 -> Palette 3]]
A more in-depth example of this is shown below as we extract the colormap for our use.

It is recommended to start sprinting with the full colormap imported into your sprite editor, so that there are no issues with the indexes later. The easiest way to get the colormap is to export an existing sprite. As an example, exporting the Stick with the Palette ID set to '''1''' shows this message:

(Note: all ST screenshots are cropped to save space)
[[File:Item tutorial 8 exporting stick.png|alt=Screenshot of Stick sprite with the Palette ID set to 1|center|border]]
[[File:Item tutorial 9 export dialog.png|alt=Screenshot of export dialog ("This exports currently selected image with the currently selected palette. image will contain all palettes")|center|border]]
This means that the sprite of the Stick will ''look'' brown, but still have the full colormap in its data. Opening the PNG in a sprite editor shows which colors will be used in each variation of the palette. Using an eyedrop tool or color selection mechanic can highlight the index of the brown being used (index 25). Finding the other shades of brown from there gives a point of reference for each row.
[[File:Item tutorial 10 stick index example.png|alt=Screenshot of Stick PNG open in sprite editor, showing which colors share the same columns|center|thumb|408x408px|These colors (23-25) share the same positions within every palette]]
This is useful if you make a sprite that you want ''multiple variants'' of (Stick, Iron Thorn, Apple, Golden Apple, etc.).

From there, you can save the colormap in your sprite editor to load as needed and create your sprite with your chosen colors. Note that you ''can'' make/import a custom palette, but that may affect existing sprites, and is out of scope of this tutorial at the moment.

Here is an example of a Cheri Berry sprite, not intended to have variants. You can see the sprite only uses colors from Palette 3 (row 4 of the colormap).
[[File:Item tutorial 11 full row use example.png|alt=Screenshot of a cheri berri (red and green), Example of using almost all colors in a palette|center|thumb|Example of using almost all colors in a palette (sprite credit: deltaflare)]]

=== Importing an Image into Slot 63 ===
Each item sprite in the game takes up one “slot” that is reserved for use in dungeons. To see which slots are valid to use, see the list in [[Item/Trap Graphics]]. Slots 0 – 62 are used for existing items, with slot 63 being unused in the base game. Given this, it looks like a blank blue square in SkyTemple, free to be used.
[[File:Item tutorial 12 slot 63 default.png|alt=Screenshot of slot 63 (blank unused sprite)|center|300x300px]]
Before clicking “Import,” make sure to set the Palette ID to the number you want to use for the ''new'' item. This helps the sprite look “as intended” to check that everything looks correct. Make sure to have the “import palettes” option turned '''off''', and the “insert as NEW image” option turned '''off''' (because this is replacing a currently blank sprite with your image).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]
Remember that a single sprite can have multiple color variations (Berries, Sticks, etc.), so there is no need for duplicates if you have the desired color indexes matching between rows. If you are only importing ''one'' sprite, feel free to skip to [[How to add custom Items#Setting the Sprite|Setting the Sprite]]. If you plan to import more sprites, ''read the “'''Importing Past Slot 63'''” section below''.

==== Possible Errors (& Fixes) ====
Here are some examples of errors that could happen, with the tile details removed to help explain the cause.

'''“Expected colors are from Palette 0” when using a non-0 palette'''
[[File:Item tutorial 14 error 1.png|alt=Screenshot of error that could happen when importing into Slot 63 specifically|center|400x400px]]
Even with the Palette ID number set in the UI, '''the tool first looks at the index number of the ''transparent'' color to start checking the rest.''' This means if you mistakenly used the transparent color from Palette 0 when making your sprite, the editor ''now expects everything to come from'' ''Palette 0''. “Color 49” is the black outline color in ''Palette 3''. Because “color 49” is not an expected color, the editor rejects the image.

'''“Expected colors are from Palette x”'''
[[File:Item tutorial 15 error 2.png|alt=Error for uploading to slot 63|center|400x400px]]
Even with the transparency and outline colors corrected, you may still get an “expected colors” error, despite them matching the palette at a glance. Note that Palettes 1 and 3 share a set of greens (index 27, and index 59). Using the “incorrect green” causes the error (especially if indexing a previously-RGB-mode sprite; the drawing program could attempt to auto-assign incorrect indexes). This is why it's recommended to work directly with the colormap.

To fix any of these errors, correct the offending colors in your PNG and import again.

=== Importing Past Slot 63 ===
As noted in [[Item/Trap Graphics#Sprite Slots]], '''slots 64 - 81''' will always be replaced by the game with status sprites. This means whatever you import into these slots is ''not permanent,'' and the next valid slot is '''82'''.

By default, SkyTemple only shows entries for the existing slots. In order to reach slot, you need to import “blank” sprites. Create a PNG that uses the dungeon item colormap, filled with Palette 0’s blue transparency color. When importing, make sure to have “insert a new entry” option turned '''on''', so slot 63 isn’t replaced.
[[File:Item tutorial 16 import settings past 63.png|alt=Screenshot of import settings to add a new entry|center|300x300px]]
[[File:Item tutorial 17 slot 64.png|alt=Example of what slot 64 should look like (blank blue image)|center|300x300px]]
Now a new entry exists at '''slot 64'''! Continue doing this until you reach '''slot 81'''. Once you have imported a blank sprite into slot 81, you can import a proper sprite with the “insert a new entry” option turned '''on'''. This will create a permanent sprite in '''slot 82'''.

You can freely continue this process with '''slots 83 – 95''', as needed.

==== Possible Error (& Fix) ====
[[File:Item tutorial uncaught error ex.png|alt=Screenshot of uncaught error that happens when importing with incorrect colors|center|thumb|400x400px|Uncaught error that happens when importing with incorrect colors]]
If you have any “expected color” issues, SkyTemple first will give an error showing the incorrect index, then throw an uncaught TypeError exception. This is slightly different from the error with slot 63 because SkyTemple first creates an entry then cannot process the color data, so the entry becomes invalid while the editor still tries to display it. ''Don’t panic! You can correct this without having to reload/close without saving!'' Correct the color errors and import as ''replacing'' ''current entry'' (i.e.: replacing the invalid entry with colors that the editor can properly validate).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]

==== Current Limitations - Important ====
{{Main|Item/Trap Graphics#Sprite Slots}}
Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row (this includes things like Pokémon shadows).

=== Setting the Sprite ===
Now that the sprite has been imported, you can set it to be associated with your new item!

Go back to the ''Items > [item name]'' , and set the Sprite ID to '''63''' (or whatever index you inserted it at). Increment the Palette ID, and you will see the sprite change colors depending on the ones you used (remember the IDs start at 0).

Item/Trap Graphics

2025-04-10T04:11:12Z

Deltaflare: /* Item Sprites */ clarifying slot 63 is visible in ST

{{Stub}}

Within the [[SkyTemple]] editor, graphics used by the game to render items and traps (including the Wonder Tile and stairs) can be edited.

== Item Sprites ==
EoS has 120 slots (numbered 0 - 119) used for items and effect sprites in dungeons. Not all are permanent entries, some are updated at runtime with certain animations. In SkyTemple, slots 0 - 63 can always be seen. These are the sprites used for existing floor items. Slot 63 is unnused in the base game, and appears in SkyTemple as a blank, transparent sprite.

=== Sprite Slots ===
It is possible to add custom item sprites without interfering with most existing ones. The valid, usable slots are ''italicized''. Documented by @lunaalex (on Discord):

* '''Slots 0 - 62''' are existing floor items
* '''''Slot 63''' can be given a new item sprite '''(1)'''''
* '''Slots 64 - 81''' will always be replaced by the game at runtime with status animation sprites
* '''''Slots 82 - 95''' can be given new item sprites '''(14)'''''
* Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row. Creating entries for these slots in SkyTemple (even if adding the correct sprites) ''will force the sprites to use Palette 0.'' This can affect entries that may have had different a palette originally assigned to them. For example, the ally shadows will no longer be shaded yellow, turning magenta instead. These entries include:
** 96: small enemy shadow (black)
** 97: big enemy shadow (black)
** 98: small ally shadow (yellow)
** 99: big ally shadow (yellow)
** 100: big ally shadow (yellow)
** 101: small arrow?
** 102: small arrow?
** 103: beta "for HP" text
* '''''Slots 104 - 107''' can be given new item sprites '''(4)'''''
* '''Slots 108 - 110''' will always be replaced by the game at runtime with water shadow animation sprites
* '''''Slots 111 - 119''' can be given new item sprites '''(9)'''''

Any new entry after that slot (120+) will roll over into the next set of tiles, which will overwrite attack animation sprites. In total, there are '''28 slots''' available for custom item sprites.{{NavSkyTemple}}

How to add custom Items

2025-04-10T03:57:17Z

Deltaflare: creating tutorial page for items

Adding custom items can be broken down into two parts: setting item properties and adding a sprite (if needed).

== Item Settings ==
The following will walk you through how to customize the properties and behavior of your item.

=== Text ===
To begin, find a “dummy item” in the ''Items'' section of SkyTemple that has a name <code>[M:D1]$$$</code>. Double-clicking opens the item’s settings, defaulting to the '''Text''' tab. From there you can enter a name, descriptions, category, buy price, and sell price. For more detailed descriptions of these options, see [[Item Data]]. There are also options to set a Sprite ID and Palette ID. Cycling through these changes the item sprite, and the colors used when displaying it.
[[File:Image tutorial 1 item text.png|alt=Screenshot of SkyTemple showing Item ID settings and dummy text|center|thumb|Example of default dummy text]]

=== General ===
Switch to the '''General''' tab. These settings generally affect how this Item behaves in menus, including the Move ID field. ''Unless making a TM/HM, this should stay set to '''0'''.'' For more examples and detailed descriptions of these options, see [[Item Data#General|Item Data - General]].
[[File:Item tutorial 2 general.png|alt=Screenshot of SkyTemple with default General settings|center|thumb|Example of general settings for a non-stackable food item]]

=== Flags ===
This tab has flags used to determine AI behavior in-game it looks like this . Depending on which ID you choose to edit, the ''"Is Valid"'' or ''"Is in T/D''" switches could be flipped or not. Either way, all switches will be shown like this:
[[File:Item tutorial 3 flags.png|alt=Screenshot of SkyTemple's list of item flags, with all of them disabled/turned off|center|thumb|Example with all flags disabled (default dummy configuration)]]
The most important one to note is “'''Is Valid.'''” ''This should always be on if you want to use the item!'' Otherwise it cannot be added to the dungeon spawn menus, and will show up as a nonfunctional Plain Seed if manually added to the Treasure Bag.

For more detailed descriptions of these options, see [[Item Data#Flags|Item Data - Flags]].

Toggle these to fit your desired behavior. Once satisfied with these settings, save before continuing.

=== Item Effects Code (Behavior in Dungeons) ===
The ''effects code'' controls what the item does when used in a dungeon. The table containing these can be found in ''Patches > ASM > Item Effects''. Viewing this requires the [[ExtractItemCode]] patch.
[[File:Item tutorial 4 item effects nav.png|alt=Navigation/nested menu for Item Effects entry|center]]
The items are sorted ''alphabetically''. If you do not see your new item in the list, you may need to reload the ROM first. This table on the (default) '''Item''' '''Effects''' tab is where you can edit the Effect ID. By default, dummy items have an Effect ID of ''86''. Double-click on the number next to your item to enter a new one.

Switching to the '''Effects Code''' tab has a dropdown menu where you can better see which effect is associated with what item.
[[File:Item tutorial 5 effect dropdown.png|alt=Screenshot showing 2 items sharing an Effect ID|center|thumb|Example of 2 items sharing an Effect ID]]

==== Adding Custom Effects ====
If you want to add any custom effects that don’t exist in the base game, that requires ASM code. You can add a new Effect ID by clicking the plus (+) button next to the Effect ID menu, which creates a new entry in the dropdown menu. Selecting it shows the “Used By” table is empty because no item is assigned to it when first created. Import the ASM file; once successful, switch back to the '''Item''' '''Effects''' tab to assign the new Effect ID to an item.

== Item Sprites ==
The following will walk you through how to create an import an image that fits EoS's dungeon sprite restrictions.

=== Preparing an Image ===
Item sprites in EoS must be 16 x 16 pixels, set as indexed PNGs using a specific set of colors. The image below is an ''example'' of the full colormap used by all floor item sprites (don't download it from this page, it's been compressed).
[[File:Item tutorial 6 colormap ex.png|alt=Screenshot of dungeon colormap|center]]
Each of the rows makes up ''one'' individual palette, 15 in total (numbered 0-14). When creating sprites, you must pick a row to use and stick with it—using colors from multiple rows will cause SkyTemple to reject the import with an error. This is where the Palette ID number from the ''Items Settings'' comes in. It determines which row (and its corresponding colors) will be used. Switching to a different Palette ID (ex: from 2 to 3, or row 3 to row 4) will still reference the same positions, but with the color mappings of the new row. ''This includes the transparency color (blue) and outline color (black).''
[[File:Image tutorial 7 pal ex.png|alt=Example of indexes carrying over between palettes, arrows drawn between Palette 2 and 3|center|thumb|Palette 2 -> Palette 3]]
A more in-depth example of this is shown below as we extract the colormap for our use.

It is recommended to start sprinting with the full colormap imported into your sprite editor, so that there are no issues with the indexes later. The easiest way to get the colormap is to export an existing sprite. As an example, exporting the Stick with the Palette ID set to '''1''' shows this message:

(Note: all ST screenshots are cropped to save space)
[[File:Item tutorial 8 exporting stick.png|alt=Screenshot of Stick sprite with the Palette ID set to 1|center|350x350px]]
[[File:Item tutorial 9 export dialog.png|alt=Screenshot of export dialog ("This exports currently selected image with the currently selected palette. image will contain all palettes")|center]]
This means that the sprite of the Stick will ''look'' brown, but still have the full colormap in its data. Opening the PNG in a sprite editor shows which colors will be used in each variation of the palette. Using an eyedrop tool or color selection mechanic can highlight the index of the brown being used (index 25). Finding the other shades of brown from there gives a point of reference for each row.
[[File:Item tutorial 10 stick index example.png|alt=Screenshot of Stick PNG open in sprite editor, showing which colors share the same columns|center|thumb|408x408px|These colors (23-25) share the same positions within every palette]]
This is useful if you make a sprite that you want ''multiple variants'' of (Stick, Iron Thorn, Apple, Golden Apple, etc.).

From there, you can save the colormap in your sprite editor to load as needed and create your sprite with your chosen colors. Note that you ''can'' make/import a custom palette, but that may affect existing sprites, and is out of scope of this tutorial at the moment.

Here is an example of a Cheri Berry sprite, not intended to have variants. You can see the sprite only uses colors from Palette 3 (row 4 of the colormap).
[[File:Item tutorial 11 full row use example.png|alt=Screenshot of a cheri berri (red and green), Example of using almost all colors in a palette|center|thumb|Example of using almost all colors in a palette (sprite credit: deltaflare)]]

=== Importing an Image into Slot 63 ===
Each item sprite in the game takes up one “slot” that is reserved for use in dungeons. To see which slots are valid to use, see the list in [[Item/Trap Graphics]]. Slots 0 – 62 are used for existing items, with slot 63 being unused in the base game. Given this, it looks like a blank blue square in SkyTemple, free to be used.
[[File:Item tutorial 12 slot 63 default.png|alt=Screenshot of slot 63 (blank unused sprite)|center|300x300px]]
Before clicking “Import,” make sure to set the Palette ID to the number you want to use for the ''new'' item. This helps the sprite look “as intended” to check that everything looks correct. Make sure to have the “import palettes” option turned '''off''', and the “insert as NEW image” option turned '''off''' (because this is replacing a currently blank sprite with your image).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]
Remember that a single sprite can have multiple color variations (Berries, Sticks, etc.), so there is no need for duplicates if you have the desired color indexes matching between rows. If you are only importing ''one'' sprite, feel free to skip to [[How to add custom Items#Setting the Sprite|Setting the Sprite]]. If you plan to import more sprites, ''read the “'''Importing Past Slot 63'''” section below''.

==== Possible Errors (& Fixes) ====
Here are some examples of errors that could happen, with the tile details removed to help explain the cause.

'''“Expected colors are from Palette 0” when using a non-0 palette'''
[[File:Item tutorial 14 error 1.png|alt=Screenshot of error that could happen when importing into Slot 63 specifically|center|400x400px]]
Even with the Palette ID number set in the UI, '''the tool first looks at the index number of the ''transparent'' color to start checking the rest.''' This means if you mistakenly used the transparent color from Palette 0 when making your sprite, the editor ''now expects everything to come from'' ''Palette 0''. “Color 49” is the black outline color in ''Palette 3''. Because “color 49” is not an expected color, the editor rejects the image.

'''“Expected colors are from Palette x”'''
[[File:Item tutorial 15 error 2.png|alt=Error for uploading to slot 63|center|400x400px]]
Even with the transparency and outline colors corrected, you may still get an “expected colors” error, despite them matching the palette at a glance. Note that Palettes 1 and 3 share a set of greens (index 27, and index 59). Using the “incorrect green” causes the error (especially if indexing a previously-RGB-mode sprite; the drawing program could attempt to auto-assign incorrect indexes). This is why it's recommended to work directly with the colormap.

To fix any of these errors, correct the offending colors in your PNG and import again.

=== Importing Past Slot 63 ===
As noted in <nowiki>[[Item/Trap Graphics]]</nowiki>, '''slots 64 - 81''' will always be replaced by the game with status sprites. This means whatever you import into these slots is ''not permanent,'' and the next valid slot is '''82'''.

By default, SkyTemple only shows entries for the existing slots. In order to reach slot, you need to import “blank” sprites. Create a PNG that uses the dungeon item colormap, filled with Palette 0’s blue transparency color. When importing, make sure to have “insert a new entry” option turned '''on''', so slot 63 isn’t replaced.
[[File:Item tutorial 16 import settings past 63.png|alt=Screenshot of import settings to add a new entry|center|300x300px]]
[[File:Item tutorial 17 slot 64.png|alt=Example of what slot 64 should look like (blank blue image)|center|300x300px]]
Now a new entry exists at '''slot 64'''! Continue doing this until you reach '''slot 81'''. Once you have imported a blank sprite into slot 81, you can import a proper sprite with the “insert a new entry” option turned '''on'''. This will create a permanent sprite in '''slot 82'''.

You can freely continue this process with '''slots 83 – 95''', as needed.

==== Possible Error (& Fix) ====
[[File:Item tutorial uncaught error ex.png|alt=Screenshot of uncaught error that happens when importing with incorrect colors|center|thumb|400x400px|Uncaught error that happens when importing with incorrect colors]]
If you have any “expected color” issues, SkyTemple first will give an error showing the incorrect index, then throw an uncaught TypeError exception. This is slightly different from the error with slot 63 because SkyTemple first creates an entry then cannot process the color data, so the entry becomes invalid while the editor still tries to display it. ''Don’t panic! You can correct this without having to reload/close without saving!'' Correct the color errors and import as ''replacing'' ''current entry'' (i.e.: replacing the invalid entry with colors that the editor can properly validate).
[[File:Image tutorial 13 import settings off.png|alt=Screenshot of import settings needed to replace an existing sprite entry|center|300x300px]]

==== Current Limitations - Important ====
{{Main|Item/Trap Graphics}}
Edits to '''slots 96 - 103''' will ''permanently overwrite'' the sprites present in that row (this includes things like Pokémon shadows).

=== Setting the Sprite ===
Now that the sprite has been imported, you can set it to be associated with your new item!

Go back to the ''Items > [item name]'' , and set the Sprite ID to '''63''' (or whatever index you inserted it at). Increment the Palette ID, and you will see the sprite change colors depending on the ones you used (remember the IDs start at 0).

File:Item tutorial uncaught error ex.png

2025-04-10T03:48:23Z

Deltaflare:

Screenshot of uncaught error that happens when importing with incorrect colors

File:Item tutorial 17 slot 64.png

2025-04-10T03:46:44Z

Deltaflare:

Example of what slot 64 should look like (blank blue image)

File:Item tutorial 16 import settings past 63.png

2025-04-10T03:45:19Z

Deltaflare:

Screenshot of settings to import a new entry

File:Item tutorial 15 error 2.png

2025-04-10T03:40:46Z

Deltaflare:

Error for uploading to slot 63

File:Item tutorial 14 error 1.png

2025-04-10T03:37:57Z

Deltaflare:

Screenshot of error that could happen when importing into Slot 63 specifically

File:Image tutorial 13 import settings off.png

2025-04-10T03:32:23Z

Deltaflare:

Screenshot of import settings needed to replace an existing sprite entry

File:Item tutorial 12 slot 63 default.png

2025-04-10T03:29:48Z

Deltaflare:

Screenshot of slot 63 (blank unused sprite)

File:Item tutorial 11 full row use example.png

2025-04-10T03:24:05Z

Deltaflare:

sprite credit: deltaflare, referenced from RSE Cheri Berri sprite

File:Item tutorial 10 stick index example.png

2025-04-10T03:17:53Z

Deltaflare:

Screenshot of Stick PNG open in sprite editor, showing which colors share the same columns

File:Item tutorial 9 export dialog.png

2025-04-10T03:12:38Z

Deltaflare:

Screenshot of export dialog ("This exports currently selected image with the currently selected palette. image will contain all palettes")

File:Item tutorial 8 exporting stick.png

2025-04-10T03:10:59Z

Deltaflare:

Screenshot of Stick sprite with the Palette ID set to 1

File:Image tutorial 7 pal ex.png

2025-04-10T03:06:38Z

Deltaflare:

Example of indexes carrying over between palettes

File:Item tutorial 6 colormap ex.png

2025-04-10T02:57:19Z

Deltaflare:

Screenshot of dungeon colormap

File:Item tutorial 5 effect dropdown.png

2025-04-10T02:47:43Z

Deltaflare:

Screenshot showing 2 items sharing an Effect ID

File:Item tutorial 4 item effects nav.png

2025-04-10T02:44:57Z

Deltaflare:

Navigation/nested menu for Item Effects entry

File:Item tutorial 3 flags.png

2025-04-10T02:40:05Z

Deltaflare:

Screenshot of SkyTemple's list of item flags

File:Item tutorial 2 general.png

2025-04-10T02:36:59Z

Deltaflare:

Screenshot of SkyTemple with default General settings

File:Image tutorial 1 item text.png

2025-04-10T02:28:36Z

Deltaflare:

screenshot of ST showing Item Text settings

Item Data

2025-04-09T20:07:49Z

Deltaflare: /* General */ adding example images

The ''Items'' section shows all items available in-game. SkyTemple offers the following sections for editing item properties.

== Category and IDs ==

* '''Sprite ID''': sprite used when displaying this object in a dungeon
* '''Palette ID''': set of colors used when displaying this object in a dungeon
* '''Item ID''': self-explanatory
* '''Category''': these are used when setting the item spawn settings on a dungeon floor
* '''Buy Price''': Poké price at Kecleon Market
* '''Sell Price''': Poké price at Kecleon Market

=== Categories Available ===

* Thrown – Pierce (item moves in a straight line)
* Thrown – Rock (item flies in an arc)
* Berries, Seeds, Vitamins
* Food, Gummies
* Hold (held items only)
* TMs, HMs
* Poké (Money)
* Unknown 7
* Other
* Orbs
* Link Boxes
* Used TM
* Treasure Box 1
* Treasure Box 2
* Treasure Box 3
* Exclusive Items

== Text ==

* '''Name''': self-explanatory
* '''Short description''': used when hovering over the item in the Treasure Box
* '''Long description''': used when viewing Info

== General ==

* '''Move ID''': The ID of a move that is associated with this item. ''Unless making a TM/HM, this should stay '''0'''.'' Example of TM Focus Punch vs. Stick (a stackable item):
<gallery mode="packed" widths="420" heights="150">
File:ST TM Example.png|alt=SkyTemple UI showing the General settings for the Focus Punch TM. This highlights that the Move ID field is set to 75, corresponding to the move Focus Punch.|Move ID is set to 75 (the ID for Focus Punch)
File:ST Stick Example Settings.png|alt=SkyTemple UI showing the General settings for the Stick item. This highlights that the Move ID field is set to 0 (no move is associated with it), and that it has stackable settings.|Move ID is set to 0
</gallery>
* '''Min Amount (for stackable items)''': indicates the minimum amount you can get for 1 instance of that item.
* '''Max Amount (for stackable items)''': indicates the maximum amount you can get for 1 instance of that item.
* '''Action Name''': String displayed in dungeon menus. These can be changed in “Text Strings.”

=== Default Action Item Values ===

* 0: Use
* 1: Hurl
* 2: Throw
* 3: Equip
* 4: Eat
* 5: Ingest
* 6: Peel
* 7: Use
* 8: Use
* 9: Use
* 10: Use
* 11 Equip
* 12: Equip
* 13: Use
* 14: Use
* 15: Use

== Flags ==

* '''Is Valid''': ''This should always be on if you want to use the item!'' Otherwise it cannot be added to the dungeon spawn menus, and will show up as a nonfunctional Plain Seed if manually added to the Treasure Bag.
* '''Is T/D''': Is this item originally present in Time or Darkness versions?
* '''AI Flag: Throw at enemies''': Do you want allies to throw this item at enemies? (ex: Gravelerocks or Sticks)
* '''AI Flag: Throw at allies''': Do you want allies to throw this item at you or other allies? (ex: healing items)
* '''AI Flag: Use on self''': Do you want allies to use this item on themselves? (ex: healing items)

{{NavSkyTemple}}

File:ST TM Example.png

2025-04-09T19:46:23Z

Deltaflare: Deltaflare uploaded a new version of File:ST TM Example.png

Example of settings used in a HM/TM item, specifically the Move ID field