Document Player's bgcheck routine (#1275)

* Thanks Fig

* cleanup

* more docs

* cleanup

* oops

* cleanup comment

* add comment to SurfaceType_GetSceneExitIndex

* fix bss
This commit is contained in:
engineer124
2023-06-24 16:39:55 +10:00
committed by GitHub
parent 5619dc5b5e
commit 19da43859e
9 changed files with 600 additions and 519 deletions
+3
View File
@@ -4200,6 +4200,9 @@ Vec3s* BgCheck_GetBgCamFuncData(CollisionContext* colCtx, CollisionPoly* poly, s
return BgCheck_GetBgCamFuncDataImpl(colCtx, SurfaceType_GetBgCamIndex(colCtx, poly, bgId), bgId);
}
/**
* Returns one above the value indexed by `play->setupExitList[]`
*/
u32 SurfaceType_GetSceneExitIndex(CollisionContext* colCtx, CollisionPoly* poly, s32 bgId) {
return SurfaceType_GetData(colCtx, poly, bgId, 0) >> 8 & 0x1F;
}