freezing

Freezing the mouse

You have to be EXTEMELY careful when freezing the mouse, not correctly unfreezing it can cause issues like the mouse not working anymore.

Sometimes and object needs to keep a hold of the mouse, even is the mouse is not over the object anymore. For example, sliding a slider all the way to the right might result in the mouse not being over the slider anymore. However in this example you would still want your slider to be in "move with the mouse"-mode. For this you need "mouse freezing".

Using uiz_mouse_freeze() (or setting the global.mousefrozen variable to true) removes all uiz mousechecks and makes sure that the "global.mouseover" variables aren't changed anymore. No uiz object (except the caller of _freeze()) will react to the mouse anymore.
The mouse needs to be unfrozen by calling uiz_mouse_unFreeze() (or by setting global.mousefrozen to false) when you're done.

If you have a hard time correctly unfreezing the mouse, or just want to be very sure, you can use "uiz_mouse_setMouseSafety()". This script needs to be called every step while the mouse should be frozen, and if it isn't called anymore then the mouse will automatically unfreeze. This safety feature will generate a warning and it is recommended that you fix your code instead of relying on this last resort.
Not calling the script at all will not result in your mouse being automatically unfrozen, only after calling this script once you need to keep calling if every step for the duration of your mouse freeze.

Functions

• uiz_mouse_freeze(): Freezes the mouse so no mouse variables can change any more.
• uiz_mouse_unFreeze(): Unfreezes the mouse so mouse variables can changed again by uiZ.
• uiz_mouse_setMouseSafety(): This is an optional script. If you do decide to use it, then it should be called every step. If it isn't called every step uiZ will unfreeze the mouse. This is added as a safety guard to prevent a mouse lock, where the mouse if frozen and no code is willing to unfreeze it because of a bug.
• frozen = uiz_mouse_isFrozen():
  • frozen: Returns whether the mouse is currently frozen on any object.
• frozen = uiz_mouse_isFrozen_on(instanceid):
  • frozen: Returns whether the mouse is currently frozen on a specific object.
  • instanceid: What specific object to check for.