aperx/factorio-scenario-ExpCluster
1
0
Fork 0
mirror of https://github.com/PHIDIAS0303/ExpCluster.git synced 2025-12-31 13:01:39 +09:00
Code Issues Packages Projects Releases Wiki Activity

Better Comments On Sync.lua

Browse Source
This commit is contained in:
Cooldude2606
2018-04-08 17:01:14 +01:00
parent 6f7e4d5560
commit e5c51e8265
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
ExpCore/sync.lua
View File

@@ -11,7 +11,8 @@ Discord: https://discord.gg/r6dC2uK
local Sync = {} local Sync = {}
local Sync_gui_functions = {} local Sync_gui_functions = {}
-- only used as a faster way to get to the ranking function --- Used as a faster way to get to the ranking function, overrides previous
-- @usage Sync.set_ranks{name=rank_name}
function Sync.set_ranks(...) function Sync.set_ranks(...)
Ranking._base_preset(...) Ranking._base_preset(...)
end end
@@ -237,25 +238,36 @@ Event.register(defines.events.on_tick,function(event)
if (event.tick%time)==0 then Sync.update() Sync.emit_data() end if (event.tick%time)==0 then Sync.update() Sync.emit_data() end
end) end)
--- Adds a emeltent to the sever info gui
-- @usage Sync.add_to_gui('string') -- return trues
-- @param element see examples before for what can be used, it can also be a return from Gui.inputs.add
-- @treturn bolean based on weather it was successful or not
function Sync.add_to_gui(element,...) function Sync.add_to_gui(element,...)
if game then return end if game then return false end
if is_type(element,'function') then if is_type(element,'function') then
table.insert(Sync_gui_functions,{'function',element,...}) table.insert(Sync_gui_functions,{'function',element,...})
elseif is_type(element,'table') then elseif is_type(element,'table') then
if element.draw then table.insert(Sync_gui_functions,{'gui',element}) if element.draw then table.insert(Sync_gui_functions,{'gui',element})
else table.insert(Sync_gui_functions,{'table',element}) end else table.insert(Sync_gui_functions,{'table',element}) end
else table.insert(Sync_gui_functions,{'string',element}) end else table.insert(Sync_gui_functions,{'string',element}) end
return true
end end
-- Examples for Sync.add_to_gui -- Examples for Sync.add_to_gui
-- adds a basic string to the table
Sync.add_to_gui('Welcome to the Explosive Gaming comunity! This is one of many servers which we host.') Sync.add_to_gui('Welcome to the Explosive Gaming comunity! This is one of many servers which we host.')
-- adds a string that can have depentant values
Sync.add_to_gui(function(player,frame) Sync.add_to_gui(function(player,frame)
return 'This server will reset at: '..Sync.info().reset_time return 'This server will reset at: '..Sync.info().reset_time
end) end)
-- adds a string that can have depentant values
Sync.add_to_gui(function(player,frame) Sync.add_to_gui(function(player,frame)
return 'You have been given the rank '..Ranking.get_rank(player).name..' from our Discord' return 'You have been given the rank '..Ranking.get_rank(player).name..' from our Discord'
end) end)
-- if readme is included then see addons/guis/readme.lua for more examples
-- used to load the gui infomation when _G.Gui is not yet loaded
-- internal use not recomend to be used
function Sync._load() function Sync._load()
Gui.center.add{ Gui.center.add{
name='server-info', name='server-info',
@@ -303,6 +315,7 @@ function Sync._load()
end} end}
end end
-- opens the server info gui for all new joins except admins
Event.register(defines.events.on_player_joined_game,function(event) Event.register(defines.events.on_player_joined_game,function(event)
local player = Game.get_player(event) local player = Game.get_player(event)
if not player.admin and player.online_time < 60 then if not player.admin and player.online_time < 60 then