diff --git a/docs/addons/Advanced-Start.html b/docs/addons/Advanced-Start.html index b51f20a5..f1689524 100644 --- a/docs/addons/Advanced-Start.html +++ b/docs/addons/Advanced-Start.html @@ -348,7 +348,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Chat-Popups.html b/docs/addons/Chat-Popups.html index fdb6a24b..e6749dcd 100644 --- a/docs/addons/Chat-Popups.html +++ b/docs/addons/Chat-Popups.html @@ -349,7 +349,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Chat-Reply.html b/docs/addons/Chat-Reply.html index 91b5fa1d..bf0b3043 100644 --- a/docs/addons/Chat-Reply.html +++ b/docs/addons/Chat-Reply.html @@ -376,7 +376,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Compilatron.html b/docs/addons/Compilatron.html index 889058f8..a0e1cfcf 100644 --- a/docs/addons/Compilatron.html +++ b/docs/addons/Compilatron.html @@ -585,7 +585,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Damage-Popups.html b/docs/addons/Damage-Popups.html index 99fe3f44..d0a30aa0 100644 --- a/docs/addons/Damage-Popups.html +++ b/docs/addons/Damage-Popups.html @@ -349,7 +349,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Death-Logger.html b/docs/addons/Death-Logger.html index 590c7e4b..1eefd356 100644 --- a/docs/addons/Death-Logger.html +++ b/docs/addons/Death-Logger.html @@ -404,7 +404,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Discord-Alerts.html b/docs/addons/Discord-Alerts.html index 3e22e16a..42c5fbd8 100644 --- a/docs/addons/Discord-Alerts.html +++ b/docs/addons/Discord-Alerts.html @@ -460,7 +460,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Player-Colours.html b/docs/addons/Player-Colours.html index 94b6590b..3081c6fa 100644 --- a/docs/addons/Player-Colours.html +++ b/docs/addons/Player-Colours.html @@ -404,7 +404,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Pollution-Grading.html b/docs/addons/Pollution-Grading.html index ed128319..9cca3b35 100644 --- a/docs/addons/Pollution-Grading.html +++ b/docs/addons/Pollution-Grading.html @@ -320,7 +320,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Scorched-Earth.html b/docs/addons/Scorched-Earth.html index 16ca5e5a..7024e35e 100644 --- a/docs/addons/Scorched-Earth.html +++ b/docs/addons/Scorched-Earth.html @@ -404,7 +404,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/addons/Spawn-Area.html b/docs/addons/Spawn-Area.html index d708d75a..8b23f8b4 100644 --- a/docs/addons/Spawn-Area.html +++ b/docs/addons/Spawn-Area.html @@ -376,7 +376,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Admin-Chat.html b/docs/commands/Admin-Chat.html index 7dc05f4a..50386c57 100644 --- a/docs/commands/Admin-Chat.html +++ b/docs/commands/Admin-Chat.html @@ -388,7 +388,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Bonus.html b/docs/commands/Bonus.html index 58ab06cc..99979a83 100644 --- a/docs/commands/Bonus.html +++ b/docs/commands/Bonus.html @@ -500,7 +500,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Cheat-Mode.html b/docs/commands/Cheat-Mode.html index 6873b6fd..05be743e 100644 --- a/docs/commands/Cheat-Mode.html +++ b/docs/commands/Cheat-Mode.html @@ -361,7 +361,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Clear-Inventory.html b/docs/commands/Clear-Inventory.html index c280d9eb..2632583e 100644 --- a/docs/commands/Clear-Inventory.html +++ b/docs/commands/Clear-Inventory.html @@ -388,7 +388,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Debug.html b/docs/commands/Debug.html index 6ebb7007..18b07c71 100644 --- a/docs/commands/Debug.html +++ b/docs/commands/Debug.html @@ -365,7 +365,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Find.html b/docs/commands/Find.html index e2cd0dcc..9dcfd43f 100644 --- a/docs/commands/Find.html +++ b/docs/commands/Find.html @@ -360,7 +360,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Help.html b/docs/commands/Help.html index cece090c..b7a7c97e 100644 --- a/docs/commands/Help.html +++ b/docs/commands/Help.html @@ -404,7 +404,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Home.html b/docs/commands/Home.html index 3c7a8205..2eaa26e9 100644 --- a/docs/commands/Home.html +++ b/docs/commands/Home.html @@ -458,7 +458,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Interface.html b/docs/commands/Interface.html index bba2600b..36f1fa37 100644 --- a/docs/commands/Interface.html +++ b/docs/commands/Interface.html @@ -416,7 +416,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Jail.html b/docs/commands/Jail.html index 43f5e5e8..0ef7ecfc 100644 --- a/docs/commands/Jail.html +++ b/docs/commands/Jail.html @@ -611,7 +611,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Kill.html b/docs/commands/Kill.html index fa88b477..186c5ea4 100644 --- a/docs/commands/Kill.html +++ b/docs/commands/Kill.html @@ -389,7 +389,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Me.html b/docs/commands/Me.html index 6865f47d..3157f4bb 100644 --- a/docs/commands/Me.html +++ b/docs/commands/Me.html @@ -360,7 +360,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Rainbow.html b/docs/commands/Rainbow.html index 4a57c50a..6a569356 100644 --- a/docs/commands/Rainbow.html +++ b/docs/commands/Rainbow.html @@ -388,7 +388,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Repair.html b/docs/commands/Repair.html index 0bce4305..e4b1efd1 100644 --- a/docs/commands/Repair.html +++ b/docs/commands/Repair.html @@ -321,7 +321,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Reports.html b/docs/commands/Reports.html index cfe0a159..baeb2896 100644 --- a/docs/commands/Reports.html +++ b/docs/commands/Reports.html @@ -585,7 +585,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Roles.html b/docs/commands/Roles.html index cc0ee869..63985463 100644 --- a/docs/commands/Roles.html +++ b/docs/commands/Roles.html @@ -557,7 +557,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Spawn.html b/docs/commands/Spawn.html index 859247a4..0e9f0d69 100644 --- a/docs/commands/Spawn.html +++ b/docs/commands/Spawn.html @@ -389,7 +389,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Tag.html b/docs/commands/Tag.html index dfdcbf48..b811ef43 100644 --- a/docs/commands/Tag.html +++ b/docs/commands/Tag.html @@ -443,7 +443,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Teleport.html b/docs/commands/Teleport.html index 1848f1a0..37c1228c 100644 --- a/docs/commands/Teleport.html +++ b/docs/commands/Teleport.html @@ -484,7 +484,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/commands/Warnings.html b/docs/commands/Warnings.html index eb9dd3ff..09a0bc29 100644 --- a/docs/commands/Warnings.html +++ b/docs/commands/Warnings.html @@ -569,7 +569,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Advanced-Start.html b/docs/configs/Advanced-Start.html index 0c5783c8..d384d219 100644 --- a/docs/configs/Advanced-Start.html +++ b/docs/configs/Advanced-Start.html @@ -506,7 +506,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Bonuses.html b/docs/configs/Bonuses.html index 52c1dcc5..0917c4d5 100644 --- a/docs/configs/Bonuses.html +++ b/docs/configs/Bonuses.html @@ -237,7 +237,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Chat-Reply.html b/docs/configs/Chat-Reply.html index 6594a2c5..ea3028b1 100644 --- a/docs/configs/Chat-Reply.html +++ b/docs/configs/Chat-Reply.html @@ -485,7 +485,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Commands-Auth-Admin.html b/docs/configs/Commands-Auth-Admin.html index d02099b4..7bd92c05 100644 --- a/docs/configs/Commands-Auth-Admin.html +++ b/docs/configs/Commands-Auth-Admin.html @@ -294,7 +294,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Commands-Auth-Roles.html b/docs/configs/Commands-Auth-Roles.html index 45cda632..da7c62d3 100644 --- a/docs/configs/Commands-Auth-Roles.html +++ b/docs/configs/Commands-Auth-Roles.html @@ -320,7 +320,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Commands-Auth-Runtime-Disable.html b/docs/configs/Commands-Auth-Runtime-Disable.html index 1e2b5098..b4d1c559 100644 --- a/docs/configs/Commands-Auth-Runtime-Disable.html +++ b/docs/configs/Commands-Auth-Runtime-Disable.html @@ -442,7 +442,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Commands-Parse-Roles.html b/docs/configs/Commands-Parse-Roles.html index 47d2034e..fa0b0c81 100644 --- a/docs/configs/Commands-Parse-Roles.html +++ b/docs/configs/Commands-Parse-Roles.html @@ -354,7 +354,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Commands-Parse.html b/docs/configs/Commands-Parse.html index a1895ddb..4da164e4 100644 --- a/docs/configs/Commands-Parse.html +++ b/docs/configs/Commands-Parse.html @@ -338,7 +338,7 @@ see ./expcore/commands.lua for more details

generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Compilatron.html b/docs/configs/Compilatron.html index 64adcfc4..9e941609 100644 --- a/docs/configs/Compilatron.html +++ b/docs/configs/Compilatron.html @@ -354,7 +354,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Death-Logger.html b/docs/configs/Death-Logger.html index 74805d6c..4bc70ffb 100644 --- a/docs/configs/Death-Logger.html +++ b/docs/configs/Death-Logger.html @@ -416,7 +416,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Discord-Alerts.html b/docs/configs/Discord-Alerts.html index 07cba503..07f576a8 100644 --- a/docs/configs/Discord-Alerts.html +++ b/docs/configs/Discord-Alerts.html @@ -237,7 +237,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/File-Loader.html b/docs/configs/File-Loader.html index 58ae563e..b17c2ac5 100644 --- a/docs/configs/File-Loader.html +++ b/docs/configs/File-Loader.html @@ -240,7 +240,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Permission-Groups.html b/docs/configs/Permission-Groups.html index 87281de1..d8d2b6e5 100644 --- a/docs/configs/Permission-Groups.html +++ b/docs/configs/Permission-Groups.html @@ -295,7 +295,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Player-List.html b/docs/configs/Player-List.html index a64923b7..7767e286 100644 --- a/docs/configs/Player-List.html +++ b/docs/configs/Player-List.html @@ -812,7 +812,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Pollution-Grading.html b/docs/configs/Pollution-Grading.html index bb836f8f..9dc1dde3 100644 --- a/docs/configs/Pollution-Grading.html +++ b/docs/configs/Pollution-Grading.html @@ -384,7 +384,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Popup-Messages.html b/docs/configs/Popup-Messages.html index 8834a58c..f7509b4e 100644 --- a/docs/configs/Popup-Messages.html +++ b/docs/configs/Popup-Messages.html @@ -414,7 +414,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Preset-Player-Colours.html b/docs/configs/Preset-Player-Colours.html index d5e06589..ebaf5a99 100644 --- a/docs/configs/Preset-Player-Colours.html +++ b/docs/configs/Preset-Player-Colours.html @@ -324,7 +324,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Repair.html b/docs/configs/Repair.html index 741a2beb..e25605ab 100644 --- a/docs/configs/Repair.html +++ b/docs/configs/Repair.html @@ -414,7 +414,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Rockets.html b/docs/configs/Rockets.html index 35e5d51b..6d00c415 100644 --- a/docs/configs/Rockets.html +++ b/docs/configs/Rockets.html @@ -834,7 +834,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Roles.html b/docs/configs/Roles.html index 2fc9736f..f068d198 100644 --- a/docs/configs/Roles.html +++ b/docs/configs/Roles.html @@ -292,7 +292,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Science.html b/docs/configs/Science.html index 65bcb95e..70d9b4bf 100644 --- a/docs/configs/Science.html +++ b/docs/configs/Science.html @@ -354,7 +354,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Scorched-Earth.html b/docs/configs/Scorched-Earth.html index 9de50ddf..7b59c252 100644 --- a/docs/configs/Scorched-Earth.html +++ b/docs/configs/Scorched-Earth.html @@ -388,7 +388,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Spawn-Area.html b/docs/configs/Spawn-Area.html index d72010dc..22399910 100644 --- a/docs/configs/Spawn-Area.html +++ b/docs/configs/Spawn-Area.html @@ -744,7 +744,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Tasks.html b/docs/configs/Tasks.html index 50107b1f..d4eabb34 100644 --- a/docs/configs/Tasks.html +++ b/docs/configs/Tasks.html @@ -384,7 +384,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Warnings.html b/docs/configs/Warnings.html index d02fb163..fdf89564 100644 --- a/docs/configs/Warnings.html +++ b/docs/configs/Warnings.html @@ -355,7 +355,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/configs/Warps.html b/docs/configs/Warps.html index 76a67c3e..8fb76e39 100644 --- a/docs/configs/Warps.html +++ b/docs/configs/Warps.html @@ -684,7 +684,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/control/Jail.html b/docs/control/Jail.html index 8bf0dabd..6280d0cf 100644 --- a/docs/control/Jail.html +++ b/docs/control/Jail.html @@ -1208,7 +1208,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/control/Production.html b/docs/control/Production.html index 48c4e2d0..5d253abf 100644 --- a/docs/control/Production.html +++ b/docs/control/Production.html @@ -1329,7 +1329,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/control/Reports.html b/docs/control/Reports.html index ec69b942..d8056fbf 100644 --- a/docs/control/Reports.html +++ b/docs/control/Reports.html @@ -1110,7 +1110,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/control/Rockets.html b/docs/control/Rockets.html index cc03876e..6a64ec4b 100644 --- a/docs/control/Rockets.html +++ b/docs/control/Rockets.html @@ -984,7 +984,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/control/Tasks.html b/docs/control/Tasks.html index c4ff0bac..e0504c47 100644 --- a/docs/control/Tasks.html +++ b/docs/control/Tasks.html @@ -1039,7 +1039,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/control/Warnings.html b/docs/control/Warnings.html index 09e669fd..b981575f 100644 --- a/docs/control/Warnings.html +++ b/docs/control/Warnings.html @@ -1465,7 +1465,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/control/Warps.html b/docs/control/Warps.html index 1edc8de5..0abafcc4 100644 --- a/docs/control/Warps.html +++ b/docs/control/Warps.html @@ -1413,7 +1413,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/core/Commands.html b/docs/core/Commands.html index 652d0f97..1fdcc0fb 100644 --- a/docs/core/Commands.html +++ b/docs/core/Commands.html @@ -1972,7 +1972,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/core/Common-Library.html b/docs/core/Common-Library.html index f5b36e19..79f75a57 100644 --- a/docs/core/Common-Library.html +++ b/docs/core/Common-Library.html @@ -2480,7 +2480,7 @@ generated by LDoc
- Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
diff --git a/docs/core/Gui.html b/docs/core/Gui.html index 7377280e..b0e22e17 100644 --- a/docs/core/Gui.html +++ b/docs/core/Gui.html @@ -41,22 +41,9 @@

  • Sections

    • @@ -216,22 +203,9 @@

  • Jump to Section

    • @@ -251,11 +225,7 @@

    Gui core

    -

    Core Module - Gui - - This file is used to require all the different elements of the gui module - - each module has an outline here but for more details see their separate files in ./gui - - please read the files for more documentation that cant be shown here - - please note there is a rework planned but not started

    +

    Core Module - Gui

    @@ -270,845 +240,105 @@ -

    Dependencies

    +

    Concept Base

    - + + - + + - + + - + + - + + - + + - + + - - - - - - - - - - - - - - - - + +
    expcore.gui.corePrototype:clone(concept_name)Used to copy all the settings from one concept to another and removing links to the orginal
    expcore.gui.instancesPrototype:new_event(event_name[, factorio_event][, event_condition])Adds a new event trigger to the concept which can be linked to a factorio event
    expcore.gui.elements.buttonsPrototype:on_custom_event(handler)Adds a custom event handler, replace with the name of the event
    expcore.gui.elements.checkboxPrototype:raise_event(event_name[, event={}][, from_factorio=false])Raises a custom event, folowing keys included automaticlly: concept, event name, game tick, player from player_index, element if valid
    expcore.gui.elements.dropdownPrototype:new_property(property_name, default[, setter_callback])Adds a new property to the concept, such as caption, tooltip, or some custom property you want to control
    expcore.gui.elements.sliderPrototype:set_custom_property(value)Sets a new value for a property, triggers setter method if provided, replace with property name
    expcore.gui.elements.textPrototype:define_draw(draw_callback)Used to define how the concept is turned into an ingame element or "instance" as we may refer to them
    expcore.gui.elements.elem-button
    expcore.gui.elements.progress-bar
    expcore.gui.concepts.toolbar
    expcore.gui.concepts.left
    expcore.gui.concepts.center
    expcore.gui.concepts.popupsPrototype:draw(parent_element)Calls all the draw functions in order to create this concept in game; will also store and sync the instance if stores are used
    -

    Center Guis

    +

    Concept Instances

    - + + - + + - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    expcore.gui.corePrototype:define_instance_store([category_callback])Adds an instance store to the concept; when a new instance is made it is stored so you can access it later
    expcore.gui.prototypePrototype.get_instances([category])Gets all insatnces in a category, category may be nil to return all
    expcore.gui.concepts.toolbarPrototype.add_instance(element[, category])Adds an instance to this concept, used automatically during concept:draw
    utils.game
    CenterFrames.get_flow(player)Gets the center flow for a player
    CenterFrames.clear_flow(player)Clears the center flow for a player
    CenterFrames.draw_frame(player, name)Draws the center frame for a player, if already open then will do nothing
    CenterFrames.redraw_frame(player, name)Draws the center frame for a player, if already open then will destroy it and redraw
    CenterFrames.toggle_frame(player, name[, state])Toggles if the frame is currently open or not, will open if closed and close if open
    CenterFrames.new_frame(permission_name)Creates a new center frame define
    CenterFrames._prototype:set_auto_focus([state=true])Sets the frame to be the current active gui when opened and closes all other frames
    CenterFrames._prototype:draw_frame(player)Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)
    CenterFrames._prototype:redraw_frame(player)Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)
    CenterFrames._prototype:toggle_frame(player)Toggles if the frame is open, if open it will close it and if closed it will open it
    CenterFrames._prototype:event_handler([action=update])Creates an event handler that will trigger one of its functions, use with Event.addPrototype.update_instances([category], update_callback)Applies an update function to all instances, simialr use to what table.forEach would be
    -

    Left Guis

    +

    Concept Data

    - + + - + + - + + - + + - + + - + + - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.corePrototype:define_data_store([category_callback])Adds a data store to this concept which allows you to store synced/percistent data between instances
    expcore.gui.prototypePrototype.get_data([category])Gets the data that is stored for this category
    expcore.gui.concepts.toolbarPrototype.set_data([category], value)Sets the data that is stored for this category
    expcore.gui.elements.buttonsPrototype.clear_data([category])Clears the data that is stored for this category
    mod-guiPrototype.update_data([category], update_callback)Updates the data that is stored for this category
    utils.gamePrototype:define_combined_store([category_callback], get_callback, set_callback)Used to add a both instance and data stores which are linked together, new instances are synced to current value, changing one instances changes them all
    utils.eventPrototype.set_instance_from_store(the)Will set the state of an instance based on the value in the store
    LeftFrames.get_flow(player)Gets the left frame flow for a player
    LeftFrames.get_frame(name, player)Gets one frame from the left flow by its name
    LeftFrames.get_open(player)Gets all open frames for a player, if non are open it will remove the close all button
    LeftFrames.toggle_frame(name, player[, state])Toggles the visibility of a left frame, or sets its visibility state
    LeftFrames.new_frame(permission_name)Creates a new left frame define
    LeftFrames._prototype:set_open_by_default([state=true])Sets if the frame is visible when a player joins, can also be a function to return a boolean
    LeftFrames._prototype:set_direction(direction)Sets the direction of the frame, either vertical or horizontal
    LeftFrames._prototype:_internal_draw(player)Creates the gui for the first time, used internally
    LeftFrames._prototype:get_frame(player)Gets the frame for this define from the left frame flow
    LeftFrames._prototype:is_open(player)Returns if the player currently has this define visible
    LeftFrames._prototype:toggle(player)Toggles the visibility of the left frame
    LeftFrames._prototype:update(player)Updates the contents of the left frame, first tries update callback, other wise will clear and redraw
    LeftFrames._prototype:update_all([update_offline=false])Updates the frame for all players, see update
    LeftFrames._prototype:redraw(player)Redraws the frame by calling on_draw, will always clear the frame
    LeftFrames._prototype:redraw_all([update_offline=false])Redraws the frame for all players, see redraw
    LeftFrames._prototype:event_handler([action=update])Creates an event handler that will trigger one of its functions, use with Event.add
    - - -

    Popups

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.prototype
    utils.game
    utils.event
    expcore.gui.elements.progress-bar
    expcore.gui.elements.buttons
    mod-gui
    resources.color_presets
    utils.global
    PopupFrames.get_flow(player)Gets the left flow that contains the popup frames
    PopupFrames.open(define_name, player[, open_time], ...)Opens a popup for the player, can give the amount of time it is open as well as params for the draw function
    PopupFrames.close_progressProgress bar which when depleted will close the popup frame
    PopupFrames.close_buttonA button which can be used to close the gui before the timer runs out
    PopupFrames.new_popup([name])Creates a new popup frame define
    PopupFrames._prototype:set_default_open_time(amount)Sets the default open time for the popup, will be used if non is provided with open
    PopupFrames._prototype:open(player[, open_time], ...)Opens this define for a player, can be given open time and any other params for the draw function
    - - -

    Toolbar

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.elements.buttons
    expcore.roles
    utils.event
    utils.game
    mod-gui
    Toolbar.new_button([name])Adds a new button to the toolbar
    Toolbar.add_button(button)Adds an existing buttton to the toolbar
    Toolbar.update(player)Updates the player's toolbar with an new buttons or expected change in auth return
    - - -

    Core

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    utils.gui
    utils.game
    new_define(prototype[, debug_name])Used to create new element defines from a class prototype, please use the own given by the class
    get_define(name[, internal])Gets an element define give the uid, debug name or a copy of the element define
    categorize_by_player(element)A categorize function to be used with add_store, each player has their own value
    categorize_by_force(element)A categorize function to be used with add_store, each force has its own value
    categorize_by_surface(element)A categorize function to be used with add_store, each surface has its own value
    draw(name, element)Draws a copy of the element define to the parent element, see draw_to
    toggle_enabled(element)Will toggle the enabled state of an element
    toggle_visible(element)Will toggle the visiblity of an element
    set_padding(element[, up=0][, down=0][, left=0][, right=0])Sets the padding for a gui element
    set_padding_style(style[, up=0][, down=0][, left=0][, right=0])Sets the padding for a gui style
    create_alignment(element[, name][, horizontal_align='right'][, vertical_align='center'])Allows the creation of an alignment flow to place elements into
    destroy_if_valid(element)Destroies an element but tests for it being present and valid first
    create_scroll_table(element, table_size, maximal_height[, name='scroll'])Creates a scroll area with a table inside, table can be any size
    create_header(element, caption[, tooltip][, right_align][, name='header'])Creates a header section with a label and button area
    - - -

    Buttons

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    mod-gui
    expcore.gui.core
    expcore.gui.prototype
    Button.new_button([name])Creates a new button element define
    Button._prototype:set_sprites(sprite[, hovered_sprite][, clicked_sprite])Adds sprites to a button making it a sprite button
    Button._prototype:set_click_filter(filter[, ...])Adds a click / mouse button filter to the button
    Button._prototype:set_key_filter(filter[, ...])Adds a control key filter to the button
    - - -

    Checkboxs

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.prototype
    expcore.store
    utils.game
    Checkbox.new_checkbox([name])Creates a new checkbox element define
    Checkbox.new_radiobutton([name])Creates a new radiobutton element define, has all functions checkbox has
    Checkbox._prototype_radiobutton:add_as_option(option_set, option_name)Adds this radiobutton to be an option in the given option set (only one can be true at a time)
    Checkbox._prototype_radiobutton:get_store(category, internal)Gets the stored value of the radiobutton or the option set if present
    Checkbox._prototype_radiobutton:set_store(category, value, internal)Sets the stored value of the radiobutton or the option set if present
    Checkbox.new_option_set(name, callback, categorize)Registers a new option set that can be linked to radiobuttons (only one can be true at a time)
    Checkbox.draw_option_set(name, element)Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)
    Checkbox.reset_radiobuttons(element[, exclude][, recursive=false])Sets all radiobutton in a element to false (unless excluded) and can act recursively
    - - -

    Dropdowns

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.prototype
    utils.game
    Dropdown.new_dropdown([name])Creates a new dropdown element define
    Dropdown.new_list_box([name])Creates a new list box element define
    Dropdown._prototype:new_static_options(options[, ...], the)Adds new static options to the dropdown which will trigger the general callback
    Dropdown._prototype:new_dynamic_options(callback)Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)
    Dropdown._prototype:add_option_callback(option, callback)Adds a case specific callback which will only run when that option is selected (general case still triggered)
    Dropdown.select_value(element, value)Selects the option from a dropdown or list box given the value rather than key
    Dropdown.get_selected_value(element)Returns the currently selected value rather than index
    - - -

    Elem Buttons

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.prototype
    utils.game
    ElemButton.new_elem_button([name])Creates a new elem button element define
    ElemButton._prototype.set_typeSets the type of the elem button, the type is required so this must be called at least once
    ElemButton._prototype:set_default(value)Sets the default value for the elem button, this may be a function or a string
    - - -

    Progress Bars

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.prototype
    utils.global
    utils.game
    ProgressBar.set_maximum(element, amount)Sets the maximum value that represents the end value of the progress bar
    ProgressBar.increment(element[, amount=1])Increases the value of the progressbar, if a define is given all of its instances have incremented
    ProgressBar.decrement(element[, amount=1])Decreases the value of the progressbar, if a define is given all of its instances have decremented
    ProgressBar.new_progressbar([name])Creates a new progressbar element define
    ProgressBar._prototype:set_default_maximum(amount)Sets the maximum value that represents the end value of the progress bar
    ProgressBar._prototype:use_count_down([state=true])Will set the progress bar to start at 1 and trigger when it hits 0
    ProgressBar._prototype:increment([amount=1][, category])Increases the value of the progressbar
    ProgressBar._prototype:increment_filtered([amount=1], filter)Increases the value of the progressbar, if the filter condition is met, does not work with store
    ProgressBar._prototype:decrement([amount=1][, category])Decreases the value of the progressbar
    ProgressBar._prototype:decrement_filtered([amount=1], filter)Decreases the value of the progressbar, if the filter condition is met, does not work with store
    ProgressBar._prototype:add_element(element[, maximum])Adds an element into the list of instances that will are waiting to complete, does not work with store - note use store if you want persistent data, this only stores the elements not the values which they have
    ProgressBar._prototype:reset_element(element)Resets an element, or its store, to be back at the start, either 1 or 0
    ProgressBar._prototype:event_counter([filter])Event handler factory that counts up by 1 every time the event triggers, can filter which elements have incremented
    ProgressBar._prototype:event_countdown([filter])Event handler factory that counts down by 1 every time the event triggers, can filter which elements have decremented
    - - -

    Sliders

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.prototype
    expcore.gui.instances
    utils.game
    Slider.new_slider([name])Creates a new slider element define
    Slider._prototype:set_range([min][, max])Sets the range of a slider, if not used will use default values for a slider
    Slider._prototype:draw_label(element)Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player
    Slider._prototype:enable_auto_draw_label([state=true])Enables auto draw of the label, the label will share the same parent element as the slider
    - - -

    Text

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.core
    expcore.gui.prototype
    utils.game
    Text.new_text_field([name])Creates a new text field element define
    Text.new_text_box([name])Creates a new text box element define
    Text._prototype_box:set_selectable([state=true])Sets the text box to be selectable
    Text._prototype_box:set_word_wrap([state=true])Sets the text box to have word wrap
    Text._prototype_box:set_read_only([state=true])Sets the text box to be read only
    - - -

    Instances

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    utils.global
    Instances.has_categories(name)Returns if a instance group has a categorise function; must be registered
    Instances.is_registered(name)Returns if the given name is a registered instance group
    Instances.register(name[, categorise])Registers the name of an instance group to allow for storing element instances
    Instances.add_element(name, element)Adds an element to the instance group under the correct category; must be registered
    Instances.get_elements_raw(name[, category])Gets all element instances without first removing any invalid ones; used internally and must be registered
    Instances.get_valid_elements(name[, category][, callback])Gets all valid element instances and has the option of running a callback on those that are valid
    Instances.unregistered_add_element(name, category, element)A version of add_element that does not require the group to be registered
    Instances.unregistered_get_elements(name, category[, callback])A version of get_elements that does not require the group to be registered
    - - -

    Prototype

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    utils.game
    expcore.store
    expcore.gui.instances
    Constructor.event(event_name)Creates a new function to add functions to an event handler
    Constructor.extend(new_prototype)Extents a prototype with the base functions of all gui prototypes, no metatables
    Constructor.store(sync, callback)Creates a new function which adds a store to a gui define
    Constructor.setter(value_type, key[, second_key])Creates a setter function that checks the type when a value is set
    Prototype:uid()Gets the uid for the element define
    Prototype.debug_nameSets a debug alias for the define
    Prototype.set_captionSets the caption for the element define
    Prototype.set_tooltipSets the tooltip for the element define
    Prototype.set_pre_authenticatorSets an authenticator that blocks the draw function if check fails
    Prototype.set_post_authenticatorSets an authenticator that disables the element if check fails
    Prototype.on_drawRegisters a callback to the on_draw event
    Prototype.on_style_updateRegisters a callback to the on_style_update event
    Prototype:set_style(style[, callback])Sets the style for the element define
    Prototype:set_embedded_flow(state)Sets the element to be drawn inside a nameless flow, can be given a name using a function
    Prototype:raise_event(event_name, ...)Raises a custom event for this define, any number of params can be given
    Prototype:draw_to(element)The main function for defines, when called will draw an instance of this define to the given element - what is drawn is based on the data in draw_data which is set using other functions
    Prototype:get_store(category)Gets the value in this elements store, category needed if categorize function used
    Prototype:set_store(category, value)Sets the value in this elements store, category needed if categorize function used
    Prototype:clear_store([category])Sets the value in this elements store to nil, category needed if categorize function used
    - - -

    Test

    - - - - - - - - - - - - - - - - - + +
    expcore.gui
    expcore.common
    resources.color_presets
    utils.event
    expcore.storePrototype.set_store_from_instance(the)Will set the value in the store and update the other instances based on the instance given
    @@ -1117,447 +347,19 @@
    -

    Dependencies

    +

    Concept Base

    - # - expcore.gui.core + # + Prototype:clone(concept_name)
    - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.instances -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.buttons -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.checkbox -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.dropdown -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.slider -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.text -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.elem-button -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.progress-bar -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.toolbar -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.left -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.center -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.popups -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -

    Center Guis

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.toolbar -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames.get_flow(player) -
    -
    -
    -
    - -

    Gets the center flow for a player

    +

    Used to copy all the settings from one concept to another and removing links to the orginal

    @@ -1571,136 +373,13 @@
  • - player - - : - - (LuaPlayer) - - the player to get the flow for - -
    • - - - - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames.clear_flow(player) -
    -
    -
    -
    - -

    Clears the center flow for a player

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to clear the flow for - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames.draw_frame(player, name) -
    -
    -
    -
    - -

    Draws the center frame for a player, if already open then will do nothing

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player that will have the frame drawn - -
      • - - - - - -
    • - - name + concept_name : (string) - the name of the hui that will drawn + the name of the new concept; must be unique
      • @@ -1713,8 +392,8 @@ Returns:
      • - (LuaGuiElement) - the new frame that was made + (GuiConcept) + the base for building a custom gui
      @@ -1724,8023 +403,24 @@ + Usage: + 
      
+local custom_button =
+Gui.get_concept('Button'):clone('CustomButton')
    - # - CenterFrames.redraw_frame(player, name) + # + Prototype:new_event(event_name[, factorio_event][, event_condition])
    -

    Draws the center frame for a player, if already open then will destroy it and redraw

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player that will have the frame drawn - -
      • - - - - - -
    • - - name - - : - - (string) - - the name of the hui that will drawn - -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames.toggle_frame(player, name[, state]) -
    -
    -
    -
    - -

    Toggles if the frame is currently open or not, will open if closed and close if open

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player that will have the frame toggled - -
      • - - - - - -
    • - - name - - : - - (string) - - the name of the hui that will be toggled - -
      • - - - - - -
    • - - state - - : - - (boolean) - - when set will force a state for the frame - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - if the frame if no open or closed -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames.new_frame(permission_name) -
    -
    -
    -
    - -

    Creates a new center frame define

    -

    - - - Parameters: - -
      - - - - - -
    • - - permission_name - - : - - (string) - - the name that can be used with the permission system - -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new center frame define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:set_auto_focus([state=true]) -
    -
    -
    -
    - -

    Sets the frame to be the current active gui when opened and closes all other frames

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean) - - when true will auto close other frames and set this frame as player.opened - - (default: true) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:draw_frame(player) -
    -
    -
    -
    - -

    Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to draw the frame for - -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:redraw_frame(player) -
    -
    -
    -
    - -

    Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to draw the frame for - -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:toggle_frame(player) -
    -
    -
    -
    - -

    Toggles if the frame is open, if open it will close it and if closed it will open it

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to draw the frame for - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - with the gui frame is now open -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:event_handler([action=update]) -
    -
    -
    -
    - -

    Creates an event handler that will trigger one of its functions, use with Event.add

    -

    - - - Parameters: - -
      - - - - - -
    • - - action - - : - - (string) - - the action to take on this event - - (default: update) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -

    Left Guis

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.toolbar -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.buttons -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - mod-gui -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.event -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames.get_flow(player) -
    -
    -
    -
    - -

    Gets the left frame flow for a player

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the flow of - -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames.get_frame(name, player) -
    -
    -
    -
    - -

    Gets one frame from the left flow by its name

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the gui frame to get - -
      • - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the frame of - -
      • - - -
    - - - - - Returns: -
      -
    • - (LuaGuiElement) - the frame in the left frame flow with that name -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames.get_open(player) -
    -
    -
    -
    - -

    Gets all open frames for a player, if non are open it will remove the close all button

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the flow of - -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - contains all the open (and registered) frames for the player -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames.toggle_frame(name, player[, state]) -
    -
    -
    -
    - -

    Toggles the visibility of a left frame, or sets its visibility state

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the gui frame to toggle - -
      • - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the frame of - -
      • - - - - - -
    • - - state - - : - - (boolean) - - when given will be the state that the visibility is set to - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - the new state of the visibility -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames.new_frame(permission_name) -
    -
    -
    -
    - -

    Creates a new left frame define

    -

    - - - Parameters: - -
      - - - - - -
    • - - permission_name - - : - - (string) - - the name that can be used with the permission system - -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new left frame define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:set_open_by_default([state=true]) -
    -
    -
    -
    - -

    Sets if the frame is visible when a player joins, can also be a function to return a boolean

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean or function) - - the default state of the visibility, can be a function - state param - player LuaPlayer - the player that has joined the game - state param - define_name string - the define name for the frame - state return - boolean - false will hide the frame - - (default: true) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:set_direction(direction) -
    -
    -
    -
    - -

    Sets the direction of the frame, either vertical or horizontal

    -

    - - - Parameters: - -
      - - - - - -
    • - - direction - - : - - (string) - - the direction to have the elements be added to the frame - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:_internal_draw(player) -
    -
    -
    -
    - -

    Creates the gui for the first time, used internally

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to draw the frame to - -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:get_frame(player) -
    -
    -
    -
    - -

    Gets the frame for this define from the left frame flow

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the frame of - -
      • - - -
    - - - - - Returns: -
      -
    • - (LuaGuiElement) - the frame in the left frame flow for this define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:is_open(player) -
    -
    -
    -
    - -

    Returns if the player currently has this define visible

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the frame of - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - true if it is open/visible -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:toggle(player) -
    -
    -
    -
    - -

    Toggles the visibility of the left frame

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to toggle the frame of - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - the new state of the visibility -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:update(player) -
    -
    -
    -
    - -

    Updates the contents of the left frame, first tries update callback, other wise will clear and redraw

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to update the frame of - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:update_all([update_offline=false]) -
    -
    -
    -
    - -

    Updates the frame for all players, see update

    -

    - - - Parameters: - -
      - - - - - -
    • - - update_offline - - : - - (boolean) - - when true will update the frame for offline players - - (default: false) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:redraw(player) -
    -
    -
    -
    - -

    Redraws the frame by calling on_draw, will always clear the frame

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to update the frame of - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:redraw_all([update_offline=false]) -
    -
    -
    -
    - -

    Redraws the frame for all players, see redraw

    -

    - - - Parameters: - -
      - - - - - -
    • - - update_offline - - : - - (boolean) - - when true will update the frame for offline players - - (default: false) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - LeftFrames._prototype:event_handler([action=update]) -
    -
    -
    -
    - -

    Creates an event handler that will trigger one of its functions, use with Event.add

    -

    - - - Parameters: - -
      - - - - - -
    • - - action - - : - - (string) - - the action to take on this event - - (default: update) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -

    Popups

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.event -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.progress-bar -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.buttons -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - mod-gui -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - resources.color_presets -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.global -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - PopupFrames.get_flow(player) -
    -
    -
    -
    - -

    Gets the left flow that contains the popup frames

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the flow for - -
      • - - -
    - - - - - Returns: -
      -
    • - (LuaGuiElement) - the left flow that contains the popup frames -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - PopupFrames.open(define_name, player[, open_time], ...) -
    -
    -
    -
    - -

    Opens a popup for the player, can give the amount of time it is open as well as params for the draw function

    -

    - - - Parameters: - -
      - - - - - -
    • - - define_name - - : - - (string) - - the name of the define that you want to open for the player - -
      • - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to open the popup for - -
      • - - - - - -
    • - - open_time - - : - - (number) - - the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default - - (optional) -
      • - - - - - -
    • - - ... - - : - - (any) - - the other params that you want to pass to your on_draw event - -
      • - - -
    - - - - - Returns: -
      -
    • - (LuaGuiElement) - the frame that was drawn, the inner gui flow which contains the content -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - PopupFrames.close_progress -
    -
    -
    -
    - -

    Progress bar which when depleted will close the popup frame

    -

    - - - - - - - - - - - - - - -
    -
    -
    -
    - # - PopupFrames.close_button -
    -
    -
    -
    - -

    A button which can be used to close the gui before the timer runs out

    -

    - - - - - - - - - - - - - - -
    -
    -
    -
    - # - PopupFrames.new_popup([name]) -
    -
    -
    -
    - -

    Creates a new popup frame define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new popup frame define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - PopupFrames._prototype:set_default_open_time(amount) -
    -
    -
    -
    - -

    Sets the default open time for the popup, will be used if non is provided with open

    -

    - - - Parameters: - -
      - - - - - -
    • - - amount - - : - - (number) - - the number of ticks, by default, the popup will be open for - -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the define to allow for chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - PopupFrames._prototype:open(player[, open_time], ...) -
    -
    -
    -
    - -

    Opens this define for a player, can be given open time and any other params for the draw function

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to open the popup for - -
      • - - - - - -
    • - - open_time - - : - - (number) - - the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default - - (optional) -
      • - - - - - -
    • - - ... - - : - - (any) - - the other params that you want to pass to your on_draw event - -
      • - - -
    - - - - - Returns: -
      -
    • - (LuaGuiElement) - the frame that was drawn, the inner gui flow which contains the content -
      • -
    - - - - - - - - - -
    -
    -

    Toolbar

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.buttons -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.roles -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.event -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - mod-gui -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Toolbar.new_button([name]) -
    -
    -
    -
    - -

    Adds a new button to the toolbar

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - when given allows an alias to the button for the permission system - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the button define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Toolbar.add_button(button) -
    -
    -
    -
    - -

    Adds an existing buttton to the toolbar

    -

    - - - Parameters: - -
      - - - - - -
    • - - button - - : - - (table) - - the button define for the button to be added - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Toolbar.update(player) -
    -
    -
    -
    - -

    Updates the player's toolbar with an new buttons or expected change in auth return

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to update the toolbar for - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -

    Core

    -
    -
    -
    -
    - # - utils.gui -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - new_define(prototype[, debug_name]) -
    -
    -
    -
    - -

    Used to create new element defines from a class prototype, please use the own given by the class

    -

    - - - Parameters: - -
      - - - - - -
    • - - prototype - - : - - (table) - - the class prototype that will be used for the element define - -
      • - - - - - -
    • - - debug_name - - : - - (string) - - the name that you want to see while debuging - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new element define with all functions accessed via __index metamethod -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - get_define(name[, internal]) -
    -
    -
    -
    - -

    Gets an element define give the uid, debug name or a copy of the element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string or table) - - the uid, debug name or define for the element define to get - -
      • - - - - - -
    • - - internal - - : - - (boolean) - - when true the error trace is one level higher (used internally) - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the element define that was found or an error -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - categorize_by_player(element) -
    -
    -
    -
    - -

    A categorize function to be used with add_store, each player has their own value

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element that will be converted to a string - -
      • - - -
    - - - - - Returns: -
      -
    • - (string) - the player's name who owns this element -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - categorize_by_force(element) -
    -
    -
    -
    - -

    A categorize function to be used with add_store, each force has its own value

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element that will be converted to a string - -
      • - - -
    - - - - - Returns: -
      -
    • - (string) - the player's force name who owns this element -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - categorize_by_surface(element) -
    -
    -
    -
    - -

    A categorize function to be used with add_store, each surface has its own value

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element that will be converted to a string - -
      • - - -
    - - - - - Returns: -
      -
    • - (string) - the player's surface name who owns this element -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - draw(name, element) -
    -
    -
    -
    - -

    Draws a copy of the element define to the parent element, see draw_to

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string or table) - - the uid, debug name or define for the element define to draw - -
      • - - - - - -
    • - - element - - : - - (LuaGuiEelement) - - the parent element that it the define will be drawn to - -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - toggle_enabled(element) -
    -
    -
    -
    - -

    Will toggle the enabled state of an element

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the gui element to toggle - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - the new state that the element has -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - toggle_visible(element) -
    -
    -
    -
    - -

    Will toggle the visiblity of an element

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the gui element to toggle - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - the new state that the element has -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - set_padding(element[, up=0][, down=0][, left=0][, right=0]) -
    -
    -
    -
    - -

    Sets the padding for a gui element

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element to set the padding for - -
      • - - - - - -
    • - - up - - : - - (number) - - the amount of padding on the top - - (default: 0) -
      • - - - - - -
    • - - down - - : - - (number) - - the amount of padding on the bottom - - (default: 0) -
      • - - - - - -
    • - - left - - : - - (number) - - the amount of padding on the left - - (default: 0) -
      • - - - - - -
    • - - right - - : - - (number) - - the amount of padding on the right - - (default: 0) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - set_padding_style(style[, up=0][, down=0][, left=0][, right=0]) -
    -
    -
    -
    - -

    Sets the padding for a gui style

    -

    - - - Parameters: - -
      - - - - - -
    • - - style - - : - - (LuaStyle) - - the element to set the padding for - -
      • - - - - - -
    • - - up - - : - - (number) - - the amount of padding on the top - - (default: 0) -
      • - - - - - -
    • - - down - - : - - (number) - - the amount of padding on the bottom - - (default: 0) -
      • - - - - - -
    • - - left - - : - - (number) - - the amount of padding on the left - - (default: 0) -
      • - - - - - -
    • - - right - - : - - (number) - - the amount of padding on the right - - (default: 0) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - create_alignment(element[, name][, horizontal_align='right'][, vertical_align='center']) -
    -
    -
    -
    - -

    Allows the creation of an alignment flow to place elements into

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element to add this alignment into - -
      • - - - - - -
    • - - name - - : - - (string) - - the name to use for the alignment - - (optional) -
      • - - - - - -
    • - - horizontal_align - - : - - (string) - - the horizontal alignment of the elements in this flow - - (default: 'right') -
      • - - - - - -
    • - - vertical_align - - : - - (string) - - the vertical alignment of the elements in this flow - - (default: 'center') -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - destroy_if_valid(element) -
    -
    -
    -
    - -

    Destroies an element but tests for it being present and valid first

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element to be destroied - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - true if it was destoried -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - create_scroll_table(element, table_size, maximal_height[, name='scroll']) -
    -
    -
    -
    - -

    Creates a scroll area with a table inside, table can be any size

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element to add this scroll into - -
      • - - - - - -
    • - - table_size - - : - - (number) - - the number of columns in the table - -
      • - - - - - -
    • - - maximal_height - - : - - (number) - - the max hieght of the scroll - -
      • - - - - - -
    • - - name - - : - - (string) - - the name of the scoll element - - (default: 'scroll') -
      • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - create_header(element, caption[, tooltip][, right_align][, name='header']) -
    -
    -
    -
    - -

    Creates a header section with a label and button area

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element to add this header into - -
      • - - - - - -
    • - - caption - - : - - (localeString) - - the caption that is used as the title - -
      • - - - - - -
    • - - tooltip - - : - - (localeString) - - the tooltip that is shown on the caption - - (optional) -
      • - - - - - -
    • - - right_align - - : - - (boolean) - - when true will include the right align area - - (optional) -
      • - - - - - -
    • - - name - - : - - (string) - - the name of the header area - - (default: 'header') -
      • - - -
    - - - - - Returns: -
      -
    • - (LuaGuiElement) - the header that was made, or the align area if that was created -
      • -
    - - - - - - - - - -
    -
    -

    Buttons

    -
    -
    -
    -
    - # - mod-gui -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Button.new_button([name]) -
    -
    -
    -
    - -

    Creates a new button element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new button element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Button._prototype:set_sprites(sprite[, hovered_sprite][, clicked_sprite]) -
    -
    -
    -
    - -

    Adds sprites to a button making it a sprite button

    -

    - - - Parameters: - -
      - - - - - -
    • - - sprite - - : - - (SpritePath) - - the sprite path for the default sprite for the button - -
      • - - - - - -
    • - - hovered_sprite - - : - - (SpritePath) - - the sprite path for the sprite when the player hovers over the button - - (optional) -
      • - - - - - -
    • - - clicked_sprite - - : - - (SpritePath) - - the sprite path for the sprite when the player clicks the button - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - returns the button define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Button._prototype:set_click_filter(filter[, ...]) -
    -
    -
    -
    - -

    Adds a click / mouse button filter to the button

    -

    - - - Parameters: - -
      - - - - - -
    • - - filter - - : - - (table) - - ?string|table either a of mouse buttons or the first mouse button to filter, with a table true means allowed - -
      • - - - - - -
    • - - ... - - : - - (table) - - when filter is not a you can add the mouse buttons one after each other - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - returns the button define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Button._prototype:set_key_filter(filter[, ...]) -
    -
    -
    -
    - -

    Adds a control key filter to the button

    -

    - - - Parameters: - -
      - - - - - -
    • - - filter - - : - - (table) - - ?string|table either a of control keys or the first control keys to filter, with a table true means allowed - -
      • - - - - - -
    • - - ... - - : - - (table) - - when filter is not a you can add the control keys one after each other - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - returns the button define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -

    Checkboxs

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.store -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Checkbox.new_checkbox([name]) -
    -
    -
    -
    - -

    Creates a new checkbox element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new checkbox element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Checkbox.new_radiobutton([name]) -
    -
    -
    -
    - -

    Creates a new radiobutton element define, has all functions checkbox has

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new button element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Checkbox._prototype_radiobutton:add_as_option(option_set, option_name) -
    -
    -
    -
    - -

    Adds this radiobutton to be an option in the given option set (only one can be true at a time)

    -

    - - - Parameters: - -
      - - - - - -
    • - - option_set - - : - - (string) - - the name of the option set to add this element to - -
      • - - - - - -
    • - - option_name - - : - - (string) - - the name of this option that will be used to identify it - -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - the define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Checkbox._prototype_radiobutton:get_store(category, internal) -
    -
    -
    -
    - -

    Gets the stored value of the radiobutton or the option set if present

    -

    - - - Parameters: - -
      - - - - - -
    • - - category - - : - - (string) - - [opt] the category to get such as player name or force name - -
      • - - - - - -
    • - - internal - - : - - (boolean) - - used to prevent stackover flow - -
      • - - -
    - - - - - Returns: -
      -
    • - (any) - the value that is stored for this define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Checkbox._prototype_radiobutton:set_store(category, value, internal) -
    -
    -
    -
    - -

    Sets the stored value of the radiobutton or the option set if present

    -

    - - - Parameters: - -
      - - - - - -
    • - - category - - : - - (string) - - [opt] the category to get such as player name or force name - -
      • - - - - - -
    • - - value - - : - - (boolean) - - the value to set for this define, must be valid for its type ie for checkbox etc - -
      • - - - - - -
    • - - internal - - : - - (boolean) - - used to prevent stackover flow - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - true if the value was set -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Checkbox.new_option_set(name, callback, categorize) -
    -
    -
    -
    - -

    Registers a new option set that can be linked to radiobuttons (only one can be true at a time)

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the option set, must be unique - -
      • - - - - - -
    • - - callback - - : - - (function) - - the update callback when the value of the option set changes - callback param - value string - the new selected option for this option set - callback param - category string - the category that updated if categorize was used - -
      • - - - - - -
    • - - categorize - - : - - (function) - - the function used to convert an element into a string - -
      • - - -
    - - - - - Returns: -
      -
    • - (string) - the name of this option set to be passed to add_as_option -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Checkbox.draw_option_set(name, element) -
    -
    -
    -
    - -

    Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the option set to draw the radiobuttons of - -
      • - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the parent element that the radiobuttons will be drawn to - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Checkbox.reset_radiobuttons(element[, exclude][, recursive=false]) -
    -
    -
    -
    - -

    Sets all radiobutton in a element to false (unless excluded) and can act recursively

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the root gui element to start setting radio buttons from - -
      • - - - - - -
    • - - exclude - - : - - (table) - - ?string|table the name of the radiobutton to exclude or a of radiobuttons where true will set the state true - - (optional) -
      • - - - - - -
    • - - recursive - - : - - (number or boolean) - - if true will recur as much as possible, if a will recur that number of times - - (default: false) -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - true if successful -
      • -
    - - - - - - - - - -
    -
    -

    Dropdowns

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Dropdown.new_dropdown([name]) -
    -
    -
    -
    - -

    Creates a new dropdown element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new dropdown element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Dropdown.new_list_box([name]) -
    -
    -
    -
    - -

    Creates a new list box element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new list box element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Dropdown._prototype:new_static_options(options[, ...], the) -
    -
    -
    -
    - -

    Adds new static options to the dropdown which will trigger the general callback

    -

    - - - Parameters: - -
      - - - - - -
    • - - options - - : - - (table) - - ?string|table either a of option strings or the first option string, with a table values are the options - -
      • - - - - - -
    • - - ... - - : - - (table) - - when options is not a you can add the options one after each other - - (optional) -
      • - - - - - -
    • - - the - - : - - (self) - - define to allow chaining - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Dropdown._prototype:new_dynamic_options(callback) -
    -
    -
    -
    - -

    Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)

    -

    - - - Parameters: - -
      - - - - - -
    • - - callback - - : - - (function) - - the function that will run to get the options for the dropdown - callback param - player LuaPlayer - the player that the element is being drawn to - callback param - element LuaGuiElement - the element that is being drawn - callback return - table - the values of this table will be appended to the static options of the dropdown - -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - the define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Dropdown._prototype:add_option_callback(option, callback) -
    -
    -
    -
    - -

    Adds a case specific callback which will only run when that option is selected (general case still triggered)

    -

    - - - Parameters: - -
      - - - - - -
    • - - option - - : - - (string) - - the name of the option to trigger the callback on; if not already added then will be added as an option - -
      • - - - - - -
    • - - callback - - : - - (function) - - the function that will be called when that option is selected - callback param - player LuaPlayer - the player who owns the gui element - callback param - element LuaGuiElement - the element which is being effected - callback param - value string - the new option that has been selected - -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - the define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Dropdown.select_value(element, value) -
    -
    -
    -
    - -

    Selects the option from a dropdown or list box given the value rather than key

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element that contains the option - -
      • - - - - - -
    • - - value - - : - - (string) - - the option to select from the dropdown - -
      • - - -
    - - - - - Returns: -
      -
    • - (number) - the key where the value was -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Dropdown.get_selected_value(element) -
    -
    -
    -
    - -

    Returns the currently selected value rather than index

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the gui element that you want to get the value of - -
      • - - -
    - - - - - Returns: -
      -
    • - (string) - the value that is currently selected -
      • -
    - - - - - - - - - -
    -
    -

    Elem Buttons

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - ElemButton.new_elem_button([name]) -
    -
    -
    -
    - -

    Creates a new elem button element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new elem button element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - ElemButton._prototype.set_type -
    -
    -
    -
    - -

    Sets the type of the elem button, the type is required so this must be called at least once

    -

    - - - -
      - - - - - -
    • - - type - - : - - (string) - - the type that this elem button is see factorio api - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ElemButton._prototype:set_default(value) -
    -
    -
    -
    - -

    Sets the default value for the elem button, this may be a function or a string

    -

    - - - Parameters: - -
      - - - - - -
    • - - value - - : - - (string or function) - - string a will be a static default and a function will be called when drawn to get the default - -
      • - - -
    - - - - - Returns: -
      -
    • - (the) - element define to allow for chaining -
      • -
    - - - - - - - - - -
    -
    -

    Progress Bars

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.global -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar.set_maximum(element, amount) -
    -
    -
    -
    - -

    Sets the maximum value that represents the end value of the progress bar

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement or string) - - either a gui element or a registered define - -
      • - - - - - -
    • - - amount - - : - - (number) - - the amount to have set as the maximum - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar.increment(element[, amount=1]) -
    -
    -
    -
    - -

    Increases the value of the progressbar, if a define is given all of its instances have incremented

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement or string) - - either a gui element or a registered define - -
      • - - - - - -
    • - - amount - - : - - (number) - - the amount to increase the progressbar by - - (default: 1) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar.decrement(element[, amount=1]) -
    -
    -
    -
    - -

    Decreases the value of the progressbar, if a define is given all of its instances have decremented

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement or string) - - either a gui element or a registered define - -
      • - - - - - -
    • - - amount - - : - - (number) - - the amount to decrease the progressbar by - - (default: 1) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar.new_progressbar([name]) -
    -
    -
    -
    - -

    Creates a new progressbar element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new progressbar element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:set_default_maximum(amount) -
    -
    -
    -
    - -

    Sets the maximum value that represents the end value of the progress bar

    -

    - - - Parameters: - -
      - - - - - -
    • - - amount - - : - - (number) - - the amount to have set as the maximum - -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:use_count_down([state=true]) -
    -
    -
    -
    - -

    Will set the progress bar to start at 1 and trigger when it hits 0

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean) - - when true the bar will start filled, to be used with decrease - - (default: true) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:increment([amount=1][, category]) -
    -
    -
    -
    - -

    Increases the value of the progressbar

    -

    - - - Parameters: - -
      - - - - - -
    • - - amount - - : - - (number) - - the amount to increase the progressbar by - - (default: 1) -
      • - - - - - -
    • - - category - - : - - (string) - - the category that is used with a store - - (optional) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:increment_filtered([amount=1], filter) -
    -
    -
    -
    - -

    Increases the value of the progressbar, if the filter condition is met, does not work with store

    -

    - - - Parameters: - -
      - - - - - -
    • - - amount - - : - - (number) - - the amount to increase the progressbar by - - (default: 1) -
      • - - - - - -
    • - - filter - - : - - (function) - - the filter to be used - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:decrement([amount=1][, category]) -
    -
    -
    -
    - -

    Decreases the value of the progressbar

    -

    - - - Parameters: - -
      - - - - - -
    • - - amount - - : - - (number) - - the amount to decrease the progressbar by - - (default: 1) -
      • - - - - - -
    • - - category - - : - - (string) - - the category that is used with a store - - (optional) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:decrement_filtered([amount=1], filter) -
    -
    -
    -
    - -

    Decreases the value of the progressbar, if the filter condition is met, does not work with store

    -

    - - - Parameters: - -
      - - - - - -
    • - - amount - - : - - (number) - - the amount to decrease the progressbar by - - (default: 1) -
      • - - - - - -
    • - - filter - - : - - (function) - - the filter to be used - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:add_element(element[, maximum]) -
    -
    -
    -
    - -

    Adds an element into the list of instances that will are waiting to complete, does not work with store - note use store if you want persistent data, this only stores the elements not the values which they have

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element that you want to add into the waiting to complete list - -
      • - - - - - -
    • - - maximum - - : - - (number) - - the maximum for this element if not given the default for this define is used - - (optional) -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:reset_element(element) -
    -
    -
    -
    - -

    Resets an element, or its store, to be back at the start, either 1 or 0

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element that you want to reset the progress of - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:event_counter([filter]) -
    -
    -
    -
    - -

    Event handler factory that counts up by 1 every time the event triggers, can filter which elements have incremented

    -

    - - - Parameters: - -
      - - - - - -
    • - - filter - - : - - (function) - - when given will use filtered increment - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (function) - the event handler -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - ProgressBar._prototype:event_countdown([filter]) -
    -
    -
    -
    - -

    Event handler factory that counts down by 1 every time the event triggers, can filter which elements have decremented

    -

    - - - Parameters: - -
      - - - - - -
    • - - filter - - : - - (function) - - when given will use filtered decrement - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (function) - the event handler -
      • -
    - - - - - - - - - -
    -
    -

    Sliders

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.instances -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Slider.new_slider([name]) -
    -
    -
    -
    - -

    Creates a new slider element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new slider element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Slider._prototype:set_range([min][, max]) -
    -
    -
    -
    - -

    Sets the range of a slider, if not used will use default values for a slider

    -

    - - - Parameters: - -
      - - - - - -
    • - - min - - : - - (number) - - the minimum value that the slider can take - - (optional) -
      • - - - - - -
    • - - max - - : - - (number) - - the maximum value that the slider can take - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - the define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Slider._prototype:draw_label(element) -
    -
    -
    -
    - -

    Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player

    -

    - - - Parameters: - -
      - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the parent element that the label will be drawn to - -
      • - - -
    - - - - - Returns: -
      -
    • - (LuaGuiElement) - the new label element so that styles can be applied -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Slider._prototype:enable_auto_draw_label([state=true]) -
    -
    -
    -
    - -

    Enables auto draw of the label, the label will share the same parent element as the slider

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean) - - when false will disable the auto draw of the label - - (default: true) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - the define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -

    Text

    -
    -
    -
    -
    - # - expcore.gui.core -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.prototype -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Text.new_text_field([name]) -
    -
    -
    -
    - -

    Creates a new text field element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new text field element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Text.new_text_box([name]) -
    -
    -
    -
    - -

    Creates a new text box element define

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the optional debug name that can be added - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the new text box element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Text._prototype_box:set_selectable([state=true]) -
    -
    -
    -
    - -

    Sets the text box to be selectable

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean) - - when false will set the state to false - - (default: true) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - table the define to allow for chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Text._prototype_box:set_word_wrap([state=true]) -
    -
    -
    -
    - -

    Sets the text box to have word wrap

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean) - - when false will set the state to false - - (default: true) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - table the define to allow for chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Text._prototype_box:set_read_only([state=true]) -
    -
    -
    -
    - -

    Sets the text box to be read only

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean) - - when false will set the state to false - - (default: true) -
      • - - -
    - - - - - Returns: -
      -
    • - (self) - table the define to allow for chaining -
      • -
    - - - - - - - - - -
    -
    -

    Instances

    -
    -
    -
    -
    - # - utils.global -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Instances.has_categories(name) -
    -
    -
    -
    - -

    Returns if a instance group has a categorise function; must be registered

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - true if there is a categorise function -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Instances.is_registered(name) -
    -
    -
    -
    - -

    Returns if the given name is a registered instance group

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group you are testing - -
      • - - -
    - - - - - Returns: -
      -
    • - (boolean) - true if the name is registered -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Instances.register(name[, categorise]) -
    -
    -
    -
    - -

    Registers the name of an instance group to allow for storing element instances

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group; must to unique - -
      • - - - - - -
    • - - categorise - - : - - (function) - - function used to turn the element into a string - categorise param - element LuaGuiElement - the gui element to be turned into a string - categorise return - string - the category that the element will be added to like the player's name or force's name - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (string) - the name that was added so it can be used as a variable -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Instances.add_element(name, element) -
    -
    -
    -
    - -

    Adds an element to the instance group under the correct category; must be registered

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group to add the element to - -
      • - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element to add the the instance group - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Instances.get_elements_raw(name[, category]) -
    -
    -
    -
    - -

    Gets all element instances without first removing any invalid ones; used internally and must be registered

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group to get the instances of - -
      • - - - - - -
    • - - category - - : - - (string) - - the category to get the instance from, not needed when no categorise function - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the table of element instances of which some may be invalid -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Instances.get_valid_elements(name[, category][, callback]) -
    -
    -
    -
    - -

    Gets all valid element instances and has the option of running a callback on those that are valid

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group to get the instances of - -
      • - - - - - -
    • - - category - - : - - (string) - - the category to get the instances of, not needed when no categorise function - - (optional) -
      • - - - - - -
    • - - callback - - : - - (function) - - when given the callback will be ran on all valid elements - callback param - element LuaGuiElement - the current valid element - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the table of element instances with all invalid ones removed -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Instances.unregistered_add_element(name, category, element) -
    -
    -
    -
    - -

    A version of add_element that does not require the group to be registered

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group to add the element to - -
      • - - - - - -
    • - - category - - : - - (string or nil) - - the category to add the element to, can be nil but must still be given - -
      • - - - - - -
    • - - element - - : - - (LuaGuiElement) - - the element to add to the instance group - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Instances.unregistered_get_elements(name, category[, callback]) -
    -
    -
    -
    - -

    A version of get_elements that does not require the group to be registered

    -

    - - - Parameters: - -
      - - - - - -
    • - - name - - : - - (string) - - the name of the instance group to get the instances of - -
      • - - - - - -
    • - - category - - : - - (string or nil) - - the category to get the instances of, can be nil but must still be given - -
      • - - - - - -
    • - - callback - - : - - (function) - - when given will be called on all valid instances - callback param - element LuaGuiElement - the current valid element - - (optional) -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the table of element instances with all invalid ones removed -
      • -
    - - - - - - - - - -
    -
    -

    Prototype

    -
    -
    -
    -
    - # - utils.game -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.store -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.instances -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - Constructor.event(event_name) -
    -
    -
    -
    - -

    Creates a new function to add functions to an event handler

    +

    Adds a new event trigger to the concept which can be linked to a factorio event

    @@ -9760,122 +440,25 @@ (string) - the name of the event that callbacks will be added to + the name of the event to add, must be unique, recomented to start with "on_" - - - - - - Returns: -
      -
    • - (function) - the function used to register handlers -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Constructor.extend(new_prototype) -
    -
    -
    -
    - -

    Extents a prototype with the base functions of all gui prototypes, no metatables

    -

    - - - Parameters: - -
      - -
    • - new_prototype + factorio_event : - (table) + (defines.events) - the prototype that you want to add the functions to - -
      • - - -
    - - - - - Returns: -
      -
    • - (table) - the same prototype but with the new functions added -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Constructor.store(sync, callback) -
    -
    -
    -
    - -

    Creates a new function which adds a store to a gui define

    -

    - - - Parameters: - -
      - - - - - -
    • - - sync - - : - - (boolean) - - if the function should create a synced store + when given will fire the custom event when the factorio event is raised + (optional)
      • @@ -9884,102 +467,13 @@
    • - callback + event_condition : (function) - the function called when needing to update the value of an element - -
      • - - -
    - - - - - Returns: -
      -
    • - (function) - the function that will add a store for this define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Constructor.setter(value_type, key[, second_key]) -
    -
    -
    -
    - -

    Creates a setter function that checks the type when a value is set

    -

    - - - Parameters: - -
      - - - - - -
    • - - value_type - - : - - (string) - - the type that the value should be when it is set - -
      • - - - - - -
    • - - key - - : - - (string) - - the key of the define that will be set - -
      • - - - - - -
    • - - second_key - - : - - (string) - - allows for setting of a key in a sub table + used to filter when a factorio event triggers the custom event; if the event contains a reference to an element then names are automatically filtered (optional)
      • @@ -9993,8 +487,8 @@ Returns:
      • - (function) - the function that will check the type and set the value + (GuiConcept) + to allow chaing of functions
      @@ -10004,407 +498,27 @@ + Usage: + 
      
+local custom_button =
+Gui.get_concept('Button'):clone('CustomButton')
+:new_event('on_admin_clicked',defines.events.on_gui_click,function(event)
+    return event.player.admin -- only raise custom event when an admin clicks the button
+end)
    - # - Prototype:uid() + # + Prototype:on_custom_event(handler)
    -

    Gets the uid for the element define

    -

    - - - - - - Returns: -
      -
    • - (string) - the uid of this element define -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Prototype.debug_name -
    -
    -
    -
    - -

    Sets a debug alias for the define

    -

    - - - -
      - - - - - -
    • - - name - - : - - (string) - - the debug name for the element define that can be used to get this element define - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Prototype.set_caption -
    -
    -
    -
    - -

    Sets the caption for the element define

    -

    - - - -
      - - - - - -
    • - - caption - - : - - (string) - - the caption that will be drawn with the element - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Prototype.set_tooltip -
    -
    -
    -
    - -

    Sets the tooltip for the element define

    -

    - - - -
      - - - - - -
    • - - tooltip - - : - - (string) - - the tooltip that will be displayed for this element when drawn - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Prototype.set_pre_authenticator -
    -
    -
    -
    - -

    Sets an authenticator that blocks the draw function if check fails

    -

    - - - -
      - - - - - -
    • - - callback - - : - - (function) - - the function that will be ran to test if the element should be drawn or not - callback param - LuaPlayer player - the player that the element is being drawn to - callback param - string define_name - the name of the define that is being drawn - callback return - boolean - false will stop the element from being drawn - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Prototype.set_post_authenticator -
    -
    -
    -
    - -

    Sets an authenticator that disables the element if check fails

    -

    - - - -
      - - - - - -
    • - - callback - - : - - (function) - - the function that will be ran to test if the element should be enabled or not - callback param - LuaPlayer player - the player that the element is being drawn to - callback param - string define_name - the name of the define that is being drawn - callback return - boolean - false will disable the element - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Prototype.on_draw -
    -
    -
    -
    - -

    Registers a callback to the on_draw event

    -

    - - - -
      - - - - - -
    • - - callback - - : - - (function) - - - callback param - LuaPlayer player - the player that the element was drawn to - callback param - LuaGuiElement element - the element that was drawn - callback param - any ... - any other params passed by the draw_to function - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Prototype.on_style_update -
    -
    -
    -
    - -

    Registers a callback to the on_style_update event

    -

    - - - -
      - - - - - -
    • - - callback - - : - - (function) - - - callback param - LuaStyle style - the style that was changed and/or needs changing - -
      • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - Prototype:set_style(style[, callback]) -
    -
    -
    -
    - -

    Sets the style for the element define

    +

    Adds a custom event handler, replace with the name of the event

    @@ -10418,87 +532,13 @@
  • - style - - : - - (string) - - the style that will be used for this element when drawn - -
    • - - - - - -
  • - - callback + handler : (function) - function is called when element is drawn to alter its style - - (optional) -
    • - - - - - - - - Returns: -
      -
    • - (self) - the element define to allow chaining -
      • -
    - - - - - - - - - -
    -
    -
    -
    - # - Prototype:set_embedded_flow(state) -
    -
    -
    -
    - -

    Sets the element to be drawn inside a nameless flow, can be given a name using a function

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean or function) - - when true a padless flow is created to contain the element + the function which will recive the event
      • @@ -10511,8 +551,8 @@ Returns:
      • - (self) - the element define to allow chaining + (GuiConcept) + to allow chaing of functions
      @@ -10522,6 +562,13 @@ + Usage: + 
      
+local custom_button =
+Gui.get_concept('CustomButton'):clone('MyCustomButton')
+:on_admin_clicked(function(event)
+    game.print(event.player.name..' pressed my admin button')
+end)
    @@ -10529,13 +576,13 @@
    # - Prototype:raise_event(event_name, ...) + Prototype:raise_event(event_name[, event={}][, from_factorio=false])
    -

    Raises a custom event for this define, any number of params can be given

    +

    Raises a custom event, folowing keys included automaticlly: concept, event name, game tick, player from player_index, element if valid

    @@ -10565,13 +612,196 @@
  • - ... + event + + : + + (table) + + table containg data you want to send with the event, some keys already included + + (default: {}) +
    • + + + + + +
  • + + from_factorio + + : + + (boolean) + + internal use, if the raise came from the factorio event handler + + (default: false) +
    • + + + + + + + + + + + + + + + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+-- Note that this is an example and would not work due it expecting a valid element for event.element
+-- this will however work fine if you can provide all expected keys, or its not linked to any factorio event
+custom_button:raise_event('on_admin_clicked',{
+    player_index = game.player.index
+})
    + + +
    +
    +
    +
    + # + Prototype:new_property(property_name, default[, setter_callback]) +
    +
    +
    +
    + +

    Adds a new property to the concept, such as caption, tooltip, or some custom property you want to control

    +

    + + + Parameters: + +
      + + + + + +
    • + + property_name + + : + + (string) + + the name of the new property, must be unique + +
      • + + + + + +
    • + + default : (any) - any params that you want to pass to the event + the default value for this property, although not strictly required is is strongly recomented + +
      • + + + + + +
    • + + setter_callback + + : + + (function) + + this function is called when set is called, if not provided then key in concept.properties is updated to new value + + (optional) +
      • + + +
    + + + + + Returns: +
      +
    • + (GuiConcept) + to allow chaing of functions +
      • +
    + + + + + + + + Usage: + 
    
+local button =
+Gui.get_concept('Button')
+:new_property('tooltip')
+:new_property('caption',nil,function(properties,value)
+    properties.caption = value
+    properties.sprite = nil
+    properties.type = 'button'
+end)
+:new_property('sprite',nil,function(properties,value)
+    properties.image = value
+    properties.caption = nil
+    properties.type = 'sprite-button'
+end)
    + + +
    +
    +
    +
    + # + Prototype:set_custom_property(value) +
    +
    +
    +
    + +

    Sets a new value for a property, triggers setter method if provided, replace with property name

    +

    + + + Parameters: + +
      + + + + + +
    • + + value + + : + + (any) + + the value that you want to set for this property
      • @@ -10584,8 +814,8 @@ Returns:
      • - (number) - the number of handlers that were registered + (GuiConcept) + to allow chaing of functions
      @@ -10595,21 +825,315 @@ + Usage: + 
      
+local custom_button =
+Gui.get_concept('Button')
+:set_caption('Default Button')
      + 
      
+-- In our examples CustomButton is cloned from Button, this means the caption property already exists
+-- note that what ever values that properties have at the time of cloning are also copied
+local custom_button =
+Gui.get_concept('CustomButton')
+:set_caption('Custom Button')
    - # - Prototype:draw_to(element) + # + Prototype:define_draw(draw_callback)
    -

    The main function for defines, when called will draw an instance of this define to the given element - what is drawn is based on the data in draw_data which is set using other functions

    +

    Used to define how the concept is turned into an ingame element or "instance" as we may refer to them

    +

    + + + Parameters: + +
      + + + + + +
    • + + draw_callback + + : + + (function) + + the function that will be called to draw/update the instance; this function must return the instance or the new acting instance + +
      • + + +
    + + + + + Returns: +
      +
    • + (GuiConcept) + to allow chaing of functions +
      • +
    + + + + + + + + Usage: + 
    
+local button =
+Gui.get_concept('Button')
+:define_draw(function(properties,parent,element)
+    -- Note that element might be nil if this is the first draw function
+    -- for this example we assume button was cloned from Prototype and so has no other draw functions defined
+    -- although not shown here you also can recive any extra arguments here from the call to draw
+    if properties.type == 'button' then
+        element = parent.draw{
+            type = properties.type,
+            name = properties.name,
+            caption = properties.caption,
+            tooltip = properties.tooltip
+        }
+
+    else
+        element = parent.draw{
+            type = properties.type,
+            name = properties.name,
+            sprite = properties.sprite,
+            tooltip = properties.tooltip
+        }
+
+    end
+
+    -- We must return the element or what we want to be seen as the instance
+    -- this is so other draw functions have access to it, say if our custom button defined a draw function to change the font color to red
+    return element
+end)
    + + +
    +
    +
    +
    + # + Prototype:draw(parent_element) +
    +
    +
    +
    + +

    Calls all the draw functions in order to create this concept in game; will also store and sync the instance if stores are used

    +

    + + + Parameters: + +
      + + + + + +
    • + + parent_element + + : + + (LuaGuiElement) + + the element that the concept will use as a base + +
      • + + +
    + + + + + Returns: +
      +
    • + (LuaGuiElement) + the element that was created and then passed though and returned by the draw functions +
      • +
    + + + + + + + + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+-- Note that the draw function from button was cloned, so unless we want to alter the base button we dont need a new draw define
+custom_button:draw(game.player.gui.left)
    + + +
    +
    +

    Concept Instances

    +
    +
    +
    +
    + # + Prototype:define_instance_store([category_callback]) +
    +
    +
    +
    + +

    Adds an instance store to the concept; when a new instance is made it is stored so you can access it later

    +

    + + + Parameters: + +
      + + + + + +
    • + + category_callback + + : + + (function) + + when given will act as a way to turn an element into a string to act as a key; keys returned can over lap + + (optional) +
      • + + +
    + + + + + Returns: +
      +
    • + (GuiConcept) + to allow chaing of functions +
      • +
    + + + + + + + + Usage: + 
    
+-- Note even thou this is a copy of Button; if Button had an instance store it would not be cloned over
+local custom_button =
+Gui.get_concept('CustomButton')
+:define_instance_store(function(element)
+    return element.player_index -- The instances are stored based on player id
+end)
    + + +
    +
    +
    +
    + # + Prototype.get_instances([category]) +
    +
    +
    +
    + +

    Gets all insatnces in a category, category may be nil to return all

    +

    + + + Parameters: + +
      + + + + + +
    • + + category + + : + + (string or LuaGuiElement) + + the category to get, can only be nil if categories are not used + + (optional) +
      • + + +
    + + + + + Returns: +
      +
    • + (table) + a table which contains all the instances +
      • +
    + + + + + + + + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+custom_button.get_instances(1) -- player index 1
    + + +
    +
    +
    +
    + # + Prototype.add_instance(element[, category]) +
    +
    +
    +
    + +

    Adds an instance to this concept, used automatically during concept:draw

    @@ -10629,23 +1153,33 @@ (LuaGuiElement) - the element that the define will draw a instance of its self onto + the element that will be added as an instance + + + +
  • + + category + + : + + (string) + + the category to add this element under, if nil the category callback is used to assign one + + (optional) +
    • + + - Returns: - @@ -10653,20 +1187,26 @@ + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+custom_button.add_instance(element) -- normally not needed due to use in concept:draw
    - # - Prototype:get_store(category) + # + Prototype.update_instances([category], update_callback)
    -

    Gets the value in this elements store, category needed if categorize function used

    +

    Applies an update function to all instances, simialr use to what table.forEach would be

    @@ -10684,10 +1224,156 @@ : - (string) + (string or LuaGuiElement) - [opt] the category to get such as player name or force name + the category to get, can only be nil if categories are not used + (optional) + + + + + + +
  • + + update_callback + + : + + (function) + + the function which is called on each instance, recives other args passed to update_instances + +
    • + + + + + + + + + + + + + + + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+-- Change all the instances to have red text for player 1
+custom_button.update_instances(1,function(element)
+    element.style.font_color = {r=1,g=0,b=0}
+end)
    + + +
    +
    +

    Concept Data

    +
    +
    +
    +
    + # + Prototype:define_data_store([category_callback]) +
    +
    +
    +
    + +

    Adds a data store to this concept which allows you to store synced/percistent data between instances

    +

    + + + Parameters: + +
      + + + + + +
    • + + category_callback + + : + + (function) + + when given will act as a way to turn an element into a string to act as a key; keys returned can over lap + + (optional) +
      • + + +
    + + + + + Returns: +
      +
    • + (GuiConcept) + to allow chaing of functions +
      • +
    + + + + + + + + Usage: + 
    
+-- Note even thou this is a copy of Button; if Button had an data store it would not be cloned over
+local custom_button =
+Gui.get_concept('CustomButton')
+:define_data_store(function(element)
+    return element.player_index -- The data is stored based on player id
+end)
    + + +
    +
    +
    +
    + # + Prototype.get_data([category]) +
    +
    +
    +
    + +

    Gets the data that is stored for this category

    +

    + + + Parameters: + +
      + + + + + +
    • + + category + + : + + (string or LuaGuiElement) + + the category to get, can only be nil if categories are not used + + (optional)
      • @@ -10700,7 +1386,7 @@
      • (any) - the value that is stored for this define + the data that you had stored in this location
      @@ -10710,20 +1396,26 @@ + Usage: + 
      
+local custom_button =
+Gui.get_concept('CustomButton')
+
+custom_button.get_data(1) -- player index 1
    - # - Prototype:set_store(category, value) + # + Prototype.set_data([category], value)
    -

    Sets the value in this elements store, category needed if categorize function used

    +

    Sets the data that is stored for this category

    @@ -10741,10 +1433,11 @@ : - (string) + (string or LuaGuiElement) - [opt] the category to get such as player name or force name + the category to set, can only be nil if categories are not used + (optional) @@ -10759,7 +1452,7 @@ (any) - the value to set for this define, must be valid for its type ie for checkbox etc + the data that you want to stored in this location @@ -10769,13 +1462,6 @@ - Returns: -
      -
    • - (boolean) - true if the value was set -
      • -
    @@ -10783,20 +1469,31 @@ + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+-- A table is used to show correct way to use a table with self.update_data
+-- but a table is not required and can be any data, however upvalues may cause desyncs
+custom_button.set_data(1,{
+    clicks = 0,
+    required_clicks = 100
+}) -- player index 1
    - # - Prototype:clear_store([category]) + # + Prototype.clear_data([category])
    -

    Sets the value in this elements store to nil, category needed if categorize function used

    +

    Clears the data that is stored for this category

    @@ -10814,14 +1511,185 @@ : - (string) + (string or LuaGuiElement) - the category to get such as player name or force name + the category to clear, can only be nil if categories are not used (optional) + + + + + + + + + + + + + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+custom_button.clear_data(1) -- player index 1
    + + +
    +
    +
    +
    + # + Prototype.update_data([category], update_callback) +
    +
    +
    +
    + +

    Updates the data that is stored for this category

    +

    + + + Parameters: + +
      + + + + + +
    • + + category + + : + + (string or LuaGuiElement) + + the category to clear, can only be nil if categories are not used + + (optional) +
      • + + + + + +
    • + + update_callback + + : + + (function) + + the function which is called to update the data + +
      • + + +
    + + + + + + + + + + + + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+custom_button.update_data(1,function(tbl)
+    tbl.clicks = tbl.clicks + 1 -- here we are incrementing the clicks by 1
+end) -- player index 1
+
    + 
    
+-- Alterative method more useful when not using a table
+-- so for this example assume that we did custom_button.set_data(1,0)
+custom_button.update_data(1,function(value)
+    return value + 1 -- here we are incrementing the value by 1, we may only be tracking clicks
+end) -- player index 1
    + + +
    +
    +
    +
    + # + Prototype:define_combined_store([category_callback], get_callback, set_callback) +
    +
    +
    +
    + +

    Used to add a both instance and data stores which are linked together, new instances are synced to current value, changing one instances changes them all

    +

    + + + Parameters: + +
      + + + + + +
    • + + category_callback + + : + + (function) + + when given will act as a way to turn an element into a string to act as a key; keys returned can over lap + + (optional) +
      • + + + + + +
    • + + get_callback + + : + + (function) + + the function which is called when you set the store from an instance + +
      • + + + + + +
    • + + set_callback + + : + + (function) + + the function which is called when you update an instance using the value in the store + +
      • + +
    @@ -10830,8 +1698,8 @@ Returns:
    • - (boolean) - true if the value was set + (GuiConcept) + to allow chaing of functions
    @@ -10841,24 +1709,60 @@ + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+:define_combined_store(
+function(element)
+    return element.player_index -- The data is stored based on player id
+end,
+function(element)
+   return element.caption -- We want to store the caption
+end,
+function(element,value)
+    element.caption = value -- This is the inverse of above
+end)
    -
    -

    Test

    -
    - # - expcore.gui + # + Prototype.set_instance_from_store(the)
    +

    Will set the state of an instance based on the value in the store

    +

    + Parameters: + +
      + + + + + +
    • + + the + + : + + (LuaGuiElement) + + element that you want to have update + +
      • + + +
    + @@ -10869,21 +1773,53 @@ + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
+
+-- Used internally when first draw and automatically when the store updates
+custom_button.set_instance_from_store(element)
    - # - expcore.common + # + Prototype.set_store_from_instance(the)
    +

    Will set the value in the store and update the other instances based on the instance given

    +

    + Parameters: + +
      + + + + + +
    • + + the + + : + + (LuaGuiElement) + + element that you want to use to update the store + +
      • + + +
    + @@ -10894,81 +1830,13 @@ - + Usage: + 
    
+local custom_button =
+Gui.get_concept('CustomButton')
 
-
    -
    -
    -
    - # - resources.color_presets -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.event -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.store -
    -
    -
    -
    - - - - - - - - - - - - - +-- You may want to use this with gui events +custom_button.set_store_from_instance(element)
    @@ -10987,7 +1855,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/core/Permissions-Groups.html b/docs/core/Permissions-Groups.html index 28fee091..3a4c5455 100644 --- a/docs/core/Permissions-Groups.html +++ b/docs/core/Permissions-Groups.html @@ -1432,7 +1432,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/core/Roles.html b/docs/core/Roles.html index 0c417381..3354671f 100644 --- a/docs/core/Roles.html +++ b/docs/core/Roles.html @@ -3152,7 +3152,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/core/Store.html b/docs/core/Store.html index e9fb83db..56ffe579 100644 --- a/docs/core/Store.html +++ b/docs/core/Store.html @@ -241,15 +241,19 @@ local team_scores = 'team-scores' -- Setting and getting data is then as simple as +-- note that when storing a table you must use Store.update Store.set(scenario_difficuly,'Hard') Store.set(team_scores,game.player.force.name,20) Store.get(scenario_difficuly) -- returns 'Hard' Store.get(team_scores,game.player.force.name) -- returns 20 +Store.update(team_scores,game.player.force.name,function(value,key) + return value + 10 -- add 10 to the score +end) + -- The reason for using stores over global is the abilty to watch for updates -- for stores to work you must register them, often at the end of the file --- note that storing a table value may cause issues as a key changing does not cause the set function to trigger Store.register(scenario_difficuly,function(value) game.print('Scenario difficulty has been set to: '..value) end) @@ -309,8 +313,12 @@ Store.register(team_scores,function(value,key) Sets the value at a location, this location must be registered - update(location[, key]) - Triggers the change handler manually + update(location[, key][, update_callback]) + Allows for updating a value based on the current value; only valid way to change tables in a store + + + update_all(location[, update_callback]) + Allows for updating all values at a location based on the current value; only valid way to change tables in a store clear(location[, key][, from_sync=false]) @@ -718,13 +726,13 @@ Store.register(team_scores,function(value,key)
    # - update(location[, key]) + update(location[, key][, update_callback])
    -

    Triggers the change handler manually

    +

    Allows for updating a value based on the current value; only valid way to change tables in a store

    @@ -766,6 +774,90 @@ Store.register(team_scores,function(value,key) + + + +
  • + + update_callback + + : + + (function) + + the function called to update the value stored, rtn value to set new value + + (optional) +
    • + + + + + + + + + + + + + + + + +
    +
    +
    +
    + # + update_all(location[, update_callback]) +
    +
    +
    +
    + +

    Allows for updating all values at a location based on the current value; only valid way to change tables in a store

    +

    + + + Parameters: + +
      + + + + + +
    • + + location + + : + + (string) + + the location to set the data to + +
      • + + + + + +
    • + + update_callback + + : + + (function) + + the function called to update the value stored + + (optional) +
      • + +
    @@ -1036,7 +1128,7 @@ Store.register(team_scores,function(value,key) generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/core/Sudo.html b/docs/core/Sudo.html index f1b715fc..75ba5a96 100644 --- a/docs/core/Sudo.html +++ b/docs/core/Sudo.html @@ -544,7 +544,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/guis/Player-List.html b/docs/guis/Player-List.html index 36ffe125..5f4b98d8 100644 --- a/docs/guis/Player-List.html +++ b/docs/guis/Player-List.html @@ -626,7 +626,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/guis/Rocket-Info.html b/docs/guis/Rocket-Info.html index 626e32c8..4419add4 100644 --- a/docs/guis/Rocket-Info.html +++ b/docs/guis/Rocket-Info.html @@ -629,7 +629,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/guis/Science-Info.html b/docs/guis/Science-Info.html index 7f36a267..bb73a355 100644 --- a/docs/guis/Science-Info.html +++ b/docs/guis/Science-Info.html @@ -449,7 +449,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/guis/Task-List.html b/docs/guis/Task-List.html index bb449941..076de4f3 100644 --- a/docs/guis/Task-List.html +++ b/docs/guis/Task-List.html @@ -632,7 +632,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/guis/Warps-List.html b/docs/guis/Warps-List.html index c015334b..ba48ab73 100644 --- a/docs/guis/Warps-List.html +++ b/docs/guis/Warps-List.html @@ -837,7 +837,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/index.html b/docs/index.html index 29d95487..2c08495e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -56,11 +56,7 @@ Gui - Core Module - Gui - - This file is used to require all the different elements of the gui module - - each module has an outline here but for more details see their separate files in ./gui - - please read the files for more documentation that cant be shown here - - please note there is a rework planned but not started + Core Module - Gui Permissions-Groups @@ -514,7 +510,7 @@ see ./expcore/commands.lua for more details generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/modules/Gui.html b/docs/modules/Gui.html index 493c008e..7f2d9a40 100644 --- a/docs/modules/Gui.html +++ b/docs/modules/Gui.html @@ -41,8 +41,7 @@

  • Sections

    • @@ -52,20 +51,6 @@ @@ -237,9 +221,7 @@

    Gui module

    -

    Core Module - Gui - - This file is used to require all the different elements of the gui module - - each module has an outline here but for more details see their separate files in ./gui

    +

    Core Module - Gui

    @@ -254,71 +236,17 @@ -

    Dependencies

    +

    Functions

    - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    expcore.gui.coreon_custom_event(handler)Adds a custom event handler, replace with the name of the event
    expcore.gui.instances
    expcore.gui.elements.buttons
    expcore.gui.elements.checkbox
    expcore.gui.elements.dropdown
    expcore.gui.elements.slider
    expcore.gui.elements.text
    expcore.gui.elements.elem-button
    expcore.gui.elements.progress-bar
    expcore.gui.concepts.toolbar
    expcore.gui.concepts.left
    expcore.gui.concepts.center
    expcore.gui.concepts.popups
    - - -

    Test

    - - - - - - - - - - - - - - - - - + +
    expcore.gui
    expcore.common
    resources.color_presets
    utils.event
    expcore.storeset_custom_property(value)Sets a new value for a property, triggers setter method if provided, replace with property name
    @@ -327,23 +255,56 @@
    -

    Dependencies

    +

    Functions

    - # - expcore.gui.core + # + on_custom_event(handler)
    +

    Adds a custom event handler, replace with the name of the event

    +

    + Parameters: + +
      + + + + + +
    • + + handler + + : + + (function) + + the function which will recive the event + +
      • + + +
    + + Returns: +
      +
    • + (GuiConcept) + to allow chaing of functions +[[@usage +
      • +
    @@ -357,421 +318,51 @@
    - # - expcore.gui.instances -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.buttons -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.checkbox -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.dropdown -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.slider -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.text -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.elem-button -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.elements.progress-bar -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.toolbar -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.left -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.center -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.gui.concepts.popups -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -

    Test

    -
    -
    -
    -
    - # - expcore.gui -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.common -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - resources.color_presets -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - utils.event -
    -
    -
    -
    - - - - - - - - - - - - - - - -
    -
    -
    -
    - # - expcore.store + # + set_custom_property(value)
    +

    Sets a new value for a property, triggers setter method if provided, replace with property name

    +

    + Parameters: + +
      + + + + + +
    • + + value + + : + + (any) + + the value that you want to set for this property + +
      • + + +
    + + Returns: +
      +
    • + (GuiConcept) + to allow chaing of functions +[[@usage +
      • +
    @@ -797,7 +388,7 @@ generated by LDoc
    - Last updated 2019-08-09 17:56:43 UTC + Last updated 2019-08-25 00:34:29 UTC
    diff --git a/docs/modules/control.html b/docs/modules/control.html index be3816d0..5fa17272 100644 --- a/docs/modules/control.html +++ b/docs/modules/control.html @@ -351,7 +351,7 @@ generated by LDoc
    - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
    diff --git a/docs/modules/expcore.gui.html b/docs/modules/expcore.gui.html index 580de83b..78739a7f 100644 --- a/docs/modules/expcore.gui.html +++ b/docs/modules/expcore.gui.html @@ -37,35 +37,13 @@ -

    • Modules

      • control
      • expcore.gui
        • -
      • expcore.gui.concepts.center
        • -
      • expcore.gui.concepts.left
        • -
      • expcore.gui.concepts.popups
        • -
      • expcore.gui.concepts.toolbar
        • -
      • expcore.gui.core
        • -
      • expcore.gui.elements.buttons
        • -
      • expcore.gui.elements.checkbox
        • -
      • expcore.gui.elements.dropdown
        • -
      • expcore.gui.elements.elem-button
        • -
      • expcore.gui.elements.progress-bar
        • -
      • expcore.gui.elements.slider
        • -
      • expcore.gui.elements.text
        • -
      • expcore.gui.instances
        • -
      • expcore.gui.prototype
        • -
      • expcore.gui.test
        • +
      • Gui
      • utils.alien_evolution_progress
      • utils.core
      • utils.debug
        • @@ -212,14 +190,6 @@
        - Top
        @@ -236,8 +206,7 @@

        expcore.gui module

        -

        This file is used to require all the different elements of the gui module - each module has an outline here but for more details see their separate files in ./gui

        +

        This file combines all the other gui files

        @@ -250,389 +219,11 @@ - - -

        Dependencies

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        expcore.gui.core
        expcore.gui.instances
        expcore.gui.elements.buttons
        expcore.gui.elements.checkbox
        expcore.gui.elements.dropdown
        expcore.gui.elements.slider
        expcore.gui.elements.text
        expcore.gui.elements.elem-button
        expcore.gui.elements.progress-bar
        expcore.gui.concepts.toolbar
        expcore.gui.concepts.left
        expcore.gui.concepts.center
        expcore.gui.concepts.popups

        -

        Dependencies

        -
        -
        -
        -
        - # - expcore.gui.core -
        -
        -
        -
        - -

        -

        -[[

        - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.instances -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.elements.buttons -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.elements.checkbox -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.elements.dropdown -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.elements.slider -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.elements.text -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.elements.elem-button -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.elements.progress-bar -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.concepts.toolbar -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.concepts.left -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.concepts.center -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        -
        -
        - # - expcore.gui.concepts.popups -
        -
        -
        -
        - - - - - - - - - - - - - - - -
        -
        @@ -647,7 +238,7 @@ generated by LDoc
        - Last updated 2019-08-09 17:49:43 UTC + Last updated 2019-08-25 00:33:31 UTC
        diff --git a/docs/modules/utils.alien_evolution_progress.html b/docs/modules/utils.alien_evolution_progress.html index e4509aa0..fea3e318 100644 --- a/docs/modules/utils.alien_evolution_progress.html +++ b/docs/modules/utils.alien_evolution_progress.html @@ -419,7 +419,7 @@ fraction will decide a chance to spawn. 1 alien for 2 spawner's will have 50% on generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.core.html b/docs/modules/utils.core.html index fd537648..3ca21622 100644 --- a/docs/modules/utils.core.html +++ b/docs/modules/utils.core.html @@ -1164,7 +1164,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.debug.html b/docs/modules/utils.debug.html index 498ae103..5d26a71d 100644 --- a/docs/modules/utils.debug.html +++ b/docs/modules/utils.debug.html @@ -654,7 +654,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.dump_env.html b/docs/modules/utils.dump_env.html index 10112456..772f991a 100644 --- a/docs/modules/utils.dump_env.html +++ b/docs/modules/utils.dump_env.html @@ -323,7 +323,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.event.html b/docs/modules/utils.event.html index dfe1b7a1..2db04168 100644 --- a/docs/modules/utils.event.html +++ b/docs/modules/utils.event.html @@ -1292,7 +1292,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.event_core.html b/docs/modules/utils.event_core.html index 8f1b30ef..a9251bb1 100644 --- a/docs/modules/utils.event_core.html +++ b/docs/modules/utils.event_core.html @@ -434,7 +434,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.math.html b/docs/modules/utils.math.html index 51094ba3..219edb14 100644 --- a/docs/modules/utils.math.html +++ b/docs/modules/utils.math.html @@ -338,7 +338,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.recipe_locker.html b/docs/modules/utils.recipe_locker.html index 0c008edd..08b3b0dc 100644 --- a/docs/modules/utils.recipe_locker.html +++ b/docs/modules/utils.recipe_locker.html @@ -441,7 +441,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.state_machine.html b/docs/modules/utils.state_machine.html index 675a9678..d609ecb6 100644 --- a/docs/modules/utils.state_machine.html +++ b/docs/modules/utils.state_machine.html @@ -752,7 +752,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.table.html b/docs/modules/utils.table.html index 4d606241..f3b85d5b 100644 --- a/docs/modules/utils.table.html +++ b/docs/modules/utils.table.html @@ -1382,7 +1382,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.task.html b/docs/modules/utils.task.html index b1ec35f6..5284f6e4 100644 --- a/docs/modules/utils.task.html +++ b/docs/modules/utils.task.html @@ -651,7 +651,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/modules/utils.timestamp.html b/docs/modules/utils.timestamp.html index 0cedb708..10e8d500 100644 --- a/docs/modules/utils.timestamp.html +++ b/docs/modules/utils.timestamp.html @@ -442,7 +442,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/topics/license.html b/docs/topics/license.html index fe2b756b..66afe33d 100644 --- a/docs/topics/license.html +++ b/docs/topics/license.html @@ -789,7 +789,7 @@ Public License instead of this License. But first, please read generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/docs/topics/readme.md.html b/docs/topics/readme.md.html index 89cfb497..58c0a663 100644 --- a/docs/topics/readme.md.html +++ b/docs/topics/readme.md.html @@ -332,7 +332,7 @@ generated by LDoc
        - Last updated 2019-08-23 21:40:48 UTC + Last updated 2019-08-25 00:50:15 UTC
        diff --git a/expcore/gui.lua b/expcore/gui.lua index 80b400b3..351eafdc 100644 --- a/expcore/gui.lua +++ b/expcore/gui.lua @@ -1,4 +1,7 @@ ---- This file combines all the other gui files +--[[-- Core Module - Gui + @core Gui + @alias Gui +]] local Gui = require 'expcore.gui.core' diff --git a/expcore/gui/core.lua b/expcore/gui/core.lua index e514d30a..3fa4fa93 100644 --- a/expcore/gui/core.lua +++ b/expcore/gui/core.lua @@ -3,6 +3,10 @@ @alias Gui ]] +--- Core. +-- Functions that act as a landing point for the other funtions +-- @section core + local Event = require 'utils.event' -- @dep utils.event local Prototype = require 'expcore.gui.prototype' @@ -25,4 +29,17 @@ function Gui.get_concept(name) return Gui.concepts[name] or error('Gui concept "'..name..'" is not defind',2) end +function Gui.clone_concept(name,new_name) + local concept = Gui.concepts[name] or error('Gui concept "'..name..'" is not defind',2) + + if Gui.concepts[name] then + error('Gui concept "'..name..'" is already defind',2) + end + + local new_concept = concept:clone(new_name) + Gui.concepts[new_name] = new_concept + + return new_concept +end + return Gui \ No newline at end of file diff --git a/expcore/gui/prototype.lua b/expcore/gui/prototype.lua index 5c9dd9f3..cc84c5eb 100644 --- a/expcore/gui/prototype.lua +++ b/expcore/gui/prototype.lua @@ -2,52 +2,48 @@ @module Gui @alias Prototype - readme define + @usage +local button = +Gui.new_concept('Button') +:new_event('on_click',defines.events.on_gui_click) +:new_property('tooltip') +:new_property('caption',nil,function(properties,value) + properties.caption = value + properties.sprite = nil + properties.type = 'button' +end) +:new_property('sprite',nil,function(properties,value) + properties.image = value + properties.caption = nil + properties.type = 'sprite-button' +end) - local button = - -- starts the defination of a new concept - Gui.new_concept('button') - -- event linked to a factorio event - :new_event('on_click',defines.events.on_gui_click) - -- event linked conditionaly to a factorio event - :new_event('on_admin_click',defines.events.on_gui_click,function(event) - return event.player.admin - end) - -- a property which can be set - :new_property('caption',function(concept,value,...) - concept.draw_data.caption = value - end,"Change Me") - -- the draw function for this concept - :define_draw(function(concept,parent,element,...) - element = - parent.draw{ - name=concept.name, - type='button', - caption=concept.caption - } +local custom_button = +button:clone('CustomButton') +:new_event('on_admin_clicked',defines.events.on_gui_click,function(event) + return event.player.admin -- only raise custom event when an admin clicks the button +end) +:set_caption('Custom Button') +:set_tooltip('Only admins can press this button') +:on_click(function(event) + if not event.player.admin then + event.player.print('You must be admin to use this button') + end +end) +:on_admin_clicked(function(event) + -- Yes i know this can just be an if else but its an example + game.print(event.player.name..' pressed my admin button') +end) - return element - end) - - local toggle_cheat_mode = - -- starts the defination of a new concept based on "button" - button:clone('toggle_cheat_mode') - -- sets the already existing property of "caption" - :set_caption('Toggle Cheat Mode') - -- using the admin click event toggle cheat mode - :on_admin_click(function(event) - event.player.cheat_mode = not event.player.cheat_mode - end) - -- adds a draw event on top of the button draw event, element is now defined - :define_draw(function(concept,parent,element,...) - element.style.font_color = {r=1,g=0,b=0} - end) - - -- draws the toggle cheat mode button, extra arguments can be passed - toggle_cheat_mode:draw(game.player.gui.left,...) +custom_button:draw(game.player.gui.left) ]] +--- Concept Base. +-- Functions that are used to make concepts +-- @section concept-base + local Event = require 'utils.event' -- @dep utils.event +local Store = require 'expcore.store' -- @dep expcore.store local Game = require 'utils.game' -- @dep utils.game local Factorio_Events = {} @@ -57,6 +53,7 @@ local Prototype = { events = {} } +--- Acts as a gernal handler for any factorio event local function factorio_event_handler(event) local element = event.element if element then @@ -64,53 +61,110 @@ local function factorio_event_handler(event) local concept_name = element.name local concept_event = Factorio_Events[event.name][concept_name] concept_event[1]:raise_event(concept_event[2],event,true) + else local events_handlers = Factorio_Events[event.name] for _,concept_event in pairs(events_handlers) do concept_event[1]:raise_event(concept_event[2],event,true) end + end end +--[[-- Used to copy all the settings from one concept to another and removing links to the orginal +@tparam string concept_name the name of the new concept; must be unique +@treturn GuiConcept the base for building a custom gui +@usage +local custom_button = +Gui.get_concept('Button'):clone('CustomButton') +]] function Prototype:clone(concept_name) - local concept = { - name = concept_name, - events = {} - } + local concept = table.deep_copy(self) + -- Replace name of the concept + concept.name = concept_name + concept.properties.name = concept_name + + -- Remove all event handlers that were copied + concept.events = {} for event_name,_ in pairs(self.events) do concept.events[event_name] = {} end - for key,value in pairs(self) do - if not concept[key] then - concept[key] = table.deep_copy(value) - end + -- Remove all refrences to an instance store + if concept.instance_store then + concept.instance_store = nil + concept.get_instances = nil + concept.add_instance = nil + concept.update_instances = nil + end + + -- Remove all refrences to a data store + if concept.data_store then + concept.data_store = nil + concept.get_data = nil + concept.set_data = nil + concept.clear_data = nil + concept.update_data = nil + concept.on_data_store_update = nil + concept.events.on_data_store_update = nil + end + + -- Remove all refrences to a combined store + if concept.set_instance_from_store then + concept.set_instance_from_store = nil + concept.set_store_from_instance = nil end return concept - end +--[[-- Adds a new event trigger to the concept which can be linked to a factorio event +@tparam string event_name the name of the event to add, must be unique, recomented to start with "on_" +@tparam[opt] defines.events factorio_event when given will fire the custom event when the factorio event is raised +@tparam[opt] function event_condition used to filter when a factorio event triggers the custom event; if the event contains a reference to an element then names are automatically filtered +@treturn GuiConcept to allow chaing of functions +@usage +local custom_button = +Gui.get_concept('Button'):clone('CustomButton') +:new_event('on_admin_clicked',defines.events.on_gui_click,function(event) + return event.player.admin -- only raise custom event when an admin clicks the button +end) +]] function Prototype:new_event(event_name,factorio_event,event_condition) + -- Check the event does not already exist if self.events[event_name] then error('Event is already defined',2) end - local handlers = {} - self.events[event_name] = handlers - self[event_name] = function(handler) +--[[-- Adds a custom event handler, replace with the name of the event +@function Prototype:on_custom_event +@tparam function handler the function which will recive the event +@treturn GuiConcept to allow chaing of functions +@usage +local custom_button = +Gui.get_concept('CustomButton'):clone('MyCustomButton') +:on_admin_clicked(function(event) + game.print(event.player.name..' pressed my admin button') +end) +]] + + -- Adds a handler table and the event handler adder, comment above not indented to look better in docs + self.events[event_name] = {} + self[event_name] = function(concept,handler) if type(handler) ~= 'function' then error('Event handler must be a function',2) end + local handlers = concept.events[event_name] handlers[#handlers] = handler - return self + return concept end + -- Adds the factorio event handler if this event is linked to one if factorio_event then - handlers.factorio_handler = event_condition + self.events[event_name].factorio_handler = event_condition if not Factorio_Events[factorio_event] then Factorio_Events[factorio_event] = {} Event.add(factorio_event,factorio_event_handler) @@ -119,26 +173,45 @@ function Prototype:new_event(event_name,factorio_event,event_condition) end return self - end +--[[-- Raises a custom event, folowing keys included automaticlly: concept, event name, game tick, player from player_index, element if valid +@tparam string event_name the name of the event that you want to raise +@tparam[opt={}] table event table containg data you want to send with the event, some keys already included +@tparam[opt=false] boolean from_factorio internal use, if the raise came from the factorio event handler +@usage +local custom_button = +Gui.get_concept('CustomButton') + +-- Note that this is an example and would not work due it expecting a valid element for event.element +-- this will however work fine if you can provide all expected keys, or its not linked to any factorio event +custom_button:raise_event('on_admin_clicked',{ + player_index = game.player.index +}) +]] function Prototype:raise_event(event_name,event,from_factorio) + -- Check that the event exists if not self.events[event_name] then error('Event is not defined',2) end + -- Setup the event table with automatic keys + event = event or {} event.concept = self event.name = event.name or event_name event.tick = event.tick or game.tick event.player = event.player_index and Game.get_player_by_index(event.player_index) or nil if event.element and not event.element.valid then return end + -- Get the event handlers local handlers = self.events[event_name] + -- If it is from factorio and the filter fails if from_factorio and handlers.factorio_handler and not handlers.factorio_handler(event) then return end + -- Trigger every handler for _,handler in ipairs(handlers) do local success, err = pcall(handler,event) if not success then @@ -147,50 +220,408 @@ function Prototype:raise_event(event_name,event,from_factorio) end end +--[[-- Adds a new property to the concept, such as caption, tooltip, or some custom property you want to control +@tparam string property_name the name of the new property, must be unique +@tparam any default the default value for this property, although not strictly required is is strongly recomented +@tparam[opt] function setter_callback this function is called when set is called, if not provided then key in concept.properties is updated to new value +@treturn GuiConcept to allow chaing of functions +@usage +local button = +Gui.get_concept('Button') +:new_property('tooltip') +:new_property('caption',nil,function(properties,value) + properties.caption = value + properties.sprite = nil + properties.type = 'button' +end) +:new_property('sprite',nil,function(properties,value) + properties.image = value + properties.caption = nil + properties.type = 'sprite-button' +end) +]] function Prototype:new_property(property_name,default,setter_callback) + -- Check that the property does not already exist if self.properties[property_name] then error('Property is already defined',2) end + -- Set the property to its default self.properties[property_name] = default - self['set_'..property_name] = function(value,...) +--[[-- Sets a new value for a property, triggers setter method if provided, replace with property name +@function Prototype:set_custom_property +@tparam any value the value that you want to set for this property +@treturn GuiConcept to allow chaing of functions +@usage +local custom_button = +Gui.get_concept('Button') +:set_caption('Default Button') + +@usage +-- In our examples CustomButton is cloned from Button, this means the caption property already exists +-- note that what ever values that properties have at the time of cloning are also copied +local custom_button = +Gui.get_concept('CustomButton') +:set_caption('Custom Button') +]] + + self['set_'..property_name] = function(concept,value,...) if setter_callback then - local success, err = pcall(setter_callback,value,...) + -- Call the setter method to update values if present + local success, err = pcall(setter_callback,concept.properties,value,...) if not success then - print('Gui property handler error with '..self.name..'/'..property_name..': '..err) + print('Gui property handler error with '..concept.name..'/'..property_name..': '..err) end else - self.properties[property_name] = value + -- Otherwise just update the key + concept.properties[property_name] = value end - return self + return concept end return self - end +--[[-- Used to define how the concept is turned into an ingame element or "instance" as we may refer to them +@tparam function draw_callback the function that will be called to draw/update the instance; this function must return the instance or the new acting instance +@treturn GuiConcept to allow chaing of functions +@usage +local button = +Gui.get_concept('Button') +:define_draw(function(properties,parent,element) + -- Note that element might be nil if this is the first draw function + -- for this example we assume button was cloned from Prototype and so has no other draw functions defined + -- although not shown here you also can recive any extra arguments here from the call to draw + if properties.type == 'button' then + element = parent.draw{ + type = properties.type, + name = properties.name, + caption = properties.caption, + tooltip = properties.tooltip + } + + else + element = parent.draw{ + type = properties.type, + name = properties.name, + sprite = properties.sprite, + tooltip = properties.tooltip + } + + end + + -- We must return the element or what we want to be seen as the instance + -- this is so other draw functions have access to it, say if our custom button defined a draw function to change the font color to red + return element +end) +]] function Prototype:define_draw(draw_callback) + -- Check that it is a function that is being added if type(draw_callback) ~= 'function' then error('Draw define must be a function',2) end + -- Add the draw function self.draw_callbacks[#self.draw_callbacks+1] = draw_callback return self end +--[[-- Calls all the draw functions in order to create this concept in game; will also store and sync the instance if stores are used +@tparam LuaGuiElement parent_element the element that the concept will use as a base +@treturn LuaGuiElement the element that was created and then passed though and returned by the draw functions +@usage +local custom_button = +Gui.get_concept('CustomButton') + +-- Note that the draw function from button was cloned, so unless we want to alter the base button we dont need a new draw define +custom_button:draw(game.player.gui.left) +]] function Prototype:draw(parent_element,...) local element + + -- Loop over all the draw defines, element is updated when a value is returned for _,draw_callback in pairs(self.draw_callbacks) do - local success, rtn = pcall(draw_callback,concept,parent_element,element,...) + local success, rtn = pcall(draw_callback,self.properties,parent_element,element,...) if success and rtn then element = rtn elseif not success then print('Gui draw handler error with '..self.name..': '..rtn) end end + + -- Adds the instance if instance store is used + if self.add_instance then + self.add_instance(element) + end + + -- Syncs the instance if there is a combined store + if self.set_instance_from_store then + self.set_instance_from_store(element) + end + + return element +end + +--- Concept Instances. +-- Functions that are used to make store concept instances +-- @section concept-instances + +--[[-- Adds an instance store to the concept; when a new instance is made it is stored so you can access it later +@tparam[opt] function category_callback when given will act as a way to turn an element into a string to act as a key; keys returned can over lap +@treturn GuiConcept to allow chaing of functions +@usage +-- Note even thou this is a copy of Button; if Button had an instance store it would not be cloned over +local custom_button = +Gui.get_concept('CustomButton') +:define_instance_store(function(element) + return element.player_index -- The instances are stored based on player id +end) +]] +function Prototype:define_instance_store(category_callback) + self.instance_store = Store.register('gui_instances_'..self.name) + + local valid_category = category_callback and type(category_callback) == 'function' + local function get_category(category) + return valid_category and type(category) == 'table' and category_callback(category) or category + end + +--[[-- Gets all insatnces in a category, category may be nil to return all +@function Prototype.get_instances +@tparam[opt] ?string|LuaGuiElement category the category to get, can only be nil if categories are not used +@treturn table a table which contains all the instances +@usage +local custom_button = +Gui.get_concept('CustomButton') + +custom_button.get_instances(1) -- player index 1 +]] + function self.get_instances(category) + return Store.get(self.instance_store,get_category(category)) + end + +--[[-- Adds an instance to this concept, used automatically during concept:draw +@function Prototype.add_instance +@tparam LuaGuiElement element the element that will be added as an instance +@tparam[opt] string category the category to add this element under, if nil the category callback is used to assign one +@usage +local custom_button = +Gui.get_concept('CustomButton') + +custom_button.add_instance(element) -- normally not needed due to use in concept:draw +]] + function self.add_instance(element,category) + category = category or get_category(element) + if not valid_category then category = nil end + return Store.update(self.instance_store,category,function(tbl) + if type(tbl) ~= 'table' then + return {element} + else + table.insert(tbl,element) + end + end) + end + +--[[-- Applies an update function to all instances, simialr use to what table.forEach would be +@function Prototype.update_instances +@tparam[opt] ?string|LuaGuiElement category the category to get, can only be nil if categories are not used +@tparam function update_callback the function which is called on each instance, recives other args passed to update_instances +@usage +local custom_button = +Gui.get_concept('CustomButton') + +-- Change all the instances to have red text for player 1 +custom_button.update_instances(1,function(element) + element.style.font_color = {r=1,g=0,b=0} +end) +]] + function self.update_instances(category,update_callback,...) + local arg1 + if type(category) == 'function' then + arg1 = update_callback + update_callback = category + category = nil + end + + local instances = Store.get(self.instance_store,get_category(category)) + for key,instance in pairs(instances) do + if not instance or not instance.valid then + instances[key] = nil + end + + update_callback(instance,arg1,...) + end + end + + return self +end + +--- Concept Data. +-- Functions that are used to store concept data +-- @section concept-data + +--[[-- Adds a data store to this concept which allows you to store synced/percistent data between instances +@tparam[opt] function category_callback when given will act as a way to turn an element into a string to act as a key; keys returned can over lap +@treturn GuiConcept to allow chaing of functions +@usage +-- Note even thou this is a copy of Button; if Button had an data store it would not be cloned over +local custom_button = +Gui.get_concept('CustomButton') +:define_data_store(function(element) + return element.player_index -- The data is stored based on player id +end) +]] +function Prototype:define_data_store(category_callback) + self:new_event('on_data_store_update') + self.data_store = Store.register('gui_data_'..self.name,function(value,key) + self:raise_event('on_data_store_update',{ + category = key, + value = value + }) + end) + + local valid_category = category_callback and type(category_callback) == 'function' + local function get_category(category) + return valid_category and type(category) == 'table' and category_callback(category) or category + end + +--[[-- Gets the data that is stored for this category +@function Prototype.get_data +@tparam[opt] ?string|LuaGuiElement category the category to get, can only be nil if categories are not used +@treturn any the data that you had stored in this location +@usage +local custom_button = +Gui.get_concept('CustomButton') + +custom_button.get_data(1) -- player index 1 +]] + function self.get_data(category) + return Store.get(self.data_store,get_category(category)) + end + +--[[-- Sets the data that is stored for this category +@function Prototype.set_data +@tparam[opt] ?string|LuaGuiElement category the category to set, can only be nil if categories are not used +@tparam any value the data that you want to stored in this location +@usage +local custom_button = +Gui.get_concept('CustomButton') + +-- A table is used to show correct way to use a table with self.update_data +-- but a table is not required and can be any data, however upvalues may cause desyncs +custom_button.set_data(1,{ + clicks = 0, + required_clicks = 100 +}) -- player index 1 +]] + function self.set_data(category,value) + return Store.set(self.data_store,get_category(category),value) + end + +--[[-- Clears the data that is stored for this category +@function Prototype.clear_data +@tparam[opt] ?string|LuaGuiElement category the category to clear, can only be nil if categories are not used +@usage +local custom_button = +Gui.get_concept('CustomButton') + +custom_button.clear_data(1) -- player index 1 +]] + function self.clear_data(category) + return Store.clear(self.data_store,get_category(category)) + end + +--[[-- Updates the data that is stored for this category +@function Prototype.update_data +@tparam[opt] ?string|LuaGuiElement category the category to clear, can only be nil if categories are not used +@tparam function update_callback the function which is called to update the data +@usage +local custom_button = +Gui.get_concept('CustomButton') + +custom_button.update_data(1,function(tbl) + tbl.clicks = tbl.clicks + 1 -- here we are incrementing the clicks by 1 +end) -- player index 1 + +@usage +-- Alterative method more useful when not using a table +-- so for this example assume that we did custom_button.set_data(1,0) +custom_button.update_data(1,function(value) + return value + 1 -- here we are incrementing the value by 1, we may only be tracking clicks +end) -- player index 1 +]] + function self.update_data(category,update_callback,...) + return Store.update(self.data_store,get_category(category),update_callback,...) + end + + return self +end + +--[[-- Used to add a both instance and data stores which are linked together, new instances are synced to current value, changing one instances changes them all +@tparam[opt] function category_callback when given will act as a way to turn an element into a string to act as a key; keys returned can over lap +@tparam function get_callback the function which is called when you set the store from an instance +@tparam function set_callback the function which is called when you update an instance using the value in the store +@treturn GuiConcept to allow chaing of functions +@usage +local custom_button = +Gui.get_concept('CustomButton') +:define_combined_store( +function(element) + return element.player_index -- The data is stored based on player id +end, +function(element) + return element.caption -- We want to store the caption +end, +function(element,value) + element.caption = value -- This is the inverse of above +end) +]] +function Prototype:define_combined_store(category_callback,get_callback,set_callback) + if set_callback == nil then + set_callback = get_callback + get_callback = category_callback + category_callback = nil + end + + self:define_data_store(category_callback) + self:define_instance_Store(category_callback) + + -- Will update all instances when the data store updates + self:on_data_store_update(function(event) + self.update_instances(event.category,set_callback,event.value) + end) + +--[[-- Will set the state of an instance based on the value in the store +@function Prototype.set_instance_from_store +@tparam LuaGuiElement the element that you want to have update +@usage +local custom_button = +Gui.get_concept('CustomButton') + +-- Used internally when first draw and automatically when the store updates +custom_button.set_instance_from_store(element) +]] + function self.set_instance_from_store(element) + set_callback(element,self.get_data(element)) + end + +--[[-- Will set the value in the store and update the other instances based on the instance given +@function Prototype.set_store_from_instance +@tparam LuaGuiElement the element that you want to use to update the store +@usage +local custom_button = +Gui.get_concept('CustomButton') + +-- You may want to use this with gui events +custom_button.set_store_from_instance(element) +]] + function self.set_store_from_instance(element) + self.set_data(element,get_callback(element)) + end + + return self end return Prototype \ No newline at end of file diff --git a/expcore/store.lua b/expcore/store.lua index 6bc00f4b..44f29767 100644 --- a/expcore/store.lua +++ b/expcore/store.lua @@ -11,15 +11,19 @@ local scenario_difficuly = Store.uid_location() local team_scores = 'team-scores' -- Setting and getting data is then as simple as +-- note that when storing a table you must use Store.update Store.set(scenario_difficuly,'Hard') Store.set(team_scores,game.player.force.name,20) Store.get(scenario_difficuly) -- returns 'Hard' Store.get(team_scores,game.player.force.name) -- returns 20 +Store.update(team_scores,game.player.force.name,function(value,key) + return value + 10 -- add 10 to the score +end) + -- The reason for using stores over global is the abilty to watch for updates -- for stores to work you must register them, often at the end of the file --- note that storing a table value may cause issues as a key changing does not cause the set function to trigger Store.register(scenario_difficuly,function(value) game.print('Scenario difficulty has been set to: '..value) end) @@ -152,20 +156,67 @@ function Store.set(location,key,value,from_sync) return true end ---- Triggers the change handler manually +--- Allows for updating a value based on the current value; only valid way to change tables in a store -- @tparam string location the location to set the data to -- @tparam[opt] string key the key location if required -function Store.update(location,key) +-- @tparam[opt] function update_callback the function called to update the value stored, rtn value to set new value +function Store.update(location,key,update_callback,...) local value = Store.get(location,key) - script.raise_event(Store.events.on_value_changed,{ - tick=game.tick, - location=location, - key=key, - value=value, - from_sync=false - }) + + local arg1 + if type(key) == 'function' then + arg1 = update_callback + update_callback = key + key = nil + end + + local rtn + if update_callback and type(update_callback) == 'function' then + rtn = update_callback(value,key,arg1,...) + end + + if rtn then + Store.set(location,key,rtn) + else + script.raise_event(Store.events.on_value_changed,{ + tick=game.tick, + location=location, + key=key, + value=value, + from_sync=false + }) + end + end +--- Allows for updating all values at a location based on the current value; only valid way to change tables in a store +-- @tparam string location the location to set the data to +-- @tparam[opt] function update_callback the function called to update the value stored +function Store.update_all(location,update_callback,...) + local data = Store.get(location) + + error_not_table(data) + + for key,value in pairs(data) do + local rtn + if update_callback and type(update_callback) == 'function' then + rtn = update_callback(value,key,...) + end + + if rtn then + Store.set(location,key,rtn) + else + script.raise_event(Store.events.on_value_changed,{ + tick=game.tick, + location=location, + key=key, + value=value, + from_sync=false + }) + end + end + +end --- Sets the value at a location to nil, this location must be registered -- @tparam string location the location to set the data to