Change to sync docs

This commit is contained in:
Cooldude2606
2018-05-31 00:45:42 +01:00
parent 2dd50c8d9c
commit 153c6af18f
29 changed files with 1007 additions and 1769 deletions

View File

@@ -4,11 +4,11 @@
-- @author Cooldude2606
-- @license https://github.com/explosivegaming/scenario/blob/master/LICENSE
-- this file will be loaded when ExpGamingCore/Ranking is present
--- This file will be loaded when ExpGamingCore/Ranking is present
-- @function _comment
--- Used as a redirect to Ranking._base_preset that will set the rank given to a player apon joining
-- @usage Sync.set_ranks{player_name=rank_name,...}
-- @see Ranking._base_preset
function Sync.set_ranks(...)
Ranking._base_preset(...)
end
@@ -30,8 +30,7 @@ function Sync.count_ranks()
return _ranks
end
--- Adds a caption to the info gui that shows the rank given to the player
-- @local callback for Sync.add_to_gui
-- Adds a caption to the info gui that shows the rank given to the player
if Sync.add_to_gui then
Sync.add_to_gui(function(player,frame)
return 'You have been assigned the rank \''..Ranking.get_rank(player).name..'\''