factorio-scenario-ExpCluster/locale/ExpGaming-Core/ExpGaming - Rank Control.lua

--[[
Explosive Gaming

This file can be used with permission but this and the credit below must remain in the file.
Contact a member of management on our discord to seek permission to use our code.
Any changes that you may make to the code are yours but that does not make the script yours.
Discord: https://discord.gg/XSsBV6b

The credit below may be used by another script do not remove.
]]
local credits = {{
	name='Explosive Gaming Rank System',
	owner='Explosive Gaming',
	dev='Cooldude2606',
	description='The very core upon which all of the others are based on',
	factorio_version='0.15.23',
	show=true
	}}
local function credit_loop(reg) for _,cred in pairs(reg) do table.insert(credits,cred) end end
--Please Only Edit Below This Line-----------------------------------------------------------
--Return the rank of a given player
function get_rank(player)
	if player then
		for _,rank in pairs(get_ranks()) do
			if player.permission_group == game.permissions.get_group(rank.name) then return rank end
		end
		return string_to_rank('Guest')
	end
end
--Convert the name of a rank into the rank object
function string_to_rank(string)
	if type(string) == 'string' then
		local found_ranks={}
		for _,rank in pairs(get_ranks()) do
			if rank.name:lower() == string:lower() then return rank end
			if rank.name:lower():find(string:lower()) then table.insert(found_ranks,rank) end
		end
		if #found_ranks == 1 then return found_ranks[1] end
	end
end
--Send a message to all members of this rank and above, if no rank given default is mod
--inv sends message to all lower ranks rather than higher
function rank_print(msg, rank, inv)
	local rank = string_to_rank(rank) or string_to_rank('Mod') -- default mod or higher
	local inv = inv or false
	for _, player in pairs(game.players) do
		--this part uses sudo to soread it other many ticks
		player_rank_power = get_rank(player).power
		if inv then
			sudo(function(player_rank_power,rank)
				if player_rank_power >= rank.power then player.print(('[Everyone]: '..msg)) end
			end,{player_rank_power,rank})
		else
			sudo(function(player_rank_power,rank)
				if player_rank_power <= rank.power then
					if rank.short_hand ~= '' then player.print(('['..(rank.short_hand)..']: '..msg)) else player.print(('[Everyone]: '..msg)) end 
				end
			end,{player_rank_power,rank})
		end
	end
end
--Give the user their new rank and raise the Event.rank_change event
function give_rank(player,rank,by_player)
	local by_player = by_player or 'server'
	local rank = string_to_rank(rank) or rank or string_to_rank('Guest')
	local old_rank = get_rank(player)
	-- to reducse lag if the ranks are all ready given it does not cheak
	if old_rank == rank then return end
	--messaging
	local message = 'demoted'
	if rank.power <= old_rank.power then message = 'promoted' end
	if by_player.name then 
		rank_print(player.name..' was '..message..' to '..rank.name..' by '..by_player.name,'Guest')
	else
		rank_print(player.name..' was '..message..' to '..rank.name..' by <server>','Guest')
	end
	if rank.name ~= 'Guest' then player.print('You have been given the '..rank.name..' Rank!') end
	if player.tag ~= old_rank.tag and player.tag ~= '' then player.print('Your Tag was reset due to a Rank change') end
	--rank change
	player.permission_group = game.permissions.get_group(rank.name)
	player.tag = get_rank(player).tag
	if old_rank.name ~= 'Jail' then global.old_ranks[player.index]=old_rank.name end
	script.raise_event(Event.rank_change, {player=player, by_player=by_player, new_rank=rank, old_rank=old_rank})
end
--Revert the user's rank to what it was before the lastest change
function revert_rank(player,by_player)
	local rank = string_to_rank(global.old_ranks[player.index])
	give_rank(player,rank,by_player)
end
--Give the player a new rank based on playtime and/or preset ranks
function find_new_rank(player)
	local function loop_preset_rank(players,rank)
		for _,p in pairs(players) do
			if player.name:lower() == p:lower() then return rank end
		end
	end
	local current_rank = get_rank(player)
	local old_rank = get_rank(player)
	local possible_ranks = {current_rank}
	--Loop through preset ranks only if playtime is less than 5 minutes
	if tick_to_min(player.online_time) < 5 then
		for rank,players in pairs(global.preset_ranks) do
			local found_rank = loop_preset_rank(players, rank)
			if found_rank then table.insert(possible_ranks,string_to_rank(found_rank)) break end
		end
	end
	-- to reduce lag if the player is already higher than any time rank then it does not cheak
	-- also there play time must be higher than the lowest required for a rank
	if current_rank.power > global.ranks.highest_timed_rank.power and player.online_time >= global.ranks.lowest_time_for_rank.time then
		--Loop through rank times
		for _,rank in pairs(get_ranks()) do 
			if rank.time and tick_to_min(player.online_time) >= rank.time then table.insert(possible_ranks,string_to_rank(rank)) end
		end
	end
	--Loop through possible ranks
	if current_rank.name ~='Jail' then 
		local highest_rank = possible_ranks[1]
		for _,rank in pairs(possible_ranks) do
			if rank.power < highest_rank.power then highest_rank = rank end
		end
		--Give player new rank if availble
		if highest_rank.name == 'Guest' then
			-- to avoid spam in chat
			player.permission_group=game.permissions.get_group('Guest')
			script.raise_event(Event.rank_change, {player=player, by_player='server', new_rank=string_to_rank('Guest'), old_rank=string_to_rank('Guest')})
		else
			if highest_rank ~= current_rank then give_rank(player,highest_rank) end
		end
	end
	--Lose ends
	if get_rank(player).power <= string_to_rank('mod').power and not player.admin then rank_print(player.name..' needs to be promoted.') end
	if old_rank.name ~= get_rank(player).name then global.old_ranks[player.index]=old_rank.name end
end
-- returns a list with every players current rank, or just the players of the rank given, includes online time
function get_ranked_players(rank)
	local to_return = {}
	for _,player in pairs(game.players) do 
		if not rank or rank == get_rank(player).name then 
			table.insert(to_return,{player.name,tick_to_display_format(player.online_time),get_rank(player).name})
		end
	end
	return to_return
end
--Event handlers  
Event.rank_change = script.generate_event_name()
Event.register(Event.rank_change,function(event)
	if event.new_rank == event.old_rank then return end
	if event.by_player == 'server' then
		game.write_file('rank-change.log','\n'..game.tick..' Player: '..event.player.name..' Was given rank: '..event.new_rank.name..' By: <server> Their rank was: '..event.old_rank.name, true, 0)
	else
		game.write_file('rank-change.log','\n'..game.tick..' Player: '..event.player.name..' Was given rank: '..event.new_rank.name..' By: '..event.by_player.name..' Their rank was: '..event.old_rank.name, true, 0)	
	end
end)
Event.register(-1,function() 
	global.old_ranks = {} 
	for _,rank in pairs(get_ranks()) do
		game.permissions.create_group(rank.name)
		for _,toRemove in pairs(rank.disallow) do
			game.permissions.get_group(rank.name).set_allows_action(defines.input_action[toRemove],false)
		end
	end
end)
Event.register(defines.events.on_player_joined_game,function(event) find_new_rank(game.players[event.player_index]) end)
--Please Only Edit Above This Line-----------------------------------------------------------
return credits