mirror of
https://github.com/zeldaret/oot.git
synced 2024-12-29 16:26:18 +00:00
f3c930917b
* Implement a single Object Table for the enum and the segments * Implement a single Actor Table for the enum and the overlays * Implement a single Effect SS Table for the enum and the overlays * Remove initvars.h and move its content to relevant files * Update object 0 to use OBJECT_NONE and document it in the table * Rename OBJECT_NONE to OBJECT_INVALID to avoid confusion
262 lines
8 KiB
C
262 lines
8 KiB
C
#ifndef _Z64EFFECT_H_
|
|
#define _Z64EFFECT_H_
|
|
|
|
#include "color.h"
|
|
|
|
struct GraphicsContext;
|
|
struct GlobalContext;
|
|
|
|
/* Effects */
|
|
|
|
#define SPARK_COUNT 3
|
|
#define BLURE_COUNT 25
|
|
#define SHIELD_PARTICLE_COUNT 3
|
|
|
|
#define TOTAL_EFFECT_COUNT SPARK_COUNT + BLURE_COUNT + SHIELD_PARTICLE_COUNT
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u8 active;
|
|
/* 0x01 */ u8 unk_01;
|
|
/* 0x02 */ u8 unk_02;
|
|
} EffectStatus; // size = 0x03
|
|
|
|
typedef struct {
|
|
/* 0x00 */ Vec3f velocity;
|
|
/* 0x0C */ Vec3f position;
|
|
/* 0x18 */ Vec3s unkVelocity;
|
|
/* 0x1E */ Vec3s unkPosition;
|
|
} EffectSparkElement; // size = 0x24
|
|
|
|
typedef struct {
|
|
/* 0x000 */ Vec3s position;
|
|
/* 0x008 */ s32 numElements; // "table_size"; calculated as uDiv * vDiv + 2
|
|
/* 0x00C */ EffectSparkElement elements[32];
|
|
/* 0x48C */ f32 speed;
|
|
/* 0x490 */ f32 gravity;
|
|
/* 0x494 */ u32 uDiv; // "u_div"
|
|
/* 0x498 */ u32 vDiv; // "v_div"
|
|
/* 0x49C */ Color_RGBA8 colorStart[4];
|
|
/* 0x4AC */ Color_RGBA8 colorEnd[4];
|
|
/* 0x4BC */ s32 timer;
|
|
/* 0x4C0 */ s32 duration;
|
|
} EffectSparkInit; // size = 0x4C4
|
|
|
|
typedef struct {
|
|
/* 0x000 */ Vec3s position;
|
|
/* 0x008 */ s32 numElements; // "table_size"; calculated as uDiv * vDiv + 2
|
|
/* 0x00C */ EffectSparkElement elements[32];
|
|
/* 0x48C */ f32 speed;
|
|
/* 0x490 */ f32 gravity;
|
|
/* 0x494 */ u32 uDiv; // "u_div"
|
|
/* 0x498 */ u32 vDiv; // "v_div"
|
|
/* 0x49C */ Color_RGBA8 colorStart[4];
|
|
/* 0x4AC */ Color_RGBA8 colorEnd[4];
|
|
/* 0x4BC */ s32 timer;
|
|
/* 0x4C0 */ s32 duration;
|
|
} EffectSpark; // size = 0x4C4
|
|
|
|
typedef struct {
|
|
/* 0x00 */ s32 state;
|
|
/* 0x04 */ s32 timer;
|
|
/* 0x08 */ Vec3s p1;
|
|
/* 0x0E */ Vec3s p2;
|
|
/* 0x14 */ u16 flags;
|
|
} EffectBlureElement; // size = 0x18
|
|
|
|
typedef struct {
|
|
/* 0x000 */ char unk_00[0x184];
|
|
/* 0x184 */ u8 p1StartColor[4];
|
|
/* 0x188 */ u8 p2StartColor[4];
|
|
/* 0x18C */ u8 p1EndColor[4];
|
|
/* 0x190 */ u8 p2EndColor[4];
|
|
/* 0x194 */ s32 elemDuration;
|
|
/* 0x198 */ s32 unkFlag;
|
|
/* 0x19C */ s32 calcMode;
|
|
} EffectBlureInit1; // size = 0x1A0
|
|
|
|
typedef struct {
|
|
/* 0x00 */ s32 calcMode;
|
|
/* 0x04 */ u16 flags;
|
|
/* 0x06 */ s16 addAngleChange;
|
|
/* 0x08 */ u8 p1StartColor[4];
|
|
/* 0x0C */ u8 p2StartColor[4];
|
|
/* 0x10 */ u8 p1EndColor[4];
|
|
/* 0x14 */ u8 p2EndColor[4];
|
|
/* 0x18 */ u8 elemDuration;
|
|
/* 0x19 */ u8 unkFlag;
|
|
/* 0x1A */ u8 drawMode; // 0: simple; 1: simple with alt colors; 2+: smooth
|
|
/* 0x1B */ u8 mode4Param;
|
|
/* 0x1C */ Color_RGBA8 altPrimColor; // used with drawMode 1
|
|
/* 0x20 */ Color_RGBA8 altEnvColor; // used with drawMode 1
|
|
} EffectBlureInit2; // size = 0x24
|
|
|
|
typedef struct {
|
|
/* 0x000 */ EffectBlureElement elements[16];
|
|
/* 0x180 */ s32 calcMode;
|
|
/* 0x184 */ f32 mode4Param;
|
|
/* 0x188 */ u16 flags;
|
|
/* 0x18A */ s16 addAngleChange;
|
|
/* 0x18C */ s16 addAngle;
|
|
/* 0x18E */ Color_RGBA8 p1StartColor;
|
|
/* 0x192 */ Color_RGBA8 p2StartColor;
|
|
/* 0x196 */ Color_RGBA8 p1EndColor;
|
|
/* 0x19A */ Color_RGBA8 p2EndColor;
|
|
/* 0x19E */ u8 numElements; // "now_edge_num"
|
|
/* 0x19F */ u8 elemDuration;
|
|
/* 0x1A0 */ u8 unkFlag;
|
|
/* 0x1A1 */ u8 drawMode; // 0: simple; 1: simple with alt colors; 2+: smooth
|
|
/* 0x1A2 */ Color_RGBA8 altPrimColor; // used with drawMode 1
|
|
/* 0x1A6 */ Color_RGBA8 altEnvColor; // used with drawMode 1
|
|
} EffectBlure; // size = 0x1AC
|
|
|
|
typedef struct {
|
|
/* 0x00 */ f32 initialSpeed;
|
|
/* 0x04 */ f32 endXChange;
|
|
/* 0x08 */ f32 endX;
|
|
/* 0x0C */ f32 startXChange;
|
|
/* 0x10 */ f32 startX;
|
|
/* 0x14 */ s16 yaw;
|
|
/* 0x16 */ s16 pitch;
|
|
} EffectShieldParticleElement; // size = 0x18
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u8 numElements;
|
|
/* 0x02 */ Vec3s position;
|
|
/* 0x08 */ Color_RGBA8 primColorStart;
|
|
/* 0x0C */ Color_RGBA8 envColorStart;
|
|
/* 0x10 */ Color_RGBA8 primColorMid;
|
|
/* 0x14 */ Color_RGBA8 envColorMid;
|
|
/* 0x18 */ Color_RGBA8 primColorEnd;
|
|
/* 0x1C */ Color_RGBA8 envColorEnd;
|
|
/* 0x20 */ f32 deceleration;
|
|
/* 0x24 */ f32 maxInitialSpeed;
|
|
/* 0x28 */ f32 lengthCutoff;
|
|
/* 0x2C */ u8 duration;
|
|
/* 0x2E */ LightPoint lightPoint;
|
|
/* 0x3C */ s32 lightDecay; // halves light radius every frame when set to 1
|
|
} EffectShieldParticleInit; // size = 0x40
|
|
|
|
typedef struct {
|
|
/* 0x000 */ EffectShieldParticleElement elements[16];
|
|
/* 0x180 */ u8 numElements;
|
|
/* 0x182 */ Vec3s position;
|
|
/* 0x188 */ Color_RGBA8 primColorStart;
|
|
/* 0x18C */ Color_RGBA8 envColorStart;
|
|
/* 0x190 */ Color_RGBA8 primColorMid;
|
|
/* 0x194 */ Color_RGBA8 envColorMid;
|
|
/* 0x198 */ Color_RGBA8 primColorEnd;
|
|
/* 0x19C */ Color_RGBA8 envColorEnd;
|
|
/* 0x1A0 */ f32 deceleration;
|
|
/* 0x1A4 */ char unk_1A4[0x04];
|
|
/* 0x1A8 */ f32 maxInitialSpeed;
|
|
/* 0x1AC */ f32 lengthCutoff;
|
|
/* 0x1B0 */ u8 duration;
|
|
/* 0x1B1 */ u8 timer;
|
|
/* 0x1B2 */ LightInfo lightInfo;
|
|
/* 0x1C0 */ LightNode* lightNode;
|
|
/* 0x1C4 */ s32 lightDecay; // halves light radius every frame when set to 1
|
|
} EffectShieldParticle; // size = 0x1C8
|
|
|
|
typedef struct {
|
|
/* 0x0000 */ struct GlobalContext* globalCtx;
|
|
struct {
|
|
EffectStatus status;
|
|
EffectSpark effect;
|
|
} /* 0x0004 */ sparks[SPARK_COUNT];
|
|
struct {
|
|
EffectStatus status;
|
|
EffectBlure effect;
|
|
} /* 0x0E5C */ blures[BLURE_COUNT];
|
|
struct {
|
|
EffectStatus status;
|
|
EffectShieldParticle effect;
|
|
} /* 0x388C */ shieldParticles[SHIELD_PARTICLE_COUNT];
|
|
} EffectContext; // size = 0x3DF0
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u32 size;
|
|
/* 0x04 */ void (*init)(void* effect, void* initParams);
|
|
/* 0x08 */ void (*destroy)(void* effect);
|
|
/* 0x0C */ s32 (*update)(void* effect);
|
|
/* 0x10 */ void (*draw)(void* effect, struct GraphicsContext* gfxCtx);
|
|
} EffectInfo; // size = 0x14
|
|
|
|
typedef enum {
|
|
/* 0x00 */ EFFECT_SPARK,
|
|
/* 0x01 */ EFFECT_BLURE1,
|
|
/* 0x02 */ EFFECT_BLURE2,
|
|
/* 0x03 */ EFFECT_SHIELD_PARTICLE
|
|
} EffectType;
|
|
|
|
/* Effect Soft Sprites */
|
|
|
|
struct EffectSs;
|
|
|
|
typedef u32 (*EffectSsInitFunc)(struct GlobalContext* globalCtx, u32 index, struct EffectSs* effectSs, void* initParams);
|
|
typedef void (*EffectSsUpdateFunc)(struct GlobalContext* globalCtx, u32 index, struct EffectSs* effectSs);
|
|
typedef void (*EffectSsDrawFunc)(struct GlobalContext* globalCtx, u32 index, struct EffectSs* effectSs);
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u32 type;
|
|
/* 0x04 */ EffectSsInitFunc init;
|
|
} EffectSsInit; // size = 0x08
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u32 vromStart;
|
|
/* 0x04 */ u32 vromEnd;
|
|
/* 0x08 */ void* vramStart;
|
|
/* 0x0C */ void* vramEnd;
|
|
/* 0x10 */ void* loadedRamAddr;
|
|
/* 0x14 */ EffectSsInit* initInfo;
|
|
/* 0x18 */ u8 unk_18;
|
|
} EffectSsOverlay; // size = 0x1C
|
|
|
|
typedef struct EffectSs {
|
|
/* 0x00 */ Vec3f pos;
|
|
/* 0x0C */ Vec3f velocity;
|
|
/* 0x18 */ Vec3f accel;
|
|
/* 0x24 */ EffectSsUpdateFunc update;
|
|
/* 0x28 */ EffectSsDrawFunc draw;
|
|
/* 0x2C */ Vec3f vec; // usage specific per effect
|
|
/* 0x38 */ void* gfx; // mostly used for display lists, sometimes textures
|
|
/* 0x3C */ Actor* actor; // interfacing actor, usually the actor that spawned the effect
|
|
/* 0x40 */ s16 regs[13]; // specific per effect
|
|
/* 0x5A */ u16 flags;
|
|
/* 0x5C */ s16 life; // -1 means this entry is free
|
|
/* 0x5E */ u8 priority; // Lower value means higher priority
|
|
/* 0x5F */ u8 type;
|
|
} EffectSs; // size = 0x60
|
|
|
|
typedef struct {
|
|
/* 0x00 */ EffectSs* table; // "data_table"
|
|
/* 0x04 */ s32 searchStartIndex;
|
|
/* 0x08 */ s32 tableSize;
|
|
} EffectSsInfo; // size = 0x0C
|
|
|
|
/* G Effect Regs */
|
|
|
|
#define rgTexIdx regs[0]
|
|
#define rgScale regs[1]
|
|
#define rgTexIdxStep regs[2]
|
|
#define rgPrimColorR regs[3]
|
|
#define rgPrimColorG regs[4]
|
|
#define rgPrimColorB regs[5]
|
|
#define rgPrimColorA regs[6]
|
|
#define rgEnvColorR regs[7]
|
|
#define rgEnvColorG regs[8]
|
|
#define rgEnvColorB regs[9]
|
|
#define rgEnvColorA regs[10]
|
|
#define rgObjBankIdx regs[11]
|
|
|
|
#define DEFINE_EFFECT_SS(_0, enum) enum,
|
|
#define DEFINE_EFFECT_SS_UNSET(enum) enum,
|
|
|
|
typedef enum {
|
|
#include "tables/effect_ss_table.h"
|
|
/* 0x25 */ EFFECT_SS_TYPE_MAX // originally "EFFECT_SS2_TYPE_LAST_LABEL"
|
|
} EffectSsType;
|
|
|
|
#undef DEFINE_EFFECT_SS
|
|
#undef DEFINE_EFFECT_SS_UNSET
|
|
|
|
#endif
|