select.h

Go to the documentation of this file.

#ifndef ALCHEMY_SELECT_H
#define ALCHEMY_SELECT_H
 
/// @file
/// The selection screen's sprites and nodes.
 
#include "types.h"
#include "static_assert.h"
#include "window.h"
#include "affine.h"
 
/// A selection screen sprite: a list link and its OAM attributes.
struct SelectionSprite {
  struct SelectionSprite *next;
  u8 y;
  u8 affine : 2;
  u8 mode : 2;
  u8 mosaic : 1;
  u8 colors : 1;
  u8 shape : 2;
  u16 x : 9;
  u16 param : 5;
  u16 size : 2;
  u16 tile : 10;
  u16 priority : 2;
  u16 palette : 4;
};
 
/// An icon of the selection screen: its list links, the entry it shows, its
/// place and its slide toward a target, its zoom and its sprite.
struct SelectionNode {
  struct SelectionNode *prev; ///< the icon before it in its row
  struct SelectionNode *next; ///< the icon after it in its row
  u16 base;    ///< the entry's id, as listed in SelectionScreen.bases
  u16 kind;    ///< the entry's kind, as listed in SelectionScreen.kinds; 0 free
  u16 slot;    ///< VRAM cache slot of its picture
  u16 tile;    ///< first sprite tile of its picture
  s16 x;       ///< screen pixels
  s16 y;       ///< screen pixels
  s16 dx;      ///< pixels a frame
  s16 dy;      ///< pixels a frame
  s16 targetX; ///< screen pixels
  s16 targetY; ///< screen pixels
  s16 homeX;   ///< screen pixels, where it stood when chosen
  s16 homeY;   ///< screen pixels, where it stood when chosen
  u16 message; ///< its name, shown in the screen's window
  s16 scale;   ///< 8.8 fixed point, 0x100 full size
  s16 scaleStep; ///< 8.8 fixed point a frame
  s16 scaleEnd;  ///< 8.8 fixed point, 0x100 full size
  struct SelectionSprite sprite;
};
 
/// The selection screen (heap block 18): the row of icons the player picks
/// from, with arrows at each end and a pointing hand over the chosen target.
struct SelectionScreen {
  /// The icons; 14 is the pointing hand, whose picture is loaded at setup.
  struct SelectionNode records[16];
  struct AffineTransform transform; ///< a zooming icon's scale
  struct SelectionNode *head;       ///< the first icon of the row
  struct SelectionNode *path;       ///< the icons chosen so far
  struct UiWindow *window;          ///< the window naming the chosen entry
  /// The listed entries, up to 16 (Resource_PushPendingPair).
  ///@{
  u16 kinds[16];
  u16 bases[16];
  u16 count;
  ///@}
  u16 baseX;  ///< screen pixels
  u16 baseY;  ///< screen pixels
  u16 unk39a; ///< cleared with the list; not read by name in TBS
  u16 top;    ///< the first listed entry shown
  /// The entry under the hand, from top; bit 7 asks the next list to start
  /// again from its first entry.
  u16 cursorIndex;
  u16 verticalScroll; ///< pixels added to the icons' y; 32 at setup
  u16 status;     ///< 1 shown, 33 while scrolling; counts up each frame drawn
  u16 pathTop[5]; ///< top, kept for each icon chosen on the path
  u16 pathCursor[5]; ///< cursorIndex, kept for each icon chosen on the path
  /// 999 from setup on. While 0, kind 6 icons sit at the top of the screen and
  /// the window opens there; no TBS code clears it by name.
  u16 locked;
  u8 unk3ba[42]; ///< not named by TBS code
};
 
STATIC_ASSERT(sizeof(struct SelectionSprite) == 0x0c);
STATIC_ASSERT(sizeof(struct SelectionNode) == 0x34);
STATIC_ASSERT(offsetof(struct SelectionNode, message) == 0x20);
STATIC_ASSERT(offsetof(struct SelectionNode, sprite) == 0x28);
STATIC_ASSERT(offsetof(struct SelectionScreen, head) == 0x348);
STATIC_ASSERT(offsetof(struct SelectionScreen, kinds) == 0x354);
STATIC_ASSERT(offsetof(struct SelectionScreen, cursorIndex) == 0x39e);
STATIC_ASSERT(offsetof(struct SelectionScreen, locked) == 0x3b8);
STATIC_ASSERT(sizeof(struct SelectionScreen) == 0x3e4);
 
#endif