MouseCursors

This page should correctly be named "[MouseCursors]"; it is wrong due to technical restrictions.

Extension Version:	0.D+.
File(s):	rules(md).ini
This new INI section is part of Ares. Do not create it without Ares installed.

New cursors can be added and default cursors can be changed using the new [MouseCursors] section, which centralizes cursor definitions in one place. Each cursor has a name, which can then be used as valid value for tags asking for a mouse cursor. Cursors are defined in a single line with comma-separated values as follows:

[MouseCursors]→Name=Frame,Count,Interval,MiniFrame,MiniCount,HotSpotX,HotSpotY

If fewer items are defined, the remaining values are defaulted.

1. Frame is the starting frame of the cursor from mouse.sha. The first frame is 0.
   • Defaults to 0.
2. Count is the number of frames in the animated cursor.
   • Defaults to 1.
3. Interval is the rate to animate the cursor.
   • Defaults to 0.
4. MiniFrame is like Frame, except this is for the mouse cursor when positioned on the minimap. Set this to -1 to disable the minimap cursor and to only allow players to click on the battlefield.
   • Defaults to -1.
5. MiniCount is like Count, except this is for the mouse cursor when positioned on the minimap.
   • Defaults to -1.
6. HotSpot specifies the point from which the click event will handled.
   • HotSpotX should be one of Left, Center or Right.
   • HotSpotY should be one of Top, Middle or Bottom.
     • For example, Left,Top will treat the top-left corner of the cursor as the tip.
   • Default is Left,Top.

Notes

You cannot directly use the same definitions as used with other patches for Yuri's Revenge, because Ares uses descriptive names instead of numbers for the HotSpotX,HotSpotY parts.

To convert the values

numbers	HotSpotX names	HotSpotY names
0	Left	Top
12345	Center	Middle
54321	Right	Bottom

In vanilla, the refresh interval for cursor rendering is 16 milliseconds.

• Starting from Phobos Build#49, in order to update the cursor more timely, this interval has been changed to 1 millisecond.

References

The original game’s cursors are defined implicitly, that is, they exist and are available even without them being explicitly defined. See the list of default cursors.

Ares adds several new named cursors by default, which are used for special purposes like newly added features, or to distinguish different unit actions. Refer to Ares documentation