mirror/oot
1
0
Fork 0
mirror of https://github.com/zeldaret/oot.git synced 2024-11-29 03:34:07 +00:00
Code Issues Projects Releases Wiki Activity

Document a bug in Actor_ChangeCategory where actors may not be updated correctly (#1587)

Browse source 
* Document Actor_ChangeCategory bug

* Reword

* actor update function -> actor update
This commit is contained in:
cadmic 2023-11-30 17:18:00 -08:00 committed by GitHub
parent 5ce4670fd1
commit 2ab90bc517
No account linked to committer's email address
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/code/z_actor.c
View file

@ -3397,6 +3397,12 @@ Actor* func_80033684(PlayState* play, Actor* explosiveActor) {
* This is done by moving it to the corresponding category list and setting its category variable accordingly. * This is done by moving it to the corresponding category list and setting its category variable accordingly.
*/ */
void Actor_ChangeCategory(PlayState* play, ActorContext* actorCtx, Actor* actor, u8 actorCategory) { void Actor_ChangeCategory(PlayState* play, ActorContext* actorCtx, Actor* actor, u8 actorCategory) {
//! @bug Calling this function immediately moves an actor from one category list to the other.
//! So, if Actor_ChangeCategory is called during an actor update, the inner loop in
//! Actor_UpdateAll will continue from the next actor in the new category, rather than the next
//! actor in the old category. This will cause any actors after this one in the old category to
//! be skipped over and not updated, and any actors in the new category to be updated more than
//! once.
Actor_RemoveFromCategory(play, actorCtx, actor); Actor_RemoveFromCategory(play, actorCtx, actor);
Actor_AddToCategory(actorCtx, actor, actorCategory); Actor_AddToCategory(actorCtx, actor, actorCategory);
} }