Merge pull request #1035 from Sierraffinity/master

Document undefined sprite template behavior

1 files changed, 4 insertions, 0 deletions

diff --git a/gflib/sprite.h b/gflib/sprite.h
index 9753837fd..c9ba9585d 100644
--- a/gflib/sprite.h
+++ b/gflib/sprite.h
@@ -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;