papermario/include/common_structs.h

#ifndef _COMMON_STRUCTS_H_
#define _COMMON_STRUCTS_H_

#include "ultra64.h"
#include "types.h"

typedef struct {
    /* 0x000 */ s16 unk_00;
    /* 0x002 */ s16 unk_02;
    /* 0x004 */ char unk_04[0x44];
    /* 0x048 */ u16 unk_48[4];
    /* 0x050 */ u16 unk_50[4];
    /* 0x058 */ char unk_58[0x10];
    /* 0x068 */ u16 demoButtonInput;
    /* 0x06A */ s8 demoStickX;
    /* 0x06B */ s8 demoStickY;
    /* 0x06C */ char unk_6C[0x4];
    /* 0x070 */ s8 unk_70;
    /* 0x071 */ s8 demoState;
    /* 0x072 */ s8 unk_72;
    /* 0x073 */ char unk_73[2];
    /* 0x075 */ s8 unk_75;
    /* 0x076 */ char unk_76[3];
    /* 0x079 */ s8 unk_79;
    /* 0x07A */ s8 musicEnabled;
    /* 0x07B */ char unk_7B;
    /* 0x07C */ s8 unk_7C;
    /* 0x07D */ char unk_7D;
    /* 0x07E */ s8 unk_7E;
    /* 0x07F */ char unk_7F[2];
    /* 0x081 */ s8 unk_81;
    /* 0x082 */ s8 unk_82;
    /* 0x083 */ s8 unk_83;
    /* 0x084 */ char unk_84[2];
    /* 0x086 */ s16 unk_86;
    /* 0x088 */ s16 unk_88;
    /* 0x08A */ s16 unk_8A;
    /* 0x08C */ s16 mapID;
    /* 0x08E */ char unk_8E[0x1A];
    /* 0x0A8 */ s8 unk_A8;
    /* 0x0A9 */ char unk_A9;
    /* 0x0AA */ s8 unk_AA;
    /* 0x0AB */ char unk_AB[1];
    /* 0x0AC */ s8 unk_AC;
    /* 0x0AD */ char unk_AD[0x09];
    /* 0x0B6 */ s16 boot_alpha;
    /* 0x0B8 */ s16 boot_blue;
    /* 0x0BA */ s16 boot_green;
    /* 0x0BC */ s16 boot_red;
    /* 0x0BE */ char unk_BE[0x76];
    /* 0x134 */ u16 unk_134;
    /* 0x136 */ char unk_136[0x6];
    /* 0x13C */ s16 unk_13C;
    /* 0x13E */ char unk_13E[0xA];
    /* 0x148 */ s16 unk_148;
    /* 0x14A */ s16 unk_14A;
    /* 0x14C */ s16 unk_14C;
    /* 0x14E */ s16 unk_14E;
    /* 0x150 */ s16 unk_150;
    /* 0x152 */ char unk_152[2];
    /* 0x154 */ s32 unk_154;
    /* 0x158 */ s32 unk_158;
    /* 0x15C */ s16 unk_15C;
    /* 0x15E */ char unk_15E[0xA];
    /* 0x168 */ s32 unk_168;
} game_status;

typedef enum eItemEntityState {
    CollisionWithPlayer=3,
    FellBelowWorld=2,
    Init=0,
    Initialized=1
} eItemEntityState;

typedef struct {
    /* 0x00 */ f32 verticalVelocity;
    /* 0x04 */ f32 gravity; /* 2 = normal, 1 = low gravity, higher values never 'settle' */
    /* 0x08 */ f32 unk_8;
    /* 0x0C */ f32 constVelocity; /* ? */
    /* 0x10 */ f32 velx;
    /* 0x14 */ f32 velz;
    /* 0x18 */ f32 moveAngle;
    /* 0x1C */ f32 unk_1C;
    /* 0x20 */ f32 unk_20;
} item_entity_physics_data;

typedef struct {
    /* 0x00 */ s32 flags;
    /* 0x04 */ s16 boundVar; /* see make_item_entity */
    /* 0x06 */ s16 unk_6;
    /* 0x08 */ f32 position[3];
    /* 0x14 */ struct item_entity_physics_data* physicsData;
    /* 0x24 */ s16 itemID; /* into item table, also worldIconID */
    /* 0x1A */ eItemEntityState state;
    /* 0x1B */ s8 type;
    /* 0x1C */ s8 pickupDelay; /* num frames before item can be picked up */
    /* 0x1D */ s8 unk_1D;
    /* 0x1E */ s16 wsFaceAngle; /* < 0 means none */
    /* 0x20 */ s16 shadowIndex;
    /* 0x22 */ char unk_22[2];
    /* 0x24 */ u32* readPos;
    /* 0x28 */ u32 savedReadPos;
    /* 0x2C */ s8 unk_2C;
    /* 0x2D */ s8 unk_2D;
    /* 0x2E */ s8 unkCounter;
    /* 0x2F */ s8 unk_2F;
    /* 0x30 */ f32 scale;
    /* 0x34 */ s16 unk_34;
    /* 0x36 */ s16 unk_36;
    /* 0x38 */ s16 unk_38;
    /* 0x3A */ char unk_3A[2];
    /* 0x3C */ s32 unk_3C; /* coin related? timer? state? */
    /* 0x40 */ s32 unk_40; /* coin sound related? */
    /* 0x44 */ char unk_44[4];
    /* 0x48 */ s32 unk_48; /* coin sound related? */
    /* 0x4C */ s32 unk_4C;
    /* 0x50 */ s32 unk_50;
    /* 0x54 */ char unk_54[2];
    /* 0x56 */ s16 unk_56;
    /* 0x58 */ char unk_58[2];
    /* 0x5A */ s16 unk_5A;
} item_entity;

typedef struct {
    /* 0x00 */ s32 nameString;
    /* 0x04 */ s16 iconID;
    /* 0x06 */ s16 badgeSortPriority;
    /* 0x08 */ s32 targetFlags;
    /* 0x0C */ s16 sellValue;
    /* 0x10 */ s32 menuString;
    /* 0x14 */ s32 itemString;
    /* 0x18 */ s16 typeFlags;
    /* 0x1A */ s8 moveID;
    /* 0x1B */ s8 potencyA;
    /* 0x1C */ s8 potencyB;
    /* 0x1D */ char unk_1D[3];
} item_table_entry;

typedef struct {
    /* 0x0 */ s8 enabled;
    /* 0x1 */ s8 level;
    /* 0x2 */ s16 unk_2;
    /* 0x4 */ s16 unk_4;
    /* 0x6 */ s16 unk_6;
} partner_data; // size = 0x8

typedef struct {
    /* 0x000 */ s8 bootsLevel;
    /* 0x001 */ s8 hammerLevel;
    /* 0x002 */ s8 curHP;
    /* 0x003 */ s8 curMaxHP;
    /* 0x004 */ s8 hardMaxHP;
    /* 0x005 */ s8 curFP;
    /* 0x006 */ s8 curMaxFP;
    /* 0x007 */ s8 hardMaxFP;
    /* 0x008 */ s8 maxBP;
    /* 0x009 */ s8 level;
    /* 0x00A */ s8 hasActionCommands;
    /* 0x00B */ char unk_0B;
    /* 0x00C */ s16 coins;
    /* 0x00E */ s8 fortressKeyCount;
    /* 0x00F */ u8 starPieces;
    /* 0x010 */ s8 starPoints;
    /* 0x011 */ char unk_11;
    /* 0x012 */ s8 currentPartner;
    /* 0x013 */ char unk_13;
    /* 0x014 */ partner_data partners[12];
    /* 0x074 */ s16 keyItems[32];
    /* 0x0B4 */ s16 badges[128];
    /* 0x1B4 */ s16 invItems[10];
    /* 0x1C8 */ s16 storedItems[32];
    /* 0x208 */ s16 equippedBadges[64];
    /* 0x288 */ s8 unk_288;
    /* 0x289 */ s8 merleeSpellType;
    /* 0x28A */ s8 merleeCastsLeft;
    /* 0x28B */ char unk_28B;
    /* 0x28C */ s16 merleeTurnCount;
    /* 0x28E */ s8 maxStarPower;
    /* 0x28F */ char unk_28F;
    /* 0x290 */ s16 specialBarsFilled;
    /* 0x292 */ s8 unk_292;
    /* 0x293 */ char unk_293;
    /* 0x294 */ s16 otherHitsTaken;
    /* 0x296 */ s16 unk_296;
    /* 0x298 */ s16 hitsTaken;
    /* 0x29A */ s16 hitsBlocked;
    /* 0x29C */ s16 playerFirstStrikes;
    /* 0x29E */ s16 enemyFirstStrikes;
    /* 0x2A0 */ s16 powerBounces;
    /* 0x2A2 */ s16 battlesCount;
    /* 0x2A4 */ s16 unk_2A4;
    /* 0x2A6 */ s16 unk_2A6;
    /* 0x2A8 */ s16 unk_2A8;
    /* 0x2AA */ s16 unk_2AA;
    /* 0x2AC */ s32 unk_2AC;
    /* 0x2B0 */ s32 unk_2B0;
    /* 0x2B4 */ u32 totalCoinsEarned;
    /* 0x2B8 */ s16 idleFrameCounter; /* frames with no inputs, overflows ever ~36 minutes of idling */
    /* 0x2BA */ char unk_2BA[0x2];
    /* 0x2BC */ s32 frameCounter; /* increases by 2 per frame */
    /* 0x2C0 */ s16 quizzesAnswered;
    /* 0x2C2 */ s16 quizzesCorrect;
    /* 0x2C4 */ s32 unk_2C4[12];
    /* 0x2F4 */ s32 unk_2F4[12];
    /* 0x2F8 */ char unk_324[4];
    /* 0x328 */ s32 unk_328;
    /* 0x32C */ s16 starPiecesCollected;
    /* 0x32E */ s16 jumpGamePlays;
    /* 0x330 */ s32 jumpGameTotal;
    /* 0x334 */ s16 jumpGameRecord;
    /* 0x336 */ s16 smashGamePlays;
    /* 0x338 */ s32 smashGameTotal;
    /* 0x33C */ s16 smashGameRecord;
    /* 0x33E */ char unk_33E[0x2];
} player_data; // size = 0x340

typedef enum eActionState {
    actionBounce=4,
    actionConversation=12,
    actionEnemyFirstStrike=27,
    actionFalling=8,
    actionGroundPound=14,
    actionHammer=18,
    actionIdle=0,
    actionJump=3,
    actionLand=10,
    actionLaunch=6,
    actionRide=33,
    actionRun=2,
    actionSpin=26,
    actionSpinJump=13,
    actionSpinningFlower=29,
    actionStepDown=9,
    actionStepUp=34,
    actionUltraJump=15,
    actionUltraPound=16,
    actionUseSpring=38,
    actionWalk=1
} eActionState;

typedef enum eFallState {
    Falling=1,
    Rising=0
} eFallState;

typedef struct {
    /* 0x000 */ s32 flags;
    /* 0x004 */ u32 animFlags;
    /* 0x008 */ s16 framesOnGround; /* Number of frames since last jump landed */
    /* 0x00A */ char unk_0A[2];
    /* 0x00C */ s8 peachDisguise;
    /* 0x00D */ char unk_0D[3];
    /* 0x010 */ s16 unk_10;
    /* 0x012 */ s16 moveFrames;
    /* 0x014 */ s8 enableCollisionOverlapsCheck;
    /* 0x015 */ s8 statusMenuCounter; /* whether the C-up menu can appear */
    /* 0x016 */ s16 lastGoodPosition[3]; // TODO: Vec3s?
    /* 0x01C */ f32 extraVelocity[3]; // TODO: Vec3f?
    /* 0x028 */ f32 position[3]; //TODO: Vec3f?
    /* 0x034 */ f32 unk_34;
    /* 0x038 */ f32 unk_38;
    /* 0x03C */ char unk_3C[8];
    /* 0x044 */ f32 decorationPos[2];
    /* 0x04C */ char unk_4C[4];
    /* 0x050 */ f32 jumpApexHeight;
    /* 0x054 */ s32 currentSpeed;
    /* 0x058 */ f32 walkSpeed;
    /* 0x05C */ f32 runSpeed;
    /* 0x060 */ char unk_60[4];
    /* 0x064 */ s32 unk_64;
    /* 0x068 */ f32 normalPitch;
    /* 0x06C */ f32 unk_6C;
    /* 0x070 */ f32 gravityIntegrator[4];
    /* 0x080 */ f32 targetYaw;
    /* 0x084 */ f32 currentYaw;
    /* 0x088 */ s32 unk_88;
    /* 0x08C */ char unk_8C[4];
    /* 0x090 */ s32 unk_90;
    /* 0x094 */ s32 unk_94;
    /* 0x098 */ s32 unk_98;
    /* 0x09C */ s32 unk_9C;
    /* 0x0A0 */ f32 heading;
    /* 0x0A4 */ char unk_A4[4];
    /* 0x0A8 */ f32 spriteFacingAngle; /* angle of sprite, relative to camera, from 0 to 180 */
    /* 0x0AC */ char unk_AC[4];
    /* 0x0B0 */ s16 colliderHeight;
    /* 0x0B2 */ s16 colliderDiameter;
    /* 0x0B4 */ eActionState actionState;
    /* 0x0B5 */ eActionState prevActionState;
    /* 0x0B6 */ eFallState fallState;
    /* 0x0B7 */ char unk_B7;
    /* 0x0B8 */ s32 anim;
    /* 0x0BC */ char unk_BC[2];
    /* 0x0BE */ s8 renderMode;
    /* 0x0BF */ s8 unk_BF;
    /* 0x0C0 */ u32* decorationList;
    /* 0x0C4 */ char unk_C4;
    /* 0x0C5 */ s8 unk_C5;
    /* 0x0C6 */ char unk_C6[6];
    /* 0x0CC */ s32 shadowID;
    /* 0x0D0 */ char unk_D0[8];
    /* 0x0D8 */ s32 unk_D8;
    /* 0x0DC */ s32 currentButtons;
    /* 0x0E0 */ s32 pressedButtons;
    /* 0x0E4 */ s32 heldButtons;
    /* 0x0E8 */ f32 stickAxis[2];
    /* 0x0F0 */ s32 currentButtonsBuffer[10];
    /* 0x118 */ s32 pressedButtonsBuffer[10];
    /* 0x140 */ s32 heldButtonsBuffer[10];
    /* 0x168 */ f32 stickXBuffer[10];
    /* 0x190 */ f32 stickYBuffer[10];
    /* 0x1B8 */ s32 inputBufPos;
    /* 0x1BC */ char unk_1BC[0xCC];
} player_status; // size = 0x288

typedef struct {
    /* 0x00 */ s32 hpIconIndexes[2]; /* hpIconIndex, heartIconIndex */
    /* 0x08 */ s32 fpIconIndexes[2]; /* fpIconIndex, flowerIconIndex */
    /* 0x10 */ s32 coinIconIndex;
    /* 0x14 */ s32 coinIconIndex2;
    /* 0x18 */ s32 starpointsIconIndex;
    /* 0x1C */ s32 starpointsIconIndex2;
    /* 0x20 */ s32 iconIndex8;
    /* 0x24 */ s32 iconIndex9;
    /* 0x28 */ s32 iconIndexA;
    /* 0x2C */ s32 iconIndexB;
    /* 0x30 */ s32 iconIndexC;
    /* 0x34 */ s16 drawPosX; /* overall x-offset for whole UI */
    /* 0x36 */ s16 drawPosY; /* modulated as it appears, goes away */
    /* 0x38 */ s16 showTimer;
    /* 0x3A */ s8 hidden;
    /* 0x3B */ s8 unk_3B;
    /* 0x3C */ s8 unk_3C;
    /* 0x3D */ s8 displayHP;
    /* 0x3E */ s8 displayFP;
    /* 0x3F */ char unk_3F;
    /* 0x40 */ s16 displayCoins;
    /* 0x42 */ s16 displayStarpoints;
    /* 0x44 */ s8 ignoreChanges; /* set != 0 to prevent automatic opening from HP/FP changes */
    /* 0x45 */ s8 unk_45;
    /* 0x46 */ s8 unk_46;
    /* 0x47 */ s8 disabled; /* set != 0 for menu to be disabled completely */
    /* 0x48 */ s16 displaySP;
    /* 0x4A */ s8 hpBlinking;
    /* 0x4B */ s8 hpBlinkCounter;
    /* 0x4C */ s8 hpBlinkTimer;
    /* 0x4D */ s8 fpBlinking;
    /* 0x4E */ s8 fpBlinkCounter;
    /* 0x4F */ s8 fpBlinkTimer;
    /* 0x50 */ s8 spBlinking;
    /* 0x51 */ s8 spBlinkCounter;
    /* 0x52 */ s8 starpointsBlinking;
    /* 0x53 */ s8 starpointsBlinkCounter;
    /* 0x54 */ s8 coinsBlinking;
    /* 0x55 */ s8 coinsBlinkCounter;
    /* 0x56 */ s8 coinsBlinkTimer;
    /* 0x57 */ s8 unk_57;
    /* 0x58 */ s8 unk_58;
    /* 0x59 */ s8 unk_59;
    /* 0x5A */ s8 spBarsToBlink; /* how many sp bars to blink */
    /* 0x5B */ char unk_5B;
    /* 0x5C */ s32 iconIndex10;
    /* 0x60 */ s32 iconIndex11;
    /* 0x64 */ s32 iconIndex12;
    /* 0x68 */ s32 iconIndex13;
    /* 0x6C */ s8 unk_6C;
    /* 0x6D */ s8 unk_6D;
    /* 0x6E */ s8 unk_6E;
    /* 0x6F */ char unk_6F;
} ui_status; // size = 0x70

typedef struct {
    /* 0x00 */ char unk_00[0x4];
    /* 0x04 */ s16 height;
    /* 0x06 */ s16 radius;
    /* 0x08 */ void* otherAI; //?
    /* 0x0C */ s32* interactScript;
    /* 0x10 */ s32* aiScript;
    /* 0x14 */ s32* hitScript;
    /* 0x18 */ s32* auxScript;
    /* 0x1C */ s32* defeatScript;
    /* 0x20 */ s32 flags;
    /* 0x24 */ char unk_24[0x4];
    /* 0x28 */ s16 level;
    /* 0x2A */ s16 unkFlags;
} StaticNpcSettings; // size = 0x2C

typedef enum {
    triggerHammer=4,
    triggerJump=2,
    triggerNormal=1,
    triggerPartner=6,
    triggerSpin=3,
} eEncounterTrigger;

typedef struct {
    /* 0x00 */ s32 flags;
    /* 0x04 */ s8 encounterIndex;
    /* 0x05 */ s8 encountered; // eEncounterTrigger
    /* 0x06 */ s8 scriptGroup; /* scripts launched for this npc controller will be assigned this group */
    /* 0x07 */ s8 unk_07;
    /* 0x08 */ s16 npcID;
    /* 0x0A */ s16 spawnPos[3];
    /* 0x10 */ s16 unk_10[3];
    /* 0x16 */ char unk_16[0x2];
    /* 0x18 */ struct StaticNpcSettings* npcSettings;
    /* 0x1C */ s32* initBytecode;
    /* 0x20 */ s32* interactBytecode;
    /* 0x24 */ s32* aiBytecode;
    /* 0x28 */ s32* hitBytecode;
    /* 0x2C */ s32* auxBytecode;
    /* 0x30 */ s32* defeatBytecode;
    /* 0x34 */ struct script_context* initScript;
    /* 0x38 */ struct script_context* interactScript;
    /* 0x3C */ struct script_context* aiScript;
    /* 0x40 */ struct script_context* hitScript;
    /* 0x44 */ struct script_context* auxScript;
    /* 0x48 */ struct script_context* defeatScript;
    /* 0x4C */ s32 initScriptID;
    /* 0x50 */ s32 interactScriptID;
    /* 0x54 */ s32 aiScriptID;
    /* 0x58 */ s32 hitScriptID;
    /* 0x5C */ s32 auxScriptID;
    /* 0x60 */ s32 defeatScriptID;
    /* 0x64 */ void* unk_64;
    /* 0x68 */ char unk_68[0x4];
    /* 0x6C */ s32 varTable[16];
    /* 0xAC */ s8 unk_AC;
    /* 0xAD */ char unk_AD[0x3];
    /* 0xB0 */ s32* unk_B0; /* might be flags of some sort */
    /* 0xB4 */ s8 unk_B4;
    /* 0xB5 */ s8 unk_B5;
    /* 0xB6 */ char unk_B6[0x2];
    /* 0xB8 */ s32 unkSettings24;
    /* 0xBC */ s32 unk_BC;
    /* 0xC0 */ s32 unk_C0;
    /* 0xC4 */ s32 unk_C4;
    /* 0xC8 */ char unk_C8[0x4];
    /* 0xCC */ s32* animList;
    /* 0xD0 */ s32* territoryData;
    /* 0xD4 */ s32* dropTables;
    /* 0xD8 */ u32 tattleString;
    /* 0xDC */ s32 unk_DC;
    /* 0xE0 */ s16 unk_E0;
    /* 0xE2 */ char unk_E2[0xE];
} enemy; // size = 0xF0

typedef struct {
    /* 0x000 */ s8 state;
    /* 0x001 */ s8 currentArgc;
    /* 0x002 */ s8 currentOpcode;
    /* 0x003 */ s8 priority;
    /* 0x004 */ s8 groupFlags;
    /* 0x005 */ s8 blocked; /* 1 = blocking */
    /* 0x006 */ s8 loopDepth; /* how many nested loops we are in, >= 8 hangs forever */
    /* 0x007 */ s8 switchDepth; /* how many nested switches we are in, max = 8 */
    /* 0x008 */ s32* ptrNextLine;
    /* 0x00C */ s32* ptrReadPos;
    /* 0x010 */ s8 labelIndices[16];
    /* 0x020 */ s32* labelPositions[16];
    /* 0x060 */ s32 deleted; /* set to zero in KillScript when malloc'd */
    /* 0x064 */ struct script_context* blockingParent; /* parent? */
    /* 0x068 */ struct script_context* childScript;
    /* 0x06C */ struct script_context* parentScript; /* brother? */
    /* 0x070 */ s32 functionTemp[4];
    /* 0x080 */ void* callFunction;
    /* 0x084 */ u32 varTable[16];
    /* 0x0C4 */ s32 varFlags[3];
    /* 0x0D0 */ s32 loopStartTable[8];
    /* 0x0F0 */ s32 loopCounterTable[8];
    /* 0x110 */ s8 switchBlockState[8];
    /* 0x118 */ s32 switchBlockValue[8];
    /* 0x138 */ void* buffer;
    /* 0x13C */ void* array;
    /* 0x140 */ void* flagArray;
    /* 0x144 */ s32 uniqueID;
    /* 0x148 */ enemy* ownerActorID; /* controller*, battle ID, trigger* */
    /* 0x14C */ u32 ownerID; /* can be an npcID, a triggerID, a trigger ptr */
    /* 0x150 */ f32 timeScale;
    /* 0x154 */ f32 frameCounter;
    /* 0x158 */ s32 unk_158;
    /* 0x15C */ s32* ptrFirstLine;
    /* 0x160 */ s32* ptrSavedPosition;
    /* 0x164 */ s32* ptrCurrentLine;
} script_context; // size = 0x168;

typedef struct {
    /* 0x00 */ u32 palette;
    /* 0x04 */ u32 raster;
    /* 0x08 */ u16 startX;
    /* 0x0A */ u16 startY;
    /* 0x0C */ u16 width;
    /* 0x0E */ u16 height;
} bg_header; // size = 0x10

typedef struct {
    /* 0x00 */ s16 genericFlagIndex;
    /* 0x02 */ s16 field_0x2;
    /* 0x04 */ s16 crateFlagIndex;
    /* 0x06 */ s16 panelFlagIndex;
    /* 0x08 */ s32 colliderID;
    /* 0x0C */ UNK_FUN_PTR(functionHandler);
    /* 0x10 */ UNK_PTR scriptStart;
    /* 0x14 */ script_context* runningScript;
    /* 0x18 */ s32 priority;
    /* 0x1C */ s32 scriptVars[3];
    /* 0x28 */ s32 unk_28;
    /* 0x2C */ s32 unk_2C;
    /* 0x30 */ s8 unk_30;
    /* 0x31 */ char unk_31[3];
    /* 0x34 */ s32 runningScriptID;
} trigger; // size = 0x38

#endif