0007342: ?/'ing 'M' ante causes invalid tile index assert

From 908ea5636861aaf28b934dd89601be4f3c83de30 Mon Sep 17 00:00:00 2001 From: blackcustard <peterwicksstringfield@gmail.com> Date: Sun, 21 Jul 2013 16:10:02 -0500 Subject: [PATCH] Fix a tiles crash by disallowing look up of unspawnable monsters. The command /?M lets players look up monsters by name and description. Due to an oversight, _find_description in command.cc sometimes returned the dummy monster entries for sensed monsters (MONS_SENSED, MONS_SENSED_FRIENDLY, etc.). When _find_description finds more than one match, the matches are presented in a menu. On console, this was strange but functional. On tiles this resulted in a crash. The menu handling code in menu.cc expects that all monster tiles are stored in the texture (sprite sheet) player.png. The tiles for the sensed monster dummies are actually stored in main.png. When the menu attempted to draw itself, it would essentially look for the tile in the wrong place and trip this assertion in tile_player_info in rltiles/tiledef-player.cc: "ASSERT(idx >= TILE_MAIN_MAX && idx < TILEP_PLAYER_MAX)" Change: _find_description now filters out all M_CANT_SPAWN monsters from the results. The monsters with M_CANT_SPAWN are: M_PROGRAM_BUG (which was already being explicitly filtered), axed monsters who's data is being preserved for save compatibility (which were being implicitly filtered because they did not have descriptions), and base type monsters like MONS_DRAKE, MONS_MERGED_SLIME_CREATURE and MONS_PLAYER (which also lacked descriptions). --- crawl-ref/source/command.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/crawl-ref/source/command.cc b/crawl-ref/source/command.cc index 7258e3f..d01ebc6 100644 --- a/crawl-ref/source/command.cc +++ b/crawl-ref/source/command.cc @@ -932,8 +932,8 @@ static vector<string> _get_branch_keys() static bool _monster_filter(string key, string body) { - int mon_num = get_monster_by_name(key.c_str()); - return (mon_num == MONS_PROGRAM_BUG); + monster_type mon_num = get_monster_by_name(key.c_str()); + return mons_class_flag(mon_num, M_CANT_SPAWN); } static bool _spell_filter(string key, string body) -- 1.7.11.msysgit.1

Notes
(0023463) Grandiloquent Gentleman (reporter) 2013-07-16 06:09	Sorry Not ^f should be ?/ Please change title

(0023519) blackcustard (reporter) 2013-07-22 00:24 edited on: 2013-07-23 18:08	First of all it's Antaeus, not Anteus, and he has nothing to do with this bug. :p. Good guess though. The search for "ante" was hitting on "antenna" in the description for MONS_SENSED (the dummy monster used to represent a monster that you have detected with demonspawn antenna but cannot see). The commit message will explain the rest: Fix a tiles crash by disallowing look up of unspawnable monsters. The command /?m lets players look up monsters by name and description. Due to an oversight, _find_description in command.cc sometimes returned the dummy monster entries for sensed monsters (MONS_SENSED, MONS_SENSED_FRIENDLY, etc.). When _find_description finds more than one match, the matches are presented in a menu. On console, this was strange but functional. On tiles this resulted in a crash. The menu handling code in menu.cc expects that all monster tiles are stored in the texture (sprite sheet) player.png. The tiles for the sensed monster dummies are actually stored in main.png. When the menu attempted to draw itself, it would essentially look for the tile in the wrong place and trip this assertion in tile_player_info in rltiles/tiledef-player.cc: "ASSERT(idx >= TILE_MAIN_MAX && idx < TILEP_PLAYER_MAX)" Change: _find_description now filters out all M_CANT_SPAWN monsters from the results. The monsters with M_CANT_SPAWN are: M_PROGRAM_BUG (which was already being explicitly filtered), axed monsters who's data is being preserved for save compatibility (which were being implicitly filtered because they did not have descriptions), and base type monsters like MONS_DRAKE, MONS_MERGED_SLIME_CREATURE and MONS_PLAYER (which also lacked descriptions). So I fixed the bug, but there is still some ugliness: 1. When you get an exact match, but you also get a bunch of partial matches, you are presented with the exact match first and are shown the menu only if you press space. The description's footer is supposed to be "?This entry is an exact match for 'FOO'. To see non-exact matches, press space.". If the monster has an extended description, then the footer is supposed to be "Press '!' or Right-click to toggle between the overview and the extended description.". On tiles both footers appear. On console only the second does. 2. The menu driving code in menu.cc is responsible for knowing what texture(/sprite sheet) various tiles(/sprites) are stored in. EDIT: The menu code and the tiles code is really confusing and messy.

(0023522) Grandiloquent Gentleman (reporter) 2013-07-22 05:20	Yeah, I realised I had Misspelled Antaeus some time afterwards. Thanks!

(0023552) Kate (developer) 2013-07-25 04:11	Pushed, thanks for the patch!

Issue History
Date Modified	Username	Field	Change
2013-07-16 06:07	Grandiloquent Gentleman	New Issue
2013-07-16 06:09	Grandiloquent Gentleman	Note Added: 0023463
2013-07-16 12:45	Medar	Summary	^F'ing 'M' ante causes invalid tile index assert => ?/'ing 'M' ante causes invalid tile index assert
2013-07-22 00:24	blackcustard	Note Added: 0023519
2013-07-22 00:29	blackcustard	File Added: 0001-Fix-a-tiles-crash-by-disallowing-look-up-of-unspawna.patch
2013-07-22 05:20	Grandiloquent Gentleman	Note Added: 0023522
2013-07-23 18:08	blackcustard	Note Edited: 0023519
2013-07-25 04:11	Kate	Note Added: 0023552
2013-07-25 04:11	Kate	Status	new => resolved
2013-07-25 04:11	Kate	Fixed in Branch	=> 0.13 development branch
2013-07-25 04:11	Kate	Resolution	open => done
2013-07-25 04:11	Kate	Assigned To	=> Kate

Relationships