Added progress bar

expcore/gui.lua

@@ -72,5 +72,6 @@ Gui.require_concept('button')
 Gui.require_concept('checkbox')
 Gui.require_concept('dropdown')
 Gui.require_concept('elem_button')
+Gui.require_concept('progress_bar')
 
 return Gui

expcore/gui/concepts/elem_button.lua

@@ -12,7 +12,7 @@ local Gui = require 'expcore.gui.core'
 @tparam string elem_type the type of elem selection that this is, default is item selection
 @usage-- Making a basic elem button
 local basic_elem_button =
-Gui.clone_concept('elem_button',TEST 'basic_elembutton')
+Gui.clone_concept('elem_button','basic_elembutton')
 :on_selection_change(function(event)
     event.player.print('Basic elem button is now: '..event.element.elem_value)
 end)

expcore/gui/concepts/frame.lua

@@ -8,6 +8,7 @@ local Gui = require 'expcore.gui.core'
 --[[-- The basic frame element
 @element frame
 @tparam ?string|Concepts.LocalisedString title the title that will show in the frame
+@tparam string direction the direction that children will be added
 @usage-- Making a basic frame, contains a label with hello world
 local basic_frame =
 Gui.clone_concept('dropdown','basic_frame')
@@ -21,11 +22,13 @@ end)
 ]]
 Gui.new_concept('frame')
 :new_property('title')
+:new_property('direction')
 :define_draw(function(properties,parent,element)
     element = parent.add{
         name = properties.name,
         type = 'frame',
-        caption = properties.title
+        caption = properties.title,
+        direction = properties.direction
     }
 
     return element

expcore/gui/concepts/progress_bar.lua

@@ -0,0 +1,155 @@
+--[[-- Core Module - Gui
+    @module Gui
+    @alias Gui
+]]
+
+local Gui = require 'expcore.gui.core'
+
+--[[-- The basic checkbox element
+@element progress_bar
+@param on_completion fired when increment reaches the maxium value set by set_maximum
+@tparam ?string|Concepts.LocalisedString tooltip the tooltip that will show for this element
+@tparam number maximum the maxium amount an instance can be increased, default 100
+@tparam boolean delay_completion when true the progress will be completed untill after the maximum rather than at the maximum
+@tparam boolean inverted although this will NOT effect how you use the functions it will make the element start full and reduce as you call increase, note issues with 0 detections
+@usage-- Making a basic progress bar, will increase when pressed then will reset when full
+local basic_progress_bar =
+Gui.clone_concept('progress_bar','basic_progress_bar')
+:set_tooltip('Basic progress bar')
+:set_maximum(5)
+:new_event('on_click',defines.events.on_gui_click)
+:on_click(function(event)
+    event.concept:increment(event.element)
+end)
+:set_delay_completion(true)
+:on_completion(function(event)
+    event.concept:reset(event.element)
+end)
+]]
+local progress_bar =
+Gui.new_concept('progress_bar')
+:new_event('on_completion')
+:new_property('tooltip')
+:new_property('maximum',100)
+:new_property('delay_completion',false)
+:new_property('inverted',false)
+:define_draw(function(properties,parent,element)
+    element = parent.add{
+        name = properties.name,
+        tooltip = properties.tooltip,
+        type = 'progressbar',
+        value = properties.inverted and 1 or 0
+    }
+
+    return element
+end)
+
+--- Progress Bars.
+-- functions used with progress bars
+-- @section progress_bars
+
+-- logic for changing the value of a progress bar
+local function raw_update(concept,element,amount)
+    local old_value = element.value
+    local new_value = old_value + amount
+    element.value = new_value
+
+    local check_value = concept.properties.delay_completion and old_value or new_value
+    if amount < 0 and check_value <= 0 or amount > 0 and check_value >= 1 then
+        concept:raise_event('on_completion',{
+            element = element
+        })
+    else
+        return new_value
+
+    end
+
+end
+
+--[[-- Will increase the progress of a progress bar based on this concept, if the concept has an instance store then element acts as the category, if you have a combined store it will NOT update all instances
+@tparam ?LuaGuiElement|string element either the element that is changed or the category that is being changed (only if an instance store is defined)
+@tparam[opt=1] number amount the amount that will bar will increase, note that this amount must be less than the max
+@treturn ?number|nil the new value of the element, use this to sync a data store, if the return is nil then either a instance store was used or the new value may have changed
+@usage-- Incrementing progress bar with no instance store
+local new_value = progress_bar:increment(element)
+@usage-- Incrementing progress bar with an instance store
+progress_bar:increment(category)
+]]
+function progress_bar:increment(element,amount)
+    local properties = self.properties
+    local inverted = properties.inverted
+    local maximum = properties.maximum
+    amount = amount and amount/maximum or 1/maximum
+    amount = inverted and -amount or amount
+
+    if self.instance_store and not self.sync_instance then
+        self.update_instances(element,function(next_element)
+            raw_update(self,next_element,amount)
+        end)
+
+    else
+        return raw_update(self,element,amount)
+
+    end
+end
+
+--[[-- Will decrease the progress of a progress bar based on this concept, if the concept has an instance store then element acts as the category, if you have a combined store it will NOT update all instances
+@tparam ?LuaGuiElement|string element either the element that is changed or the category that is being changed (only if an instance store is defined)
+@tparam[opt=1] number amount the amount that will bar will decrease, note that this amount must be less than the max
+@treturn number the new value of the element, use this to sync a data store, if the return is nil then either a instance store was used or the new value may have changed
+@usage-- Decrementing progress bar with no instance store
+local new_value = progress_bar:decrement(element)
+@usage-- Decrementing progress bar with an instance store
+progress_bar:decrement(category)
+]]
+function progress_bar:decrement(element,amount)
+    self:increment(element,-amount)
+end
+
+--[[-- Resets the progress back to 0% for this element, if the concept has an instance store then element acts as the category, if you have a combined store it will NOT update all instances
+@tparam ?LuaGuiElement|string element either the element that is changed or the category that is being changed (only if an instance store is defined)
+@treturn ?number|nil the new value of the element, use this to sync a data store, if the return is nil then either a instance store was used or the new value may have changed
+@usage-- Reseting a progress bar with no instance store
+local new_value = progress_bar:reset(element)
+@usage-- Reseting a progress bar with an instance store
+progress_bar:reset(category)
+]]
+function progress_bar:reset(element)
+    local new_value = self.properties.inverted and 1 or 0
+    if self.instacne_store and not self.sync_instance then
+        self.update_instances(element,function(next_element)
+            next_element.value = new_value
+        end)
+
+    else
+        element.value = new_value
+        return new_value
+
+    end
+end
+
+--[[-- Increment any progress bar by the given percentage
+@tparam LuaGuiElement element the progress bar that you want to update
+@tparam[opt=0.01] number amount the percentage that you want to increment the progress bar by
+@treturn boolean true if the bar is now full
+@usage-- Increment any progress bar by 10%
+Gui.increment_progress_bar(element,0.1)
+]]
+function Gui.increment_progress_bar(element,amount)
+    amount = amount or 0.01
+    element.value = element.value + amount
+    return element.value >= 1
+end
+
+--[[-- Decrement any progress bar by the given percentage
+@tparam LuaGuiElement element the progress bar that you want to update
+@tparam[opt=0.01] number amount the percentage that you want to decrement the progress bar by
+@treturn boolean true if the bar is now empty
+@usage-- Decrement any progress bar by 10%
+Gui.decrement_progress_bar(element,0.1)
+]]
+function Gui.decrement_progress_bar(element,amount)
+    amount = amount or 0.01
+    element.value = element.value - amount
+    return element.value <= 0
+end

expcore/gui/prototype.lua

@@ -513,7 +513,7 @@ end)
             category = nil
         end
 
-        local instances = Store.get(self.instance_store,get_category(category))
+        local instances = Store.get(self.instance_store,get_category(category)) or {}
         for key,instance in pairs(instances) do
             if not instance or not instance.valid then
                 instances[key] = nil

expcore/gui/test.lua

@@ -353,4 +353,97 @@ tests['Elem Buttons'] = {
     ['Basic Elem Button'] = basic_elem_button,
     ['Defaut Selection Elem Button'] = default_selection_elem_button,
     ['Player Stored Elem Button'] = player_elem_button
+}
+
+--[[
+Progress Bars
+> Basic Progress Bar -- will increse when pressed, when full then it will reset
+> Inverted Progress Bar -- will increse when pressed, when empty then it will reset
+> Game Instance Progress Bar -- will take 5 seconds to fill, when full it will reset, note instances are required due to on_tick
+> Force Instance Progress Bar -- will increse when pressed, instance only means all instances will increse at same time but may not have the same value
+> Force Stored Progress Bar -- will increse when pressed, unlike above all will increse at same time and will have the same value
+]]
+
+local basic_progress_bar =
+Gui.clone_concept('progress_bar',TEST 'basic_progress_bar')
+:set_tooltip('Basic progress bar')
+:set_maximum(5)
+:new_event('on_click',defines.events.on_gui_click)
+:on_click(function(event)
+    event.concept:increment(event.element)
+end)
+:set_delay_completion(true)
+:on_completion(function(event)
+    event.concept:reset(event.element)
+end)
+
+local inverted_progress_bar =
+Gui.clone_concept('progress_bar',TEST 'inverted_progress_bar')
+:set_tooltip('Inverted progress bar')
+:set_inverted(true)
+:set_maximum(5)
+:new_event('on_click',defines.events.on_gui_click)
+:on_click(function(event)
+    event.concept:increment(event.element)
+end)
+:on_completion(function(event)
+    event.concept:reset(event.element)
+end)
+
+local game_progress_bar =
+Gui.clone_concept('progress_bar',TEST 'game_progress_bar')
+:set_tooltip('Game progress bar')
+:set_maximum(300)
+:new_event('on_tick',defines.events.on_tick)
+:on_tick(function(event)
+    event.concept:increment(event.element)
+end)
+:set_delay_completion(true)
+:on_completion(function(event)
+    event.concept:reset(event.element)
+end)
+:define_instance_store()
+
+local force_instance_progress_bar =
+Gui.clone_concept('progress_bar',TEST 'force_instance_progress_bar')
+:set_tooltip('Force instance progress bar')
+:set_maximum(5)
+:new_event('on_click',defines.events.on_gui_click)
+:on_click(function(event)
+    event.concept:increment(event.element)
+end)
+:set_delay_completion(true)
+:on_completion(function(event)
+    event.concept:reset(event.element)
+end)
+:define_instance_store(Gui.categorize_by_force)
+
+local force_stored_progress_bar =
+Gui.clone_concept('progress_bar',TEST 'force_stored_progress_bar')
+:set_tooltip('Force stored progress bar')
+:set_maximum(5)
+:new_event('on_click',defines.events.on_gui_click)
+:on_click(function(event)
+    local element = event.element
+    local concept = event.concept
+    local new_value = concept:increment(element)
+    if new_value then concept.set_data(element,new_value) end
+end)
+:set_delay_completion(true)
+:on_completion(function(event)
+    local element = event.element
+    local concept = event.concept
+    local new_value = concept:reset(element)
+    concept.set_data(element,new_value)
+end)
+:define_combined_store(Gui.categorize_by_force,function(element,value)
+    element.value = value or 0
+end)
+
+tests['Progress Bars'] = {
+    ['Basic Progress Bar'] = basic_progress_bar,
+    ['Inverted Progress Bar'] = inverted_progress_bar,
+    ['Game Instance Progress Bar'] = game_progress_bar,
+    ['Force Instance Progress Bar'] = force_instance_progress_bar,
+    ['Force Stored Progress Bar'] = force_stored_progress_bar
 }

expcore/store.lua

@@ -174,7 +174,7 @@ function Store.update(location,key,update_callback,...)
     local rtn
     if update_callback and type(update_callback) == 'function' then
         if args then
-            rtn = udpate_callback(value,key,unpack(args))
+            rtn = update_callback(value,key,unpack(args))
         else
             rtn = update_callback(value,key,...)
         end