Obj_Syokudai (Torch) OK and mostly documented (#306)

* Started uncommenting statics, but then realized this actor has BSS, lol.

* Import .data and .bss. Run format.sh.

* ObjSyokudai_Init OK and mostly documented.

* ObjSyokudai_Destroy OK and fully documented.

* ObjSyokudai_Draw OK and partially documented.

* Good progress on ObjSyokudai_Update, but NOT OK.

* Instruction match, but needs regalloc and stack.

* Stack is closer now.

* Obj_Syokudai OK, no new warnings, ran formatter.

* Documented .data and .bss variables.

* Final documentation pass before PR.

* Add header, fix build errors.

* Use COLTYPE_METAL and COLTYPE_WOOD macros.

* Apply suggestions from code review

engineer124's suggestions.

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Apply suggestions from code review

engineer124: WaterBox* instead of UNK_PTR

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Update src/overlays/actors/ovl_Obj_Syokudai/z_obj_syokudai.c

engineer124: AC_HARD -> AC_HIT so Jenkins stops complaining

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Hopefully fix Jenkins via z_bg_lotus WaterBox*.

* Rename sp2C to waterBox in BgLotus.

* Run format.sh.

* Update include/functions.h

Change func_800F22C4 param_1 from s8 to s16.

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Change func_801A5CFC param_1 to sfxId in prototype

* Document interactions.

* Run formatter.

* Clarify that posDiff is relative to stick *tip*.

* Changed interaction comparisons to better fit enum

* snuffTimer enum

* Added more #defines.

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
This commit is contained in:
rylieb
2021-09-25 07:53:53 -06:00
committed by GitHub
parent f77cfb9020
commit bc5c3866d5
10 changed files with 351 additions and 42 deletions
+4 -4
View File
@@ -696,7 +696,7 @@ void func_800B40E0(GlobalContext* globalCtx, Light* light, MtxF* arg2, s32 arg3,
void func_800B42F8(Actor* actor, Lights* mapper, GlobalContext* globalCtx);
// void func_800B4A98(UNK_TYPE1 param_1, UNK_TYPE1 param_2, UNK_TYPE1 param_3, UNK_TYPE1 param_4, UNK_TYPE4 param_5, UNK_TYPE4 param_6);
void func_800B4AEC(GlobalContext* globalCtx, Actor* actor, f32 param_3);
void func_800B4B50(Actor* actor, s32 iParm2, GlobalContext* globalCtx);
void func_800B4B50(Actor* actor, Lights* mapper, GlobalContext* globalCtx);
void func_800B4EDC(GlobalContext* globalCtx, Vec3f* pzParm2, Vec3f* pzParm3, f32* pfParm4);
// void func_800B4F40(TargetContext* targetCtx, s32 param_2, UNK_TYPE4 param_3, UNK_TYPE4 param_4, UNK_TYPE4 param_5);
void func_800B4F78(TargetContext* targetCtx, u8 type, GlobalContext* globalCtx);
@@ -1110,7 +1110,7 @@ u32 func_800C9E40(CollisionContext* colCtx, CollisionPoly* polygon, s32 index);
u32 func_800C9E88(CollisionContext* colCtx, CollisionPoly* polygon, s32 index);
// void func_800C9EBC(GlobalContext* globalCtx, CollisionContext* colCtx, UNK_TYPE1 param_3, UNK_TYPE1 param_4, UNK_TYPE4 param_5, UNK_TYPE4 param_6, UNK_TYPE4 param_7);
s32 func_800CA1AC(GlobalContext* globalCtx, CollisionContext* colCtx, f32 x, f32 z, f32* ySurface, WaterBox** outWaterBox);
void func_800CA1E8(GlobalContext* globalCtx, CollisionContext* colCtx, f32 arg2, f32 arg3, f32* arg4, UNK_PTR arg5);
s32 func_800CA1E8(GlobalContext* globalCtx, CollisionContext* colCtx, f32 x, f32 z, f32* ySurface, WaterBox** outWaterBox);
// void func_800CA22C(UNK_TYPE1 param_1, UNK_TYPE1 param_2, UNK_TYPE1 param_3, UNK_TYPE1 param_4, UNK_TYPE4 param_5, UNK_TYPE4 param_6);
// void func_800CA568(void);
// void func_800CA634(void);
@@ -1687,7 +1687,7 @@ s16 ActorCutscene_GetLength(s16 index);
// void func_800F2178(void);
s16 ActorCutscene_GetCurrentCamera(s16 index);
// void func_800F21CC(void);
// UNK_TYPE4 func_800F22C4(s16 param_1, Actor* actor);
s32 func_800F22C4(s16 param_1, Actor* actor);
void ActorCutscene_SetReturnCamera(s16 index);
// void func_800F23E0(UNK_TYPE1 param_1, UNK_TYPE1 param_2, UNK_TYPE1 param_3, UNK_TYPE1 param_4, UNK_TYPE4 param_5, UNK_TYPE4 param_6);
// void func_800F2478(void);
@@ -3992,7 +3992,7 @@ UNK_TYPE func_801A51F0(UNK_TYPE arg0);
void func_801A5BD0(s32 param_1);
// void func_801A5C28(void);
// void func_801A5C8C(void);
// void func_801A5CFC(UNK_TYPE1 param_1, UNK_TYPE1 param_2, UNK_TYPE1 param_3, UNK_TYPE1 param_4, UNK_TYPE4 param_5, UNK_TYPE4 param_6);
void func_801A5CFC(u16 sfxId, Vec3f* param_2, u8 param_3, f32* param_4, f32* param_5, s8* param_6);
// void func_801A5DDC(void);
// void func_801A5F7C(void);
// void func_801A6430(void);
+2 -2
View File
@@ -1876,8 +1876,8 @@ extern UNK_PTR D_801DB478[7];
// extern UNK_TYPE1 D_801DB49C;
// extern UNK_TYPE2 D_801DB4A0;
extern UNK_TYPE D_801DB4A4;
// extern UNK_TYPE1 D_801DB4B0;
// extern UNK_TYPE1 D_801DB4B8;
extern f32 D_801DB4B0;
extern s8 D_801DB4B8;
// extern UNK_TYPE1 D_801DB4C0;
// extern UNK_TYPE1 D_801DB4C4;
// extern UNK_TYPE1 D_801DB4C8;