EVENT DISPLAYCURSOR: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
Mblackwell (talk | contribs)
Created page with "'''EVENT_DISPLAYCURSOR''' is a Game Event. This event is called when the menu cursor is being displayed. Gamevar RETURN is set to the cursor's..."
 
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''EVENT_DISPLAYCURSOR''' is a [[EDuke32 event list|Game Event]].
{{EventTable|1=EVENT_DISPLAYCURSOR|2=[[screenpeek]]|3=[[i|player->i]]|4=4 values}}
 
'''EVENT_DISPLAYCURSOR''' is a [[EDuke32 event list|menu event]].


This [[event]] is called when the menu cursor is being displayed.
This [[event]] is called when the menu cursor is being displayed.
Line 5: Line 7:
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.
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 [[userdef.return]] as an additional information array.
For this event, treat [[return_(userdef)]] as an additional information array.
== Return Values ==
== Return Values ==


:; userdef.return 0
:; userdef.return 0 ([[RETURN]])
:: Same as RETURN.
:: Set to the cursor's [[picnum]], which is 2523 (CROSSHAIR) by default.


:; userdef.return 1
:; userdef.return 1

Latest revision as of 08:12, 4 February 2022

Event ID player# THISACTOR RETURN
EVENT_DISPLAYCURSOR screenpeek player->i 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 (RETURN)
Set to the cursor's picnum, which is 2523 (CROSSHAIR) by default.
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.