EVENT DISPLAYPOINTER: Difference between revisions

Latest revision as of 06:15, 4 February 2022

Event ID	player#	THISACTOR	RETURN
EVENT_DISPLAYPOINTER	screenpeek	player->i	3 values

EVENT_DISPLAYPOINTER is a Game Event.

This event is called when the Wii port cursor for aiming is being displayed.

Gamevar RETURN is set to the pointer's picnum. Modifying this value will change the tile that is displayed.

Setting RETURN to -1 disables hardcoded drawing of the cursor completely.

It is possible to change the tile, as well as the position of the pointer.

userdef.return 0 (RETURN): Set to the crosshair picnum, default is 2523. Change this to alter the pointer sprite displayed onscreen.

@@ Line 1: / Line 1: @@
+{{EventTable|1=EVENT_DISPLAYPOINTER|2=[[screenpeek]]|3=[[i|player->i]]|4=3 values}}
 '''EVENT_DISPLAYPOINTER''' is a [[EDuke32 event list|Game Event]].
 This [[event]] is called when the [[EDuke32 Wii|Wii]] port cursor for aiming 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.
+Gamevar [[RETURN]] is set to the pointer's [[picnum]]. Modifying this value will change the tile that is displayed.
+Setting RETURN to -1 disables hardcoded drawing of the cursor completely.
 See also [[EVENT_DISPLAYCROSSHAIR]].
+== Return Values ==
+It is possible to change the tile, as well as the position of the pointer.
+:; userdef.return 0 ([[RETURN]])
+:: Set to the crosshair picnum, default is 2523. Change this to alter the pointer sprite displayed onscreen.
+:; userdef.return 1
+:: Contains the x-position of the pointer.
+:; userdef.return 2
+:: Contains the y-position of the pointer.
 [[Category:Events]]