pmd-red/include/structs/dungeon_entity.h

#ifndef GUARD_DUNGEON_ENTITY_H
#define GUARD_DUNGEON_ENTITY_H

#include "constants/dungeon_action.h"
#include "constants/global.h"
#include "constants/status.h"
#include "structs/axdata.h"
#include "structs/str_items.h"
#include "structs/str_moves.h"
#include "structs/str_position.h"
#include "structs/str_dungeon_location.h"
#include "structs/str_iq_skill_flags.h"
#include "math.h"
#include "number_util.h"

#define MAX_STAT_STAGE 20
#define STAT_MULTIPLIER_THRESHOLD 0.249 // one tick less than 0.25
#define DEFAULT_STAT_STAGE 10
#define MAX_SPEED_STAGE 4
#define MAX_STOCKPILE_STAGE 3
#define NUM_SPEED_COUNTERS 5
#define NUM_PREV_POS 4

// size: 0x8
typedef struct ActionParameter
{
    /* 0x0 */ u8 actionUseIndex;
    /* 0x4 */ DungeonPos itemPos;
} ActionParameter;

// size: 0x18
typedef struct ActionContainer
{
    /* 0x0 */ u16 action;
    /* 0x2 */ u8 direction;
    u8 unk3;
    // Additional parameter alongside actionIndex. Used for things like indicating which move a Pokémon should use from its moveset.
    /* 0x4 */ ActionParameter actionParameters[2];
    // Position of the target that the Pokémon wants throw an item at.
    /* 0x14 */ DungeonPos itemTargetPosition;
} ActionContainer;

// size: R=0x4 | B=0x3
typedef struct HiddenPower
{
    /* 0x0 */ s16 hiddenPowerBasePower;
    /* 0x2 */ u8 hiddenPowerType;
} HiddenPower;

// size: 0x14
typedef struct AITarget
{
    /* 0x0 */ u8 aiObjective; // 0x78
    /* 0x1 */ bool8 aiNotNextToTarget; // 0x79
    /* 0x2 */ bool8 aiTargetingEnemy; // 0x7A
    /* 0x3 */ bool8 aiTurningAround; // 0x7B
    /* 0x4 */ u16 aiTargetSpawnGenID; // 0x7C
    /* 0x8 */ struct Entity *aiTarget; // 0x80
    /* 0xC */ u32 unkC; // 0x84
    /* 0x10 */ DungeonPos aiTargetPos; // 0x88
} AITarget;

// size: 0x4
typedef struct SleepClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
} SleepClassStatus;

// size: 0x4
typedef struct BurnClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
    /* 0x2 */ u8 damageCountdown;
    /* 0x3 */ u8 badlyPoisonedDamageCount;
} BurnClassStatus;

// Useful when checking if a mon is poisoned without having to check for Poison and Bad Poison every time.
#define ENTITY_POISONED(entityInfo)((entityInfo->burnClassStatus.status == STATUS_POISONED || entityInfo->burnClassStatus.status == STATUS_BADLY_POISONED))

// size: 0xC
typedef struct FrozenClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x4 */ s32 unk4;
    /* 0x8 */ u8 turns;
    /* 0x9 */ u8 damageCountdown;
} FrozenClassStatus;

// size: 0x4
typedef struct CringeClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
} CringeClassStatus;

// size: 0x4
typedef struct BideClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
    /* 0x2 */ u8 moveSlot; // The position of the move in the Pokémon's moveset that triggered the status.
} BideClassStatus;

// size: 0x4
typedef struct ReflectClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
} ReflectClassStatus;

// size: 0x8
typedef struct CurseClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ bool8 applierNonTeamMemberFlag; // True if the Pokémon is a decoy and a wild Pokémon (i.e., not an allied Pokémon).
    /* 0x2 */ bool8 unk2;
    /* 0x3 */ u8 turns;
    /* 0x4 */ u8 damageCountdown;
} CurseClassStatus;

// size: 0xC
typedef struct LeechSeedClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x4 */ u32 unk4;
    /* 0x8 */ u8 unk8;
    /* 0x9 */ u8 turns;
    /* 0xA */ u8 damageCountdown;
} LeechSeedClassStatus;

// size: 0x4
typedef struct SureShotClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
} SureShotClassStatus;

// size: 0x4
typedef struct LongTossClassStatus
{
    /* 0x0 */ u8 status;
} LongTossClassStatus;

// size: 0x4
typedef struct InvisibleClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
} InvisibleClassStatus;

// size: 0x4
typedef struct BlinkerClassStatus
{
    /* 0x0 */ u8 status;
    /* 0x1 */ u8 turns;
} BlinkerClassStatus;

// size: 0x4
typedef struct Muzzled
{
    /* 0x0 */ bool8 muzzled;
    /* 0x1 */ u8 turns;
} Muzzled;

// size: 0x1C
typedef struct Unk_Entity_x184
{
    /* 0x184 - 0x0 */ DungeonPos previousTargetMovePosition1;
    /* 0x188 - 0x4 */ PixelPos previousTargetMovePosition2;
    /* 0x190 - 0xC */ s32 lastMoveDirection; // The last direction that the Pokémon moved in.
    // Number of tiles that the Pokémon moved last, multiplied by 0x100.
    /* 0x194 - 0x10*/ PixelPos lastMoveIncrement;
    /* 0x19C - 0x18 */ s16 walkAnimFramesLeft; // Set when the Pokémon starts moving, and counts down until the Pokémon's walk animation stops.
    /* 0x19e - 0x1a */ u8 unk1A;
} Unk_Entity_x184;

// size: R=0x24 | B=0x19?
typedef struct Moves
{
    /* R=0x0  | B=0x0  */ Move moves[MAX_MON_MOVES];
    /* R=0x20 | B=0x18 */ u8 struggleMoveFlags;
} Moves;

// size: 0x208
typedef struct EntityInfo
{
    /* 0x0 */ u16 flags; // MovementFlag
    /* 0x2 */ s16 id; // Pokémon species.
    /* 0x4 */ s16 apparentID; // Shows a different Pokémon when using Transform.
    /* 0x6 */ bool8 isNotTeamMember;
    /* 0x7 */ bool8 isTeamLeader;
    /* 0x8 */ u8 shopkeeper;
    /* 0x9 */ u8 level;
    /* 0xA */ u8 teamIndex; // Leader is 0, partner is 1, etc.
    /* 0xC */ s16 IQ;
    /* 0xE */ s16 HP;
    /* 0x10 */ s16 maxHPStat;
    // Bosses have higher HP than normal for their level. This is the max HP they would normally have given their level.
    /* 0x12 */ s16 originalHP;
    /* 0x14 */ u8 atk[2]; // Index 0 is Attack. Index 1 is Special Attack.
    /* 0x16 */ u8 def[2]; // Index 0 is Defense. Index 1 is Special Defense.
    /* 0x18 */ u32 exp;
    // Temporary stat boosts/drops from effects like Growl or Swords Dance.
    // These start at 10 and are in the range [1, 19].
    // Index 0 is Attack. Index 1 is Special Attack.
    /* 0x1C */ s16 offensiveStages[2];
    // Index 0 is Defense. Index 1 is Special Defense.
    /* 0x20 */ s16 defensiveStages[2];
    // Index 0 is accuracy. Index 1 is evasion.
    /* 0x24 */ s16 hitChanceStages[2];
    // // When a Fire-type move is used on a Pokémon with Flash Fire, this value increases the power of the Pokémon's Fire-type moves.
    /* 0x28 */ s16 flashFireBoost;
    // These start at 0x1000, and are halved by certain moves like Screech to lower the corresponding stat.
    // Index 0 is Attack. Index 1 is Special Attack.
    /* 0x2C */ s24_8 offensiveMultipliers[2];
    // Index 0 is Defense. Index 1 is Special Defense.
    /* 0x34 */ s24_8 defensiveMultipliers[2];
    /* 0x3C */ HiddenPower hiddenPower;
    /* 0x40 */ DungeonLocation joinedAt; // Uses the dungeon index in dungeon.h.
    /* 0x44 */ ActionContainer action;
    /* 0x5C */ u8 types[2];
    /* 0x5E */ u8 abilities[2];
    /* 0x60 */ Item heldItem;
    /* 0x64 */ u8 unk64;
    /* 0x68 */ DungeonPos prevPos[NUM_PREV_POS];
    /* 0x78 */ AITarget aiTarget;
    // Bitwise flags corresponding to selected IQ skills.
    /* 0x8C */ IqSkillFlags IQSkillMenuFlags; // IQ skills selected in the IQ skills menu.
    /* 0x90 */ IqSkillFlags IQSkillFlags;
    /* 0x94 */ u8 tactic;
    /* 0x98 */ u32 dungeonSpriteId;
    /* 0x9C */ u32 unk9C;
    /* 0xA0 */ s32 unkA0;
    /* 0xA4 */ u8 monsterBehavior;
    // Statuses are split into groups based on which ones can't overlap.
    // See status.h for which statuses are in each group.
    /* 0xA8 */ SleepClassStatus sleepClassStatus;
    /* 0xAC */ BurnClassStatus burnClassStatus;
    /* 0xB0 */ FrozenClassStatus frozenClassStatus;
    /* 0xBC */ CringeClassStatus cringeClassStatus;
    /* 0xC0 */ BideClassStatus bideClassStatus;
    /* 0xC4 */ ReflectClassStatus reflectClassStatus;
    /* 0xC8 */ CurseClassStatus curseClassStatus;
    /* 0xD0 */ LeechSeedClassStatus leechSeedClassStatus;
    /* 0xDC */ SureShotClassStatus sureShotClassStatus;
    /* 0xE0 */ LongTossClassStatus longTossClassStatus;
    /* 0xE4 */ InvisibleClassStatus invisibleClassStatus;
    /* 0xE8 */ BlinkerClassStatus blinkerClassStatus;
    /* 0xEC */ Muzzled muzzled;
    /* 0xF0 */ bool8 powerEars;
    /* 0xF1 */ bool8 scanning;
    /* 0xF2 */ bool8 stairSpotter;
    /* 0xF3 */ bool8 unkF3;
    /* 0xF4 */ bool8 grudge;
    /* 0xF5 */ bool8 exposed;
    /* 0xF6 */ bool8 isColorChanged;
    /* 0xF7 */ bool8 bossFlag;
    /* 0xF8 */ bool8 speedStageChanged; // Toggled when pokemon is movement speed is sped up
    /* 0xF9 */ u8 unkF9;
    /* 0xFA */ u8 terrifiedTurns; // Doubles as a bool for whether the Pokémon is terrified.
    /* 0xFB */ u8 expMultiplier;
    // Set to true if the player makes a teammate use their held item.
    // This is done by going to the teammate's held item in the toolbox and selecting "Use".
    /* 0xFC */ bool8 useHeldItem;
    /* 0xFD */ u8 perishSongTurns; // When this reaches 0, the Pokémon faints from Perish Song. Doubles as a bool for whether the Pokémon is afflicted by Perish Song.
    u8 unkFE;
    u8 unkFF;
    /* 0x100 */ u8 decoyAITracker; // If the Pokémon is targeting a decoy, this indicates whether the decoy target is a team or wild Pokémon.
    /* 0x104 */ s32 speedStage;
    // The turn counter for movement speed up/down is split into five timers each. Multiple timers are used if the Pokémon is affected by multiple
    // speed-up/slow effects at once, like using Agility twice.
    /* 0x108 */ u8 speedUpCounters[NUM_SPEED_COUNTERS];
    /* 0x10D */ u8 speedDownCounters[NUM_SPEED_COUNTERS];
    /* 0x112 */ u8 stockpileStage;
    /* 0x113 */ u8 speedBoostFrames; // Frames counter, when it reaches the value in gSpeedBoostActivationFrame(250 by default), it resets to 0 and pokemon gets a speed boost.
    // When non-zero, an AI Pokémon will move in a random direction every turn when it is a room.
    // There is a chance of this flag being set when a wild Pokémon spawns. The chance depends on the dungeon's randomMovementChance.
    /* 0x114 */ u32 moveRandomly;
    /* 0x118 */ Moves moves;
    /* 0x13C */ FixedPoint belly;
    /* 0x140 */ FixedPoint maxBelly;
    /* 0x144 */ bool8 aiAllySkip; // True if an AI Pokémon is following another Pokémon and is already adjacent to them.
    /* 0x145 */ bool8 recalculateFollow; // Used by the AI to defer a movement decision until after all other Pokémon have moved.
    /* 0x146 */ bool8 bellyEmpty;
    /* 0x147 */ bool8 waiting; // True if an AI Pokémon decided to do nothing this turn.
    /* 0x148 */ bool8 attacking;
    /* 0x149 */ u8 unk149;
    /* 0x14A */ u8 unk14A;
    /* 0x14B */ u8 unk14B;
    /* 0x14C */ u8 unk14C;
    /* 0x14E */ u16 visualFlags;
    /* 0x150 */ u16 previousVisualFlags;
    /* 0x152 */ u8 unk152;
    /* 0x153 */ u8 usedLinkedMovesCounter; // how many linked moves were used this turn.
    u8 unk154;
    u8 unk155;
    u8 unk156;
    bool8 unk157;
    u8 unk158;
    u8 unk159;
    u8 unk15A;
    u8 unk15B;
    u8 unk15C;
    u8 unk15D;
    u8 unk15E;
    u8 unk15F;
    u8 unk160;
    u8 fill161[3];
    /* 0x164 */ u8 unk164;
    /* 0x165 */ u8 unk165;
    /* 0x166 */ u8 unk166;
    /* 0x167 */ u8 unk167;
    /* 0x168 */ u8 unk168;
    /* 0x169 */ u8 turnsSinceWarpScarfActivation;
    /* 0x16C */ DungeonPos targetPos;
    /* 0x170 */ DungeonPos pixelPos;
    s24_8 unk174;
    /* 0x178 */ u16 abilityEffectFlags; // See enum AbilityEffectFlags
    /* 0x17A */ u16 mimicMoveIDs[MAX_MON_MOVES]; // All moves that Mimic has copied (not sure on size...)
    // Previous value of targetPosition for movement, 1 and 2 moves ago.
    /* 0x184 */ Unk_Entity_x184 unk184[4];
    /* 0x1F4 */ s16 numMoveTiles; // Number of tiles to move in a turn. Can be greater than 1 if the user's movement speed is boosted.
    /* 0x1F6 */ s16 notMoving;
    /* 0x1F8 */ s16 unk1F8;
    /* 0x1FA */ s16 mobileTurnTimer; // When a Pokémon can pass through walls in a hallway, this counts up to 200 before the Pokémon turns in a random direction.
    /* 0x1FC */ u32 expGainedInTurn; // Used to accumulate experience when multiple enemies are defeated in one turn.
    /* 0x200 */ u32 statusIcons;
    /* 0x204 */ u8 shadowIndex;
} EntityInfo;

// size: 0x74 | Used for Pokémon, items, and traps.
typedef struct Entity
{
    /* 0x0 */ u32 type;
    /* 0x4 */ DungeonPos pos;
    /* 0x8 */ DungeonPos prevPos;
    // The center of the entity acccording to pixel-space coordinates, using the same origin as posWorld.
    // X = (posWorld * 24 + 16) * 256, while Y = (posWorld * 24 + 12) * 256.
    /* 0xC */ PixelPos pixelPos;
    /* 0x14 */ PixelPos prevPixelPos;
    /* 0x1C */ s24_8 unk1C;
    /* 0x20 */ bool8 isVisible; // Turned off when a Pokémon faints.
    u8 unk21;
    u8 unk22;
    u8 unk23;
    u8 unk24;
    /* 0x25 */ u8 room;
    // The global spawn index counter starts at 10. Each Pokémon that spawns increments the counter and
    // gets assigned the current counter value as its spawn index.
    /* 0x26 */ u16 spawnGenID;
    /* 0x28 */ axObject axObj;
} Entity;

enum EntityType
{
    ENTITY_NOTHING,
    ENTITY_MONSTER,
    ENTITY_TRAP,
    ENTITY_ITEM,
    ENTITY_UNK_4,
    ENTITY_UNK_5,
};

enum MovementFlag
{
    MOVEMENT_FLAG_SWAPPING_PLACES = 1 << 5,
    MOVEMENT_FLAG_WALKING = 1 << 9,
    MOVEMENT_FLAG_UNK_14 = 1 << 14,
    MOVEMENT_FLAG_SWAPPING_PLACES_PETRIFIED_ALLY = 1 << 15 // Set if the Pokémon is petrified and the leader cures them by swapping places.
};

enum AbilityEffectFlags
{
    ABILITY_FLAG_ARENA_TRAP = 1 << 0,
    ABILITY_FLAG_SHADOW_TAG = 1 << 1,
    ABILITY_FLAG_MAGNET_PULL = 1 << 2,
    ABILITY_FLAG_STATIC = 1 << 3,
    ABILITY_FLAG_EFFECT_SPORE_PRLZ = 1 << 4,
    ABILITY_FLAG_POISON_POINT = 1 << 5,
    ABILITY_FLAG_EFFECT_SPORE_PSN = 1 << 6,
    ABILITY_FLAG_EFFECT_SPORE_SLP = 1 << 7,
    ABILITY_FLAG_FLAME_BODY = 1 << 8,
    ABILITY_FLAG_CUTE_CHARM = 1 << 9,
    ABILITY_FLAG_STENCH = 1 << 10,
};

enum ShopkeeperMode
{
    SHOPKEEPER_MODE_NORMAL,
    SHOPKEEPER_MODE_SHOPKEEPER,
    // These two modes trigger if an explosion damages the shopkeeper. The shopkeeper attacks the side that damaged it.
    SHOPKEEPER_MODE_ATTACK_ENEMIES,
    SHOPKEEPER_MODE_ATTACK_TEAM
};

enum AIObjective
{
    // 0
    AI_CHASE_TARGET = 1,
    AI_CHASE_REMEMBERED_TARGET,
    AI_ROAM,
    AI_LEAVE_ROOM,
    AI_RUN_AWAY,
    AI_STAND_STILL,
    AI_TAKE_ITEM
};

enum MonsterBehavior
{
    BEHAVIOR_FIXED_ENEMY,
    BEHAVIOR_RESCUE_TARGET, // Used for mission clients that need rescuing.
    BEHAVIOR_ALLY,
    BEHAVIOR_SKARMORY,
    BEHAVIOR_DIGLETT, // Used for Diglett in the Skarmory boss fight.
    BEHAVIOR_GENGAR,
    BEHAVIOR_EKANS,
    BEHAVIOR_MEDICHAM,
    BEHAVIOR_ZAPDOS,
    BEHAVIOR_MOLTRES,
    BEHAVIOR_ALAKAZAM_1,
    BEHAVIOR_GROUDON_1,
    BEHAVIOR_ALAKAZAM_2,
    BEHAVIOR_ARTICUNO,
    BEHAVIOR_GROUDON_2,
    BEHAVIOR_RAYQUAZA,
    BEHAVIOR_MANKEY,
    BEHAVIOR_MEWTWO,
    BEHAVIOR_ENTEI,
    BEHAVIOR_RAIKOU,
    BEHAVIOR_SUICUNE,
    BEHAVIOR_HO_OH,
    BEHAVIOR_LATIOS,
    BEHAVIOR_REGIROCK,
    BEHAVIOR_REGICE,
    BEHAVIOR_REGISTEEL,
    BEHAVIOR_JIRACHI,
    BEHAVIOR_LUGIA,
    BEHAVIOR_KYOGRE,
    BEHAVIOR_DEOXYS_NORMAL,
    BEHAVIOR_CELEBI,
    BEHAVIOR_SMEARGLE,
    BEHAVIOR_32,
    BEHAVIOR_33,
    BEHAVIOR_34,
    BEHAVIOR_35,
    BEHAVIOR_MAZE_BOSS,
};

enum VisualFlag
{
    // Set if Run Away's visual effect (green smoke cloud) has been triggered on this floor.
    // Prevents the effect from showing again if the Pokémon stops running away and then starts running away again.
    VISUAL_FLAG_RUN_AWAY = 2
};

enum ExpMultiplier
{
    EXP_HALVED, // 0.5x when fainting a mon with only the regular attack and no moves
    EXP_REGULAR, // 1x
    EXP_BOOSTED, // 1.5x when using linked moves
};

static inline bool8 ExpMultiplierChanged(EntityInfo *info)
{
    return (info->expMultiplier != EXP_HALVED);
}

static inline void SetRegularExpMultiplier(EntityInfo *info)
{
    info->expMultiplier = EXP_REGULAR;
}

// After using a move, pokemon will get more experience than
// This inline is needed to match one function - sub_805AD54
static inline void SetExpMultplier(EntityInfo *info)
{
    if (!ExpMultiplierChanged(info))
        SetRegularExpMultiplier(info);
}

#endif