diff --git a/modules/addons/jail-control.lua b/modules/addons/jail-control.lua index b743e1b7..a65d6c2e 100644 --- a/modules/addons/jail-control.lua +++ b/modules/addons/jail-control.lua @@ -5,7 +5,11 @@ local move_items = ext_require('expcore.common','move_items') local Public = { old_roles = {}, - temp_bans = {} + temp_bans = {}, + player_jailed=script.generate_event_name(), + player_unjailed=script.generate_event_name(), + player_temp_banned=script.generate_event_name(), + player_clear_temp_ban=script.generate_event_name() } Global.register({ Public.old_roles, @@ -15,6 +19,16 @@ Global.register({ Public.temp_bans=tbl[2] end) +local function event_emit(event,player,by_player_name,reason) + script.raise_event(event,{ + name=event, + tick=game.tick, + player_index=player.index, + by_player_name=by_player_name, + reason=reason + }) +end + --- Jails a player, this is only the logic there is no output to players -- @tparam player LuaPlayer the player that will be jailed, must not be in jail -- @tparam[opt=''] by_player_name string the name of the player doing the action used in logs @@ -27,6 +41,7 @@ function Public.jail_player(player,by_player_name) Public.old_roles[player.name] = old_roles Roles.unassign_player(player,old_roles,by_player_name,true) Roles.assign_player(player,'Jail',by_player_name,true) + event_emit(Public.player_jailed,player,by_player_name) return #old_roles end @@ -41,6 +56,7 @@ function Public.unjail_player(player,by_player_name) local old_roles = Public.old_roles[player.name] Roles.unassign_player(player,'Jail',by_player_name,true) Roles.assign_player(player,old_roles,by_player_name,true) + event_emit(Public.player_unjailed,player,by_player_name) return #old_roles end @@ -59,6 +75,7 @@ function Public.temp_ban_player(player,by_player_name,reason) local inv = player.get_main_inventory() move_items(inv.get_contents()) inv.clear() + event_emit(Public.player_temp_banned,player,by_player_name,reason) return true end @@ -72,6 +89,7 @@ function Public.clear_temp_ban_player(player,by_player_name) if not Public.temp_bans[player.name] then return end Public.unjail_player(player,by_player_name) Public.temp_bans[player.name] = nil + event_emit(Public.player_clear_temp_ban,player,by_player_name) return true end diff --git a/modules/addons/reports-control.lua b/modules/addons/reports-control.lua new file mode 100644 index 00000000..eacb212b --- /dev/null +++ b/modules/addons/reports-control.lua @@ -0,0 +1,132 @@ +local Game = require 'utils.game' +local Global = require 'utils.global' + +local Public = { + user_reports={}, + player_report_added = script.generate_event_name(), + player_report_removed = script.generate_event_name() +} + +Global.register(Public.user_reports,function(tbl) + Public.user_reports = tbl +end) + +local function event_emit(event,player,by_player_name) + local reports = Public.user_reports[player.name] + local reason = reports and reports[by_player_name] + script.raise_event(event,{ + name=event, + tick=game.tick, + player_index=player.index, + by_player_name=by_player_name, + reason=reason + }) +end + +--- Adds a report to a player, reports are stored in global table and can be accessed later +-- @tparam player LuaPlayer the player that will be reported +-- @tparam[opt='Non Given.'] reason string the reason that the player is being reported +-- @tparam[opt=''] by_player_name string the name of the player doing the action +-- @treturn boolean true if the report was added, nil if there is an error +function Public.report_player(player,reason,by_player_name) + player = Game.get_player_from_any(player) + if not player then return end + reason = reason or 'Non Given.' + by_player_name = by_player_name or '' + local reports = Public.user_reports[player.name] + if not reports then + Public.user_reports[player.name] = { + [by_player_name] = reason + } + elseif not reports[by_player_name] then + reports[by_player_name] = reason + else return false end + event_emit(Public.player_report_added,player,by_player_name) + return true +end + +--- Removes a report from a player by the given player, see clear_player_reports to remove all +-- @tparam player LuaPlayer the player that will have the report removed +-- @tparam[opt=''] by_player_name string the name of the player doing the action +-- @treturn boolean true if the report was removed, nil if there was an error +function Public.remove_player_report(player,by_player_name) + player = Game.get_player_from_any(player) + if not player then return end + by_player_name = by_player_name or '' + local reports = Public.user_reports[player.name] + if reports and reports[by_player_name] then + event_emit(Public.player_report_removed,player,by_player_name) + reports[by_player_name] = nil + return true + end + return false +end + +--- Clears all reports from a player, will emit an event for each individual report as if remove_player_report was used +-- @tparam player LuaPlayer the player to clear the reports of +-- @treturn boolean true if the reports were cleared, nil if error +function Public.clear_player_reports(player) + player = Game.get_player_from_any(player) + if not player then return end + local reports = Public.user_reports[player.name] + if reports then + for by_player_name,reason in pairs(reports) do + event_emit(Public.player_report_removed,player,by_player_name) + end + Public.user_reports[player.name] = nil + return true + end + return false +end + +--- Test for if a player has been reported by another player, can also return the reason from that player +-- @tparam player LuaPlayer the player to check the reports of +-- @tparam by_player_name string the player that made if the report if present (note server is not default here) +-- @tparam[opt=false] rtn_reason boolean true will return the reason for the report rather than a boolean +-- @treturn boolean true if a report from the player is present unless rtn_reason is true when a string is returned (or false) +function Public.player_is_reported_by(player,by_player_name,rtn_reason) + player = Game.get_player_from_any(player) + if not player then return end + local reports = Public.user_reports[player.name] + if reports and reports[by_player_name] then + return rtn_reason and reports[by_player_name] or true + end + return false +end + +--- Gets all the reports that are on a player +-- @tparam player LuaPlayer the player to get the reports of +-- @treturn table a table of all the reports for this player, empty table if no reports +function Public.get_player_reports(player) + player = Game.get_player_from_any(player) + if not player then return end + return Public.user_reports[player.name] or {} +end + +--- Counts all reports on a player returning a number, a custom count function can be given which should return a number +-- @tparam player LuaPlayer the player to count the reports of +-- @tparam[opt] count_callback function should return a number or true (for 1) this will be passed every report on the player +-- count_callback param - player_name string - the name of the player who made the report +-- count_callback param - reason string - the reason the reason was made +-- count_callback return - number or boolean - if number then this will be added to the count, if boolean then false = 0 and true = 1 +-- @treturn number the number of reports on the player +function Public.count_player_reports(player,count_callback) + player = Game.get_player_from_any(player) + if not player then return end + local reports = Public.user_reports[player.name] or {} + if not count_callback then + return #reports + else + local ctn = 0 + for player_name,reason in pairs(reports) do + local success,err = pcall(count_callback,player_name,reason) + if success and err then + if err == true then err = 1 end + ctn = ctn+err + end + end + return ctn + end +end + +return Public \ No newline at end of file diff --git a/modules/commands/jail.lua b/modules/commands/jail.lua index 3c2b74ee..adfcd927 100644 --- a/modules/commands/jail.lua +++ b/modules/commands/jail.lua @@ -45,7 +45,7 @@ Commands.new_command('temp-ban','Temp bans a player until the next reset; this r end end) -Commands.new_command('remove-temp-ban','Removes temp ban from a player; this will not restore they items.') +Commands.new_command('clear-temp-ban','Removes temp ban from a player; this will not restore they items.') :add_param('player',false,'player-role') :add_param('reason',false) :enable_auto_concat()