-
Notifications
You must be signed in to change notification settings - Fork 1
Basic Tutorial
(Updated as of v0.8) This page contains information that will tell you how to implement RadialMouseMenu into your mod.
(It will help to have some basic Lua knowledge.)
Usage can basically be summarized into the following steps:
- Setting up your menu information
- Creating your RadialMouseMenu object
- Receiving input from your RadialMouseMenu object
The first thing you need to know is how information is set up in RadialMouseMenu. The options you can include when setting up your menu object are as follows:
a. name (String: Unique identifier for this menu object. Mandatory.)
b. radius (Number: Size of the circle. Optional; defaults to 300.)
c. items (Table: Choices in your menu. See [Items].)
d. center_text* (HUD Text object data- this text appears in the middle of the radial and reflects the choice you are currently looking at. Optional; if not specified, looks like the example.)
e. bg* (HUD Bitmap object data- this image is the background of the radial menu which renders behind all other parts of the menu. Optional; if not specified, looks like the example.)
f. selector* (HUD Bitmap object data- this image is the arc that appears around the choice you are currently looking at. Optional; if not specified, looks like the example.)
g. arrow* (HUD Bitmap object data- this image is a little arrow that shows which angle around the circle your mouse is pointing at. Optional; if not specified, looks like the example.)
h. x (Number: horizontal menu position on screen. Optional; counts from center of screen)
i. y (Number: vertical menu position on screen. Optional; counts from center of screen)
*HUD object data follows the Panel data type; however, what you will be entering for these elements, if anything, will only need to be a table. The RadialMouseMenu class will handle the Panel creation for you, so you would only need to enter some settings. Again, these things are optional, and only need to be changed if you want to really customize the textures, icons, and appearances of this menu. Please see the example for a more thorough description.
The most important part of your menu object will be the choices in it, obviously. Each of these choices will be referred to as an "item." Almost everything else (except for name) can be ignored if you are okay with using my default appearances.
An item contains several subparts:
a. stay_open (Boolean: When this item is clicked: if stay_open is true, the menu does not close. Otherwise, if stay_open is false or not defined, the menu closes automatically when this item is clicked, allowing the user to click multiple items.)
b. callback (Function: When this item is clicked, the function callback is run. Optional; you may also use the Hooks method if you prefer! See Step 3.)
c. icon (HUD Panel bitmap data: The preview icon for this item. If this icon's data is not specified, it will be invisible.)
d. body (HUD Panel bitmap data: The "slice" image for this item. If this body's data is not specified, it will be invisible.)
You have just learned the components that RadialMouseMenu can accept. All you need to do now is assemble them in a certain format, and execute the code to create it.
Here is an example:
local items = {
{
name = "Hello", --the name of this item, as it will appear in the menu
icon = { --this is data that will be converted into a bitmap object
texture = tweak_data.hud_icons.ai_stopped.texture,
texture_rect = tweak_data.hud_icons.ai_stopped.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color.green
},
stay_open = true --the menu will not close when you click on this
},
{
name = "Need Meds!",
icon = {
texture = tweak_data.hud_icons.equipment_doctor_bag.texture,
texture_rect = tweak_data.hud_icons.equipment_doctor_bag.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color(1,0.5,0)
},
stay_open = true,
callback = callback(VoiceCommands,VoiceCommands,"play","v35")
},
{
name = "Need Ammo!",
icon = {
texture = tweak_data.hud_icons.equipment_ammo_bag.texture,
texture_rect = tweak_data.hud_icons.equipment_ammo_bag.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color.yellow
},
stay_open = true
},
{
name = "activate beast mode",
icon = {
texture = tweak_data.hud_icons.equipment_trip_mine.texture,
texture_rect = tweak_data.hud_icons.equipment_trip_mine.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color.green
},
stay_open = false,
callback = callback(Console,Console,"cmd_say","beast mode is active now thx")
},
{
name = "put on a shirt",
icon = {
texture = tweak_data.hud_icons.wp_scrubs.texture,
texture_rect = tweak_data.hud_icons.wp_scrubs.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color(0,1,1)
},
stay_open = false,
callback = callback(Console,Console,"cmd_say","sun's out guns out bro")
},
{
name = "use drill",
icon = {
texture = tweak_data.hud_icons.pd2_drill.texture,
texture_rect = tweak_data.hud_icons.pd2_drill.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color.blue
},
stay_open = true,
callback = callback(Console,Console,"cmd_say","broke-dick piece of shit drill")
},
{
name = "use ladder",
icon = {
texture = tweak_data.hud_icons.pd2_ladder.texture,
texture_rect = tweak_data.hud_icons.pd2_ladder.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color.purple
},
stay_open = true,
callback = callback(Console,Console,"cmd_say","ladder? i 'ardly even know 'er!")
},
{
name = "drink soda",
icon = {
texture = tweak_data.hud_icons.equipment_soda.texture,
texture_rect = tweak_data.hud_icons.equipment_soda.texture_rect,
layer = 3,
w = 16,
h = 16,
alpha = 0.7,
color = Color(0.9,0.1,0.1)
},
stay_open = true,
callback = callback(Console,Console,"cmd_say","refreshing!")
}
}
local params = {
name = "VoiceCommandsMenu",
radius = 200,
items = items
}
local foo = RadialMouseMenu:new(nil,params)
RadialMouseMenu is set up to return input in two different, non-exclusive ways:
a. Callbacks. (See Step 2, part b.) When your item is clicked, (if you have a callback function specified) this function will run. If you already have a function callback set up, or if these items have no numerical link (that is, their order in the circle is not related to their function at all) then you may want to use this callback method- however, this is only a minor case of code efficiency.
b. Hooks. When your item is clicked, it will call the Hook with id "radialmenu_selected_" .. name, where name is the name that you assigned to your menu in Step 1, part a. In this case, the number index of your item will be passed as an argument, so you may prefer to use this method if your items have a numerical link of some sort. However, like I said before, this is only a minor case of code efficiency, and in the end you can do whichever you like.