-
Notifications
You must be signed in to change notification settings - Fork 2
mouse_ison
Returns whether the mouse is over a certain object. (only works for the object with the lowest depth, see mouse in general and depth) Has some variants that also check if a certain button has been pressed.
-
isOver = uiz_mouse_isOver(instanceid): Checks if the mouse is over any uiZ object.
- isOver: A boolean value for if the mouse is hovering over the object or not.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_pressingLeft(instanceid):
- return: Returns if the mouse is over any uiZ object and is pressing the left mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_pressingRight(instanceid):
- return: Returns if the mouse is over any uiZ object and is pressing the right mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_releasedLeft(instanceid):
- return: Returns if the mouse is over any uiZ object and has just released the left mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_releasedRight(instanceid):
- return: Returns if the mouse is over any uiZ object and has just released the right mouse button.
- instanceid: What instance to check the mouse for.
-
isOver = uiz_mouse_isOver_frame(instanceid): Checks if the mouse is over a obj_uiZ_frame or obj_uiZ_slideframe object.
- isOver: A boolean value for if the mouse is hovering over the frame or not. This returns true even when there is another non-frame object in front of the frame.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_frame_leftCheck(instanceid):
-
return: Returns the state of the mouse of a obj_uiZ_frame or obj_uiZ_slideframe object. These states are available:
- uiz_nomouse: The mouse is not clicking the frame nor hovering over it.
- uiz_mouseover: The mouse is hovering over the frame but not clicking it.
- uiz_mousepressed: The mouse is hovering over the frame and has just been clicked. (only counts for one single step)
- uiz_mouseclick: The mouse is hovering over the frame and holding the mouse button.
- uiz_mousereleased: The mouse is hovering over the frame and has just been released. (only counts for one single step)
- instanceid: What instance to check the mouse for.
-
return: Returns the state of the mouse of a obj_uiZ_frame or obj_uiZ_slideframe object. These states are available:
-
return = uiz_mouse_isOver_frame_pressingLeft(instanceid):
- return: Returns if the mouse is over a obj_uiZ_frame or obj_uiZ_slideframe object and is pressing the left mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_frame_pressingRight(instanceid):
- return: Returns if the mouse is over a obj_uiZ_frame or obj_uiZ_slideframe object and is pressing the right mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_frame_releasedLeft(instanceid):
- return: Returns if the mouse is over a obj_uiZ_frame or obj_uiZ_slideframe object and has just released the left mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_frame_releasedRight(instanceid):
- return: Returns if the mouse is over a obj_uiZ_frame or obj_uiZ_slideframe object and has just released the right mouse button.
- instanceid: What instance to check the mouse for.
-
isOver = uiz_mouse_isOver_object(instanceid): Checks if the mouse is over a non frame or window like object.
- isOver: A boolean value for if the mouse is hovering over the frame or not. This returns true even when there is another non-frame object in front of the frame.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_object_leftCheck(instanceid):
-
return: Returns the state of the mouse of a non frame or window like object. These states are available:
- uiz_nomouse: The mouse is not clicking the object nor hovering over it.
- uiz_mouseover: The mouse is hovering over the object but not clicking it.
- uiz_mousepressed: The mouse is hovering over the object and has just been clicked. (only counts for one single step)
- uiz_mouseclick: The mouse is hovering over the object and holding the mouse button.
- uiz_mousereleased: The mouse is hovering over the object and has just been released. (only counts for one single step)
- instanceid: What instance to check the mouse for.
-
return: Returns the state of the mouse of a non frame or window like object. These states are available:
-
return = uiz_mouse_isOver_object_pressingLeft(instanceid):
- return: Returns if the mouse is over a non frame or window like object and is pressing the left mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_object_pressingRight(instanceid):
- return: Returns if the mouse is over a non frame or window like object and is pressing the right mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_object_releasedLeft(instanceid):
- return: Returns if the mouse is over a non frame or window like object and has just released the left mouse button.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_object_releasedRight(instanceid):
- return: Returns if the mouse is over a non frame or window like object and has just released the right mouse button.
- instanceid: What instance to check the mouse for.
-
isOver = uiz_mouse_isOver_window(instanceid): Checks if the mouse is over a obj_uiZ_window object.
- isOver: A boolean value for if the mouse is hovering over the window or not. This returns true even when there is another non-window object in front of the window.
- instanceid: What instance to check the mouse for.
-
return = uiz_mouse_isOver_window_leftCheck(instanceid):
-
return: Returns the state of the mouse of a obj_uiZ_window object. These states are available:
- uiz_nomouse: The mouse is not clicking the window nor hovering over it.
- uiz_mouseover: The mouse is hovering over the window but not clicking it.
- uiz_mousepressed: The mouse is hovering over the window and has just been clicked. (only counts for one single step)
- uiz_mouseclick: The mouse is hovering over the window and holding the mouse button.
- uiz_mousereleased: The mouse is hovering over the window and has just been released. (only counts for one single step)
- instanceid: What instance to check the mouse for.
-
return: Returns the state of the mouse of a obj_uiZ_window object. These states are available:
-
return = uiz_mouse_isOver_window_pressingLeft(instanceid):
- return: Returns if the mouse is over a obj_uiZ_window object and is pressing the left mouse button.
- instanceid: What instance to check the mouse for.
πTutorials
Basics 1: Basic positioning
Basics 2: Parenting system
Basics 3: Advanced positioning
Basics 4: Advanced sizing and set point
Basics 5: Canvas and containment
Basics 6: Alpha and depth
Basics 7: Using the manual and Animations
Basics 8: Object backgrounds
Basics 9: Grids
Basics 10: Framesets
Basics 11: Windows
Basics 12: Scroll bars
βοΈ Positioning
π Depth
π Structures
π Objects
obj_uiZ_3waybutton
obj_uiZ_button
obj_uiZ_checkbox
obj_uiZ_clock
obj_uiZ_colorbox
obj_uiZ_cover
obj_uiZ_drawdslist
obj_uiZ_dropdown
obj_uiZ_easybutton
obj_uiZ_frame
obj_uiZ_framescrollbar
obj_uiZ_functionbar
obj_uiZ_gradientsquare
obj_uiZ_gradientroundrect
obj_uiZ_gridlist
obj_uiZ_huesquare
obj_uiZ_loadingbar
obj_uiZ_loadingcircle
obj_uiZ_menubutton
obj_uiZ_mousemenu
obj_uiZ_radiobox
obj_uiZ_rotator
obj_uiZ_slider
obj_uiZ_scrollbar
obj_uiZ_slider_2col
obj_uiZ_slickslider
obj_uiZ_slideframe
obj_uiZ_sprbutton
obj_uiZ_spriteanimationbutton
obj_uiZ_spritecounter
obj_uiZ_stringbox
obj_uiZ_sliderstruct
obj_uiZ_surfacecanvas
obj_uiZ_sprite
obj_uiZ_square
obj_uiZ_squarebutton
obj_uiZ_swipicon
obj_uiZ_switch
obj_uiZ_tabslider
obj_uiZ_tabs
obj_uiZ_treelist
obj_uiZ_text
obj_uiZ_text_background
obj_uiZ_textarea
obj_uiZ_valuebox
π Strings
uiz_addChar
uiz_changechar
uiz_charCanHaveAddon
uiz_returnCharAddon
uiz_charIsNumber
uiz_charIsNumberOrText
uiz_getlines
uiz_gettext_contained
uiz_gettextlines_contained
uiz_getValidVariableName
uiz_isSpaceChar
uiz_lastStringChars
uiz_removeChar
uiz_replaceChars_
uiz_string_copy
uiz_string_digits
uiz_string_format
uiz_string_fromReal
uiz_string_real_getFracLength
uiz_string_real_getIntLength
uiz_string_repeat
uiz_string_replace
uiz_string_pos_at
uiz_stringUntilNewline