Document undefined sprite template behavior

This commit is contained in:
Sierraffinity 2020-04-25 18:25:55 -07:00
parent b2d8c6793d
commit 072a98ca9a
3 changed files with 10 additions and 0 deletions

View File

@ -878,12 +878,14 @@ void ResetAllSprites(void)
ResetSprite(&gSprites[i]);
}
// UB: template pointer may point to freed temporary storage
void FreeSpriteTiles(struct Sprite *sprite)
{
if (sprite->template->tileTag != 0xFFFF)
FreeSpriteTilesByTag(sprite->template->tileTag);
}
// UB: template pointer may point to freed temporary storage
void FreeSpritePalette(struct Sprite *sprite)
{
FreeSpritePaletteByTag(sprite->template->paletteTag);

View File

@ -182,6 +182,10 @@ struct SpriteTemplate
SpriteCallback callback;
};
// UB: template pointer is often used to point to temporary storage,
// then later dereferenced after being freed. Usually this won't
// be visible in-game, but this is (part of) what causes the item
// icon palette to flicker when changing items in the bag.
struct Sprite
{
/*0x00*/ struct OamData oam;

View File

@ -484,11 +484,15 @@ static void sub_801B7D8(u32 command)
}
if (dest == NULL)
{
AGB_ASSERT(0);
}
else if (++(*dest) > 999)
{
*dest = 999;
}
}
}
u16 mevent_081445C0(u32 command)
{