Added Module: ExpGamingCore.Gui

modules/ExpGamingCore/Gui/src/toolbar.lua

@@ -0,0 +1,47 @@
+--- Adds a toolbar to the top left of the screen
+-- @module ExpGamingCore.Gui.Toolbar
+-- @alias toolbar
+-- @author Cooldude2606
+-- @license https://github.com/explosivegaming/scenario/blob/master/LICENSE
+
+--- This is a submodule of ExpGamingCore.Gui but for ldoc reasons it is under its own module
+-- @function _comment
+
+local toolbar = {}
+
+--- Add a button to the toolbar, ranks need to be allowed to use these buttons if ranks is preset
+-- @usage toolbar.add('foo','Foo','Test',function() game.print('test') end)
+-- @tparam string name the name of the button
+-- @tparam string caption can be a sprite path or text to show
+-- @tparam string tooltip the help to show for the button
+-- @tparam function callback the function which is called on_click
+-- @treturn table the button object that was made
+function toolbar.add(name,caption,tooltip,callback)
+    verbose('Created Toolbar Button: '..name)
+    local button = Gui.inputs.add{type='button',name=name,caption=caption,tooltip=tooltip}
+    button:on_event(Gui.inputs.events.click,callback)
+    Gui.data('toolbar',name,button)
+    return button
+end
+
+--- Draws the toolbar for a certain player
+-- @usage toolbar.draw(1)
+-- @param player the player to draw the tool bar of
+function toolbar.draw(player)
+    local player = Game.get_player(player)
+    if not player then return end
+	local toolbar_frame = mod_gui.get_button_flow(player)
+    toolbar_frame.clear()
+    if not Gui.data.toolbar then return end
+    for name,button in pairs(Gui.data.toolbar) do
+        if is_type(Ranking,'table') and Ranking._presets and Ranking._presets().meta.rank_count > 0 then
+            local rank = Ranking.get_rank(player)
+            if rank:allowed(name) then
+                button:draw(toolbar_frame)
+            end
+        else button:draw(toolbar_frame) end
+	end
+end
+
+-- second return is join event and third is rank change event
+return toolbar, toolbar.draw, toolbar.draw