{"id":4204,"date":"2020-12-27T16:38:54","date_gmt":"2020-12-27T08:38:54","guid":{"rendered":"https:\/\/www.gridsagegames.com\/blog\/?p=4204"},"modified":"2021-04-06T16:52:13","modified_gmt":"2021-04-06T08:52:13","slug":"item-searching-filtering","status":"publish","type":"post","link":"https:\/\/www.gridsagegames.com\/blog\/2020\/12\/item-searching-filtering\/","title":{"rendered":"Item Searching and Filtering"},"content":{"rendered":"

Many years ago,\u00a0Cogmind’s predecessor X@COM<\/a> pioneered the idea of using a pop-up label system in an ASCII game to identify objects like items, beneficial both to help teach new players as well as a natural quality of life improvement. This allows players to more quickly know exactly what an item is, useful when there are otherwise few ways to depict differences beyond the typical character and color options. Labels can appear in various situations such as automatically when new items come into view, when a specific item needs to be pointed out for some reason, or when the player wants to label everything at once.<\/p>\n

\"xcomrl_labels_demo_items\"<\/a>

An early demo of X@COM’s item label system, where ground items appear in gray, and soldier-held items in green. Weapons can also use color coding to differentiate their amount of remaining ammo.<\/p><\/div>\n

\"xcomrl_labels_demo_units\"<\/a>

Using the same system to label soldiers and visible aliens. Soldier labels can be color-coded by remaining health.<\/p><\/div>\n

As a descendant of X@COM, Cogmind also shares this important feature, but by necessity has since expanded it even further. Particularly in Cogmind it’s not uncommon to have a huge number of items visible at once across the map, or even within a small area, so what do we do in cases where there’s a ridiculous number of labels all over the place?<\/p>\n

In X@COM one of the first things I did (because it was easy :P) is allow item labels to overlap one another but randomly shuffle their z-order over time so that labels on the bottom would at least have a chance to be completely visible at some point while observing them. Not ideal, but worked okay.<\/p>\n

Cogmind doesn’t do that, but does color code labels to make it easier to focus on different item properties, or easier to find whatever the player might be searching for at the time. And even more useful for avoiding overlap, Cogmind allows labels to extend out from an object in any one of six different directions, ensuring that more of the labels are likely to be completely visible when multiple objects are near one another. Early on, labels also started to carry useful extra bits of info that don’t take up much room, like an item’s rating, and whether it’s of a type the player has never used before (in case they’d like to collect it for their gallery).<\/p>\n

\"cogmind_item_label_concept_integrity_color_labels\"<\/a>

The original 2017 demo for when Cogmind’s item label system was switched over to coloration by integrity (the new default).<\/p><\/div>\n

Labels were later updated to include even an item’s current integrity if<\/em> damaged.<\/em><\/p>\n

None of this helps with the sheer number of labels, however, which can be significant, so we ideally need ways to manage that as well, ways I’ve gradually been adding over the years…<\/p>\n

Automatic Item Filter Settings<\/h1>\n

To start tackling the excessive label issue, at least with a few simple tweaks as a start, back in 2018 with Beta 5<\/a> I added some adjustable filters to automatically exclude some items from being labeled.<\/p>\n

So-called “mass labeling” of items (manually labeling all items at once) would become a two-stage process, where the first attempt would ignore all faulty items, broken items, heavily-damaged items, or those with low ratings relative to the current depth--basically those things which players are much less likely to be looking for at any given time. Attempting to label items again<\/em> within a short duration would label everything<\/em>, regardless of these filter settings. All such automatic filters can be tweaked in the options for players who want to adjust their behavior, or turn them off completely.<\/p>\n

\"cogmind_item_label_filters\"<\/a>

Demonstration of automatic filtering of item labels for those heavily-damaged by an explosion. Notice a quick subsequent call for labels will include them anyway, making it possible to have two levels of detail via the same command.<\/p><\/div>\n

This doesn’t go nearly far enough in terms of mitigating all of the excessive label situations, but it’s a good start and definitely helpful.<\/p>\n

Manual Item Category Filters<\/h1>\n

At the highest level there are five main categories of items, corresponding to the four types of slots items can be attached to, plus non-part items. And it’s a fairly frequent need to find an item of a particular category, for example propulsion when you’re literally on your “last legs” (or worse xD), or just any old power source when you’ve lost (or are about to lose) your last one and can foresee an impending energy crisis, or any number of other more nuanced situations.<\/p>\n

As such, limiting the labels to only those items belonging to a particular category is an effective way to vastly reduce their number and make it easier to quickly see what nearby relevant options are available.<\/p>\n

For this purpose I’ve more recently added the ability to cycle through the various categories while item labels are open, automatically reopening them and applying the new category.<\/p>\n

\"cogmind_item_label_category_filtering\"<\/a>

Filtering item labels by category.<\/p><\/div>\n

The cycling sequence switches between all items -> power sources -> propulsion -> utilities -> weapons -> non-part items (there are three different sets of key options for this interaction, each of which can be reversed as well). Not opening any labels for ten seconds resets the system back to “all items ” again.<\/p>\n

Automatic label filter settings are also applied in these modes, and can be overridden by calling labels a second time as usual (the demo above includes example of this, with the weapons and utilities).<\/p>\n

Item Searching<\/h1>\n

Automated and\/or simple solutions are nice, but sometimes we need to pull out… the big guns of the item-seeking world: full-featured search. For this I built a more powerful system capable of both filtering and searching through all known items across the entire map according to a range of customizable criteria.<\/p>\n

Now this new dedicated interface is going to be overkill if just checking out a handful of items scattered around in the local area, but sometimes in Cogmind you might encounter a huge war, or maybe you’re just a deadly and determined Cogmind rampaging across a map where there’s no cleanup crew (or they simply can’t keep up with you :P), and the map becomes littered with a mess of salvageable items.<\/p>\n

\"cogmind_pimski_access_farm_destruction\"<\/a>

Looking through a mess like this could be challenging even with a robust labeling system :P<\/p><\/div>\n

\"cogmind_zxc_access_destruction\"<\/a>

Another example of wide-scale destruction from running battles in a late-game map, this one in ASCII.<\/p><\/div>\n

There might be parts you want in there, but it can take a little while to sort through them. And although with experience the process gets faster, why not make it fast for everyone, and vastly increase the speed of doing so, by allowing the player to describe specifically what they want, or at least some aspect(s) of it.<\/p>\n

Activating the new search feature opens a window over the right side of the HUD initially listing all known items:<\/p>\n

\"cogmind_item_search_ui\"<\/a>

Item search window showing a list of nearby items.<\/p><\/div>\n

Items in the list are ordered by their current direct distance from your position, near to far, not taking into account walls or available paths (this is a more meaningful approach in Cogmind, since terrain destruction and making your own paths where helpful is common practice). Those items currently within Cogmind’s FOV display their distance in blue, whereas those outside FOV display it in a shade of gray depending on distance. To the right of each item is its last known integrity, if available.<\/p>\n

Once in this mode, simply typing enters text into the Search bar, where the most basic filter is text which must be found in the item name. For example “Imp” will list all items with the Imp. prefix, but technically also include “Impulse Thruster” (unless a period is added, of course, to search for “Imp.”).<\/p>\n

\"cogmind_item_search_ui_demo_text\"<\/a>

Searching for items via text.<\/p><\/div>\n

Combine separate strings (requiring all of them to be present, but not consecutive) by using a comma. For example searching for for “par,char” would return any Particle Chargers. (Searches are not case sensitive.)<\/p>\n

As usual, standard text editing commands are available, such as the Delete key, Arrows to move the cursor, and Ctrl-Backspace to erase the current text. The Enter key also simply resets the current search.<\/p>\n

This interface is an easy way to look for very specific items, or quickly find the precise location of an item you remember to be somewhere on the map, because the list items are also interactive! Clicking on an item name (or using Ctrl-a~z) both centers the map view on it and highlights the shortest known path to reach that position:<\/p>\n

\"cogmind_item_search_ui_demo_centering\"<\/a>

Centering on items via the search interface, also highlighting the path to reach them.<\/p><\/div>\n

Double-clicking (or repeating the keyboard command) will then also automatically move to that item.<\/p>\n

\"cogmind_item_search_ui_demo_pathfinding\"<\/a>

Using the item search interface to path to a desired target.<\/p><\/div>\n

But the item search feature is about more than just names--it’s made much more powerful with support for specifying other required properties.<\/p>\n

Special filters are available using the period prefix. For example “.power” will list all items that count as parts equippable to a power slot, or “.treads” will list all tread items. Generally only the first few letters are actually required to specify a particular filter, as indicated in the reference list below, but the full word is fine as well.<\/p>\n

\"cogmind_item_search_filters_manual\"<\/a>

The current list of special filters for item searching, as found in the manual.<\/p><\/div>\n

Multiple special filters can be combined with one another, as well as used alongside name filters if desired, again using a comma to delineate separate filters. For example “rifle,.th” would list any items with “rifle” in the name which are also capable of dealing thermal damage. Or “.hov,5,70%” would list all hover propulsion of at least rating 5 with a minimum of 70% current integrity.<\/p>\n

\"cogmind_item_search_ui_demo_filters\"<\/a>

Applying various filters to the item search list.<\/p><\/div>\n

Under the search UI the extra space in the HUD is filled with a persistent list of helpful commands as a teaching tool and reminder:<\/p>\n

\"cogmind_item_search_ui_help\"<\/a>

Search UI help text.<\/p><\/div>\n

For most cases I imagine the manual item category filters for mass labeling will generally be more useful since backtracking is not something a lot of builds want to do in Cogmind, and you’re generally trying to browse a low to medium amount of nearby parts anyway, but there are definitely some cases where a more powerful search feature will come in handy, so I decided to add both :)<\/p>\n","protected":false},"excerpt":{"rendered":"

Many years ago,\u00a0Cogmind’s predecessor X@COM pioneered the idea of using a pop-up label system in an ASCII game to identify objects like items, beneficial both to help teach new players as well as a natural quality of life improvement. This allows players to more quickly know exactly what an item is, useful when there are […]<\/p>\n","protected":false},"author":2,"featured_media":4216,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[27],"tags":[140,4,13],"class_list":["post-4204","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-gui","tag-accessibility","tag-cogmind","tag-ui"],"_links":{"self":[{"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/posts\/4204","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/comments?post=4204"}],"version-history":[{"count":14,"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/posts\/4204\/revisions"}],"predecessor-version":[{"id":4364,"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/posts\/4204\/revisions\/4364"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/media\/4216"}],"wp:attachment":[{"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/media?parent=4204"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/categories?post=4204"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.gridsagegames.com\/blog\/wp-json\/wp\/v2\/tags?post=4204"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}