Works like a treasure chest, but also displays rising item animatian, ala LttP and GameBoy Zelda games.
Originally this script made by Nimono, but this refactor, requested by SkyFlare, adds proper support for larger treasure chests, among other features.
Credit goes to Nimono for original script.
Update 23.07.2023 - fixed bug with temporary secrets
Update 30.05.2024 - Option for earthquake effect on opening chest.
Update 28.11.2024 - Option to hide enemy, insted of item in chest. If such chect is opened, the enemy will pop out in attempt to ambush hero. See updated setup instructions.
Update 19.02.2025 - More options for item HoldUp, quake effect stacks additively with current quake value.
Update 02.03.2026 - Open only 1 chest at time. This is needed to avoid indefinite screen freeze bug caused by simultaneously opening multiple GB chests placed one next to other.
SCREEN_D_GBCHEST_DATA: Which Screen->D[] to use to track the chests. Make sure to pick one not currently in use by other scripts!
GBCHEST_PRIZE_RENDER_TIMER //Time to render prize before acquisition, in frames.
GBCHEST_PRIZE_RENDER_SPEED //Rising speed of revealed item during display.
SPR_GBCHEST_ENEMY_SPAWN = 22;//Sprite to display, when enemy jumps out of chest.
SPR_GBCHEST_ENEMY_MERCY_INVINCIBILITY = 90;//Time, in frames, before enemy starts dealing collision damage after popping out of chest.
Place invisible FFC on top left corner of treasure chest. Set TileWidth and TileHeight to match chest size
D0 chestCombo: The starting combo for your chest. When chest is open, the script changes all combos overlapped by FFC to their next ones in combo data table. If left at 0, it uses combo underneath top left corner of FFC. Otherwise, it cannot be open, until combo underneath top left corner of FFC changes to combo, whose ID is stated in D0, usually via secrets.
D1 openSFX: Abs - What sound effect ID to play upon opening the chest. <0 - No Hold Up on item acquisition.
D2 receiveSFX: What sound to play upon receiving the item.
D3 itemID: The item to give to the player upon opening the chest. < 0 - ID of enemy to spawn instead. I. E. setting D3 to -87 will spawn a death knight out of opened chest.
D4 receiveMessage: Which message to display upon receiving the item. If D3 <0 -> enemy jump speed, in 100th of pixel per frame.
D5 itemDisplay: Whether or not to display the item rising from the chest. 0 = do not display, anything else = display.
D6 lockValue: Whether or not to have the chest be locked. 0 = no lock, 1 = regular key required; 2 = boss key required. Original script had no support for Magic Key, this script allows using Magic Key to unlock GB chests.
D7 Quake power on opening chest.
If you are using ghost.zh, find and un-comment SuspendGhostZHScripts() and ResumeGhostZHScripts(), so ghosted enemies won`t move during chest opening sequence.
