mirror/oot
1
0
Fork 0
mirror of https://github.com/zeldaret/oot synced 2026-08-24 15:27:09 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document z_eff_ss_stone1.[ch] (#2670)

Browse Source 
* Document z_eff_ss_stone1.[ch]

* Incorporate feedback from PR review.

From https://github.com/zeldaret/oot/pull/2670:
- Shortened excessively verbose
  suppressRTransFadeFlashAlphaStepAfterTwoFrames name to
  suppressFadeFlash
- Fixed up comment that went waaaaaay beyond the column limit in
  z_eff_ss_stone1.h
- Shortened comparison with 0 of variable bool semantics in
  z_eff_ss_stone1.c

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

* Fix misnaming from PR review and document some more

From https://github.com/zeldaret/oot/pull/2670:
- shortenFadeFlash is incorrect - renamed to freezeFadeFlash
- Used `false` instead of 0 in EnArrow_Fly
- Elaborated comments about what exactly freezeFadeFlash does

Also added a few extra comments to z_eff_ss_stone1.c

* Ran clang-format

* More feedback from PR review, clarified comment

From https://github.com/zeldaret/oot/pull/2670:
- Change 0 to false in header comment
- Remove verbose speculation about former use of unused variable
- Made comment on use of viewDepth clearer
- Separated matrix and gfx code with a newline

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

* Marked the "1500" as being in units

---------

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>
This commit is contained in:
Gabriel Ravier
2026-08-19 14:04:49 +02:00
committed by GitHub
parent 58d06849af
commit b4c29fa50b
5 changed files with 31 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/effect.h
+1 -1
View File
@@ -391,7 +391,7 @@ void EffectSsSibuki_SpawnBurst(struct PlayState* play, Vec3f* pos);
void EffectSsSibuki2_Spawn(struct PlayState* play, Vec3f* pos, Vec3f* velocity, Vec3f* accel, s16 scale);
void EffectSsGMagma2_Spawn(struct PlayState* play, Vec3f* pos, Color_RGBA8* primColor, Color_RGBA8* envColor,
s16 updateRate, s16 drawMode, s16 scale);
void EffectSsStone1_Spawn(struct PlayState* play, Vec3f* pos, s32 arg2);
void EffectSsStone1_Spawn(struct PlayState* play, Vec3f* pos, s32 freezeFadeFlash);
void EffectSsHitMark_Spawn(struct PlayState* play, s32 type, s16 scale, Vec3f* pos);
void EffectSsHitMark_SpawnFixedScale(struct PlayState* play, s32 type, Vec3f* pos);
void EffectSsHitMark_SpawnCustomScale(struct PlayState* play, s32 type, s16 scale, Vec3f* pos);