This scripted item highlights combos that have with secrets attached to them, primarily Screen Secrets and Special Items, by drawing a specified sprite when the player approaches within a specified distance of them. This takes screen states like secrets and special items into account. This also detects combos whose triggers trigger Screen Secrets or drop items linked to the Special Item room state.

NOTES:
Place CF_SENSORRINGHINT to highlight any arbitary combo and place CF_NOSENSORRING onto any combos with secrets attached that you don't want the ring to highlight.
The script is not set up to detect secrets on FFCs. You cannot force them to show secrets with CF_SENSORRINGHINT.
Chest combos are not highlighted by default due to how they're usually dead visible on the screen. If you need them to be highlighted, you can place CF_SENSORRINGHINT onto the chest combo.

REQUIRES std.zh TO BE IMPORTED


Setting up the Script and Item:

• Import the script. Adjust your settings, found under the SETTINGS section, accordingly. Then compile.
• Enable the Quest Script Rule "Item Scripts Continue To Run", found under ZScript->Quest Script Settings->Script.
• Setting up the item:
  Set the flag "Constant Script". This is vital to ensure the script continues to run for this item in the background.
  Set Attributes[0] to the range, in pixels, which the item will highlight secrets in.
  Set Sprites[0] to the sprite drawn to highlight the secrets.
• Have fun.

Defining the Itemclass (Optional, but Recommended):
To define an itemclass for the Sensor Rings, copy-paste the strings in the following code blocks into an unused Itemclass entry (ie. zz###) in Quest->ZInfo.

Itemclass Name:

Sensor Rings

Itemclass Description:

Scripted. Draws sparkles over combos that hide secrets. Use CF_SENSORRINGHINT to place arbitary hints, use CF_NOSENSORRING to prevent the Sensor Rings from highlighting combos. Read the Script File for more information.

The caveat to this in versions prior to 2.55.2 is that there is a bug fixed in 2.55.2 that causes the ZC editor will crash if you renter the ZInfo dialogue after exiting the it while hovering over a custom entry (itemclass mostly) that has a long description like this one. To avoid this crash, scroll to a shorter custom entry or scroll to a default entry.