aperx/factorio-scenario-ExpCluster
1
0
Fork 0
mirror of https://github.com/PHIDIAS0303/ExpCluster.git synced 2025-12-27 11:35:22 +09:00
Code Issues Packages Projects Releases Wiki Activity

Cleaned core gui files

Browse Source
This commit is contained in:
Cooldude2606
2020-03-17 22:36:52 +00:00
parent a367d83144
commit c2c535848d
11 changed files with 250 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
expcore/gui/helper_functions.lua
View File

@@ -1,5 +1,5 @@
--[[-- Core Module - Gui
- Used to define new gui elements and gui event handlers
- Functions used to help with the use of guis
@module Gui
]]
@@ -9,7 +9,7 @@ local Gui = require 'expcore.gui.prototype'
-- @section helperFunctions
--[[-- Get the player that owns a gui element
@tparam LuaGuiElement element the element that you want to get the owner of
@tparam LuaGuiElement element the element to get the owner of
@treturn LuaPlayer the player that owns this element
@usage-- Geting the owner of an element
@@ -22,8 +22,8 @@ function Gui.get_player_from_element(element)
end
--[[-- Will toggle the enabled state of an element or set it to the one given
@tparam LuaGuiElement element the element that you want to toggle the state of
@tparam[opt] boolean state the state that you want to set
@tparam LuaGuiElement element the element to toggle/set the enabled state of
@tparam[opt] boolean state with given will set the state, else state will be toggled
@treturn boolean the new enabled state that the element has
@usage-- Toggling the the enabled state
@@ -38,8 +38,8 @@ function Gui.toggle_enabled_state(element,state)
end
--[[-- Will toggle the visible state of an element or set it to the one given
@tparam LuaGuiElement element the element that you want to toggle the state of
@tparam[opt] boolean state the state that you want to set
@tparam LuaGuiElement element the element to toggle/set the visible state of
@tparam[opt] boolean state with given will set the state, else state will be toggled
@treturn boolean the new visible state that the element has
@usage-- Toggling the the visible state
@@ -53,11 +53,11 @@ function Gui.toggle_visible_state(element,state)
return state
end
--[[-- Destory a gui element without causing any errors, likly if the element may have already been removed
--[[-- Destory a gui element without causing any errors, often because the element was already removed
@tparam LuaGuiElement element the element that you want to remove
@treturn boolean true if the element was valid and has been removed
@usage-- Likely use case for element not existing
@usage-- Remove a child element if it exists
Gui.destroy_if_valid(element[child_name])
]]
@@ -67,7 +67,7 @@ function Gui.destroy_if_valid(element)
return true
end
--[[-- Returns a table to be used as a style on sprite buttons, produces a sqaure button
--[[-- Returns a table to be used as the style for a sprite buttons, produces a sqaure button
@tparam number size the size that you want the button to be
@tparam[opt=-2] number padding the padding that you want on the sprite
@tparam[opt] table style any extra style settings that you want to have