mouse

Mouse in General

Uiz has some controlling mouse scripts. Some of these scripts are called every step for "obj_uiZ_" objects. They make sure that when the mouse hovers over an object, that only the frontmost object is selected to receive a signal that says "Hey, you the mouse is on you!".

Normally, we would have a mouse check in every object without uiz, and we would put the mouse over it, the object could run some code. This works for all objects individually. But if we have 2 objects overlapping each other, both objects might fire an event if the mouse is over it, while the user only intended one to be pressed. Uiz eliminates this problem by checking depth.

There are four global variables: "global.mouseoverobject", "global.mouseoverframe", "global.mouseoverwindow" and "global.mouseover".

• The "global.mouseover" variable works for all uiz objects and returns the one with the lowest depth at the place of the mouse.
• The "global.mouseoverframe" variable works only for frames and returns the one with the lowest depth at the place of the mouse.
• The "global.mouseoverwindow" variable works only for windows and returns the one with the lowest depth at the place of the mouse.
• The "global.mouseoverobject" variable works for all uiz objects except frames and returns the one with the lowest depth at the place of the mouse.
• The normal mouseover variable is going to be the most useful to you, and is recommended to use in normal objects.

Common checks

Almost every uiz object has an uiz_mouse_docheck() script in its User Defined 1 Event. This script contains all of the important checks to be done for the mouse. This script has been put into an event for legacy reasons, and so that custom code can be written for when the mouse should or shouldn't be handled by your object.

Every object has their kmouseover variable calculated and set. This value holds the state of the mouse in relation to the instance in question.

• A kmouseover of uiz_nomouse=0 means no interaction between the mouse or the instance.
• A kmouseover of uiz_mouseover=1 means the mouse is hovering over the instance.
• A kmouseover of uiz_mouseclick=2 means the mouse is hovering over the instance and the left mouse button is being held.
• A kmouseover of uiz_mousepressed=3 means the mouse is hovering over the instance and the left mouse button has just been pressed.
• A kmouseover of uiz_mousereleased=4 means the mouse is hovering over the instance and the left mouse button has just been released.

freezing the mouse

See freezing the mouse.

Custom mouse sprites

Uiz sometime needs to change the mouse to something like a hand when the mouse hovers over a button. However, in your game you might have different sprites for your mouse. Therefore the script uiz_set_cursor(constant) was made. It takes the same constants such as "window_set_cursor" (refer to game maker manual).
You can set a type of sprite for each constants using: global.uiz_cr_constanct_name.
Uiz reset the mouse to cr_default in the beginning of every step. See uiz_set_cursor(constant) for more info.