EVENT DISPLAYCURSOR: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{EventTable|1=EVENT_DISPLAYCURSOR|2=Current Player|3=[[i|player->i]]|4=yes (4 values)}}
'''EVENT_DISPLAYCURSOR''' is a [[EDuke32 event list|menu event]].
'''EVENT_DISPLAYCURSOR''' is a [[EDuke32 event list|menu event]].



Revision as of 08:32, 5 August 2021

Event ID player# THISACTOR RETURN
EVENT_DISPLAYCURSOR Current Player player->i yes (4 values)

EVENT_DISPLAYCURSOR is a menu event.

This event is called when the menu cursor is being displayed.

Gamevar RETURN is set to the cursor's picnum. Modifying this value will allow the game to handle positioning duties itself, etc. Setting RETURN to -1 disables hardcoded drawing of the cursor completely.

For this event, treat return_(userdef) as an additional information array.

Return Values

userdef.return 0
Same as RETURN.
userdef.return 1
The X position of the cursor (16bit positioning).
userdef.return 2
The Y position of the cursor (16bit positioning).
userdef.return 3
The alpha transparency of the cursor (0-255).

Notes

If you use the above return values to display your own cursor, with new layers or sizes, OR orientation 2048 into your drawing command.