games/RedMew
games/RedMew
1
0
Fork 0
mirror of https://github.com/Refactorio/RedMew.git synced 2025-01-18 03:21:47 +02:00
Code Issues Releases Activity

Merge pull request #726 from plague006/command_notifications

Browse Source 
Add command notifications
This commit is contained in:
Matthew 2019-02-04 12:28:09 -05:00 committed by GitHub
commit b2b91caf4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
utils/command.lua
View File

@ -19,6 +19,12 @@ local deprecated_command_alternatives = {
['color-redmew'] = 'redmew-color'
}
local notify_on_commands = {
['version'] = 'RedMew has a version as well, accessible via /redmew-version',
['color'] = 'RedMew allows color saving and a color randomizer: check out /redmew-color',
['ban'] = 'In case your forgot: please remember to include a message on how to appeal a ban'
}
local option_names = {
['description'] = 'A description of the command',
['arguments'] = 'A table of arguments, example: {"foo", "bar"} would map the first 2 arguments to foo and bar',
@ -256,15 +262,27 @@ function Command.search(keyword)
return matches
end
--- Warns in-game players of deprecated commands, ignores the server
local function notify_deprecated(event)
--- Trigger messages on deprecated or defined commands, ignores the server
local function on_command(event)
if not event.player_index then
return
end
local alternative = deprecated_command_alternatives[event.command]
if alternative then
if event.player_index then
local player = Game.get_player_by_index(event.player_index)
local player = Game.get_player_by_index(event.player_index)
if player then
player.print(format('Warning! Usage of the command "/%s" is deprecated. Please use "/%s" instead.', event.command, alternative))
end
end
local notification = notify_on_commands[event.command]
if notification and event.player_index then
local player = Game.get_player_by_index(event.player_index)
if player then
player.print(notification)
end
end
end
--- Traps command errors if not in DEBUG.
@ -286,6 +304,6 @@ if not _DEBUG then
end
end
Event.add(defines.events.on_console_command, notify_deprecated)
Event.add(defines.events.on_console_command, on_command)
return Command