Blitz3D+ Command Reference

EventZ ( )

Parameters

None.

Description

Returns the z value of the current event - 0 for every built-in event.

Requires Extended language mode.

EventZ completes the event record alongside EventX and EventY, but no built-in event uses it: keys, mouse, gadgets, windows, menus, timers and application events all leave it at 0.

It exists as a spare payload slot for events you post yourself. HotKeyEvent lets you register a custom event with an ev_z value of your choosing, and EventZ is how the receiving loop reads it back - a third number to go with EventData, EventX and EventY when a shortcut needs to carry extra context.

The world editor shell sample shows the event loop this belongs to.

See also: EventX, EventY, EventData, EventID, HotKeyEvent.

Index