Skip to content

menubutton

Thomas edited this page May 31, 2020 · 2 revisions

obj_uiZ_menubutton

A button showing the user a mousemenu when pressed. This requires a ds_list to be used, which cannot be set trough the designer and MUST be set trough code using the variable dslist. Can draw some optional text.

Settings

  • dslist[-1]: Which ds list to use for the menu. Each item in this ds_list will be one item inside inside the menu. The list can contain both strings and reals.
  • actionlist[-1]: A ds list that holds references to scripts that will be executed when the corresponding item in the menu has been clicked. See mousemenu for more info.
  • enabledlist[-1]: A list which should contain booleans which specify if an item in the mouse list is either enabled or disabled. See mousemenu for more info.
  • menutemplate[-1]: Set to a script which can act to change the style of the mousemenu if you desire this. One argument will be passed which is the instance id of the menuobject. Leave at -1 for no script and the default look of the mousemenu.
  • text[""]: What text to draw on the center of the button. Leave this empty if you don't want text.
  • textcolor[c_black]: The color text should have.
  • font[-1]: The font to use, a value of -1 means font will be ignored.

This object has a background, and all it's associated variables about which you can learn more here

These default background values are used in this object: texturescript = uiz_back_sprite
texturescript_over = -1
texturescript_in = -1
texturescript_out = -1

sprite_normal = spr_uiZ_menudots
color_normal = c_white
margin_normal = 0
sprite_texturemode = uiz_texturemode_fill
border_texturemode = -1

sprite_over = -1
color_over = c_ltgray
margin_over = -1

sprite_in = -1
color_in = c_gray
margin_in = -1

sprite_out = -1
color_out = c_dkgray
margin_out = -1

Functions

  • uiz_mousebutton_setlist(instanceid,list,actionlist,enabledlist):
    • instanceid: the instance id of the instance you want to modify
    • list[-1]: Which ds list to use for the menu. Each item in this ds_list will be one item inside inside the menu. The list can contain both strings and reals.
    • actionlist[-1]: A ds list that holds references to scripts that will be executed when the corresponding item in the menu has been clicked. See mousemenu for more info.
    • enabledlist[-1]: A list which should contain booleans which specify if an item in the mouse list is either enabled or disabled. See mousemenu for more info.
  • uiz_mousebutton_settext(instanceid,text):
    • instanceid: the instance id of the instance you want to modify
    • text[""]: What text to draw on the center of the button. Set this to a blank string if you don't want text.
  • uiz_mousebutton_settextsettings(instanceid,color,font):
    • instanceid: the instance id of the instance you want to modify
    • color[c_black]: The color text should have.
    • font[-1]: The font to use, a value of -1 means font will be ignored.
  • uiz_mousebutton_setmenutemplate(instanceid,menutemplate):
    • menutemplate[-1]: Set to a script which can act to change the style of the mousemenu if you desire this. One argument will be passed which is the instance id of the menuobject. Leave at -1 for no script and the default look of the mousemenu.

Readable variables

  • meunuis: Whether the item selection menu is showing right now.
  • update: True whenever the user has clicked the button to open the menu.
  • updated: True whenever the user has clicked an item in the menu.
  • selected: The ds list position of the item that has been clicked in the menu. (only usable while updated is set to true)

Visuals

Wiki pages

🏑Home / General
πŸ“ƒTutorials
πŸ‘ͺ Parent
↕️ Positioning
πŸ›  Fixing & Updating
πŸ• Depth
πŸ“ƒ Templates and Examples
πŸŒ† Background
πŸ“‡ 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


🎈 Your own objects
🚫 Destroy
🐭 Mouse
πŸ’» Windows (uiz)
🌌 Animations
❓ General
πŸ“’ Numbers
πŸ“’ Strings
✏️ Draw
🚩 Popup
πŸ“‚ Files
πŸ’» Windows (os)

Clone this wiki locally