HintsHighlight is a module for AGS (Advanture Game Studio) engine.
This module adds an overlay which highlights all the visible and clickable objects, hotspots and charactes.
After adding this module to a game, players can use this features when they wish to avoid "pixel hunting" and need a hint to progress with the game.
ExampleSierra-style template. All rights for the shown art are reserved for the respective artists.
There are three ways of adding this module to a project. This list is ordered by increasing complexity:
- Import an
.scmfile ("Explore Project -> Right Click on Scripts -> Import Script.... Get it from the Releases section on Github.
- Create an empty script called HintsHighlight through engines interface, download the source from this repository and finally copy the downloaded script over the empty one.
- Create an empty script called HintsHighlight through engines interface and delete it from windows explorer, clone this repository, create a hard link from the cloned files to your games folder.
The basic functionality of the module does not require any additional changes. Run the game and press the default key (
KEY_FOR_DISPLAYING_HINTS, currently is set to
SPACE) to see the hints.
There are several configurable options that can be tweaked in the top of module's
The the highest ID of a hotspot in the room. This is required because a static allocation for data in this module. To disable hints on hotspots, set this to 0.
The the highest ID of a character in the game. This is required because a static allocation for data in this module. To disable hints on charaters, set this to 0.
The the highest ID of an object. This is required because a static allocation for data in this module. To disable hints on objects, set this to 0.
IMPORTANT: This value should always be the sum of
If this condition is not met, the module will crash the game on startup to prevent array out of bounds access.
Which shape to use for hints. Can be
eHintMixed is selected, each shape is determined individually with the help of
HINT_SHAPE_TO_USE is set to
eHintMixed, this will be the ratio used for deciding
which shape to use.
If the width/height or height/width of the area is larger than this
defined value, then a rectangle will be used, otherwise, a circle.
The thickness of the highlight shape.
Padding to add around objects/hotspots/characters in pixels.
The color of the highlight shape.
The default is
Game.GetColorFromRGB(Random(255), Random(255), Random(255)) which randimizes the color of each highlight.
To prevent highlights that are too small, it is possible to define minimal size. If the shape is smaller that that size, it's size will be increased. For circles, size represents the diameter of the circle in pixels. For rectangles, each of the edges will be increased seperatly and size represnts the length of the edges in pixels.
If this parameter set to
true, the user of the module is responsible for
calling the module's interface functions for calculating and displaying hints.
Which key is bound to overlay displaying.
Used only when USE_CUSTOM_HANDLING is set to