New option: chat filters, you can select what kind of chat messages you want...

New option: chat filters, you can select what kind of chat messages you want to see and which to ignore


git-svn-id: http://svn.net-core.org/repos/t-engine4@3762 51575b47-30f0-44d4-a5cc-537603b46e54

game/engines/default/engine/UserChat.lua

@@ -62,9 +62,19 @@ function _M:setupOnGame()
 	if ok and UC then self.uc_ext = UC.new(self) end
 end
 
-function _M:addMessage(channel, login, name, msg, extra_data, no_change)
+--- Filter messages
+function _M:filterMessage(item)
+	if config.settings.chat.filter[item.kind] then return true end
+end
+
+function _M:addMessage(kind, channel, login, name, msg, extra_data, no_change)
+	local item = {kind=kind, login=login, name=name, msg=msg, extra_data=extra_data, timestamp=core.game.getTime()}
+	if self:filterMessage(item) then return end
+	if self.uc_ext and self.uc_ext.filterMessage then
+		if self.uc_ext:filterMessage(item) then return end
+	end
 	local log = self.channels[channel].log
-	table.insert(log, 1, {login=login, name=name, msg=msg, extra_data=extra_data, timestamp=core.game.getTime()})
+	table.insert(log, 1, item)
 	while #log > self.max do table.remove(log) end
 	self.changed = true
 	if not no_change and channel ~= self.cur_channel then self.channels[channel].changed = true self.channels_changed = true end
@@ -75,7 +85,7 @@ function _M:event(e)
 		e.msg = e.msg:removeColorCodes()
 
 		self.channels[e.channel] = self.channels[e.channel] or {users={}, log={}}
-		self:addMessage(e.channel, e.login, e.name, e.msg)
+		self:addMessage("talk", e.channel, e.login, e.name, e.msg)
 
 		if type(game) == "table" and game.logChat and self.cur_channel == e.channel then
 			game.logChat("#YELLOW#<%s> %s", e.name, e.msg)
@@ -84,7 +94,7 @@ function _M:event(e)
 		e.msg = e.msg:removeColorCodes()
 
 		self.channels[self.cur_channel] = self.channels[self.cur_channel] or {users={}, log={}}
-		self:addMessage(self.cur_channel, e.login, e.name, "#GOLD#<whisper> #LAST#"..e.msg)
+		self:addMessage("whisper", self.cur_channel, e.login, e.name, "#GOLD#<whisper> #LAST#"..e.msg)
 
 		if type(game) == "table" and game.logChat then
 			game.logChat("#GOLD#<Whisper from %s> %s", e.name, e.msg)
@@ -93,7 +103,7 @@ function _M:event(e)
 		e.msg = e.msg:removeColorCodes()
 
 		self.channels[e.channel] = self.channels[e.channel] or {users={}, log={}}
-		self:addMessage(e.channel, e.login, e.name, "#{italic}##LIGHT_BLUE#has earned the achievement <"..e.msg..">#{normal}#", nil, true)
+		self:addMessage("achievement", e.channel, e.login, e.name, "#{italic}##LIGHT_BLUE#has earned the achievement <"..e.msg..">#{normal}#", nil, true)
 
 		if type(game) == "table" and game.logChat and self.cur_channel == e.channel then
 			game.logChat("#LIGHT_BLUE#%s has earned the achievement <%s>", e.name, e.msg)
@@ -107,7 +117,7 @@ function _M:event(e)
 		self.channels[e.channel] = self.channels[e.channel] or {users={}, log={}}
 		self.channels[e.channel].users[e.login] = {name=e.name, login=e.login}
 		self.channels_changed = true
-		self:addMessage(e.channel, e.login, e.name, "#{italic}##FIREBRICK#has joined the channel#{normal}#", nil, true)
+		self:addMessage("join", e.channel, e.login, e.name, "#{italic}##FIREBRICK#has joined the channel#{normal}#", nil, true)
 		if type(game) == "table" and game.logChat and e.channel == self.cur_channel then
 			game.logChat("#{italic}##FIREBRICK#%s has joined channel %s (press space to talk).#{normal}#", e.login, e.channel)
 		end
@@ -116,7 +126,7 @@ function _M:event(e)
 		self.channels[e.channel] = self.channels[e.channel] or {users={}, log={}}
 		self.channels[e.channel].users[e.login] = nil
 		self.channels_changed = true
-		self:addMessage(e.channel, e.login, e.name, "#{italic}##FIREBRICK#has left the channel#{normal}#", nil, true)
+		self:addMessage("join", e.channel, e.login, e.name, "#{italic}##FIREBRICK#has left the channel#{normal}#", nil, true)
 		if type(game) == "table" and game.logChat and e.channel == self.cur_channel then
 			game.logChat("#{italic}##FIREBRICK#%s has left channel %s.#{normal}#", e.login, e.channel)
 		end
@@ -176,7 +186,7 @@ function _M:whisper(to, msg)
 	msg = msg:removeColorCodes()
 	core.profile.pushOrder(string.format("o='ChatWhisper' target=%q msg=%q", to, msg))
 
-	self:addMessage(self.cur_channel, to, to, "#GOLD#<whisper to "..to.."> #LAST#"..msg)
+	self:addMessage("whisper", self.cur_channel, to, to, "#GOLD#<whisper to "..to.."> #LAST#"..msg)
 	if type(game) == "table" and game.logChat then game.logChat("#GOLD#<Whisper to %s> %s", to, msg) end
 end
 

game/engines/default/engine/dialogs/ChatFilter.lua

+-- TE4 - T-Engine 4
+-- Copyright (C) 2009, 2010, 2011 Nicolas Casalini
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU General Public License as published by
+-- the Free Software Foundation, either version 3 of the License, or
+-- (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU General Public License for more details.
+--
+-- You should have received a copy of the GNU General Public License
+-- along with this program.  If not, see <http://www.gnu.org/licenses/>.
+--
+-- Nicolas Casalini "DarkGod"
+-- darkgod@te4.org
+
+require "engine.class"
+local Dialog = require "engine.ui.Dialog"
+local Checkbox = require "engine.ui.Checkbox"
+local Textzone = require "engine.ui.Textzone"
+
+module(..., package.seeall, class.inherit(Dialog))
+
+function _M:init(adds)
+	Dialog.init(self, "Chat filters", 500, 400)
+
+	local list = {
+		{name = "Public chat", kind = "talk"},
+		{name = "Private whispers", kind = "whisper"},
+		{name = "Join/part messages", kind = "join"},
+		{name = "Achievements", kind = "achievement"},
+	}
+	for i, l in ipairs(adds or {}) do list[#list+1] = l end
+
+	local c_desc = Textzone.new{width=self.iw - 10, height=1, auto_height=true, text="Select which types of chat events to see or not."}
+	local uis = { {left=0, top=0, ui=c_desc} }
+	for i, l in ipairs(list) do
+		local l = l
+		uis[#uis+1] = {left=0, top=uis[#uis].top+uis[#uis].ui.h + 6, ui=Checkbox.new{title=l.name, default=not config.settings.chat.filter[l.kind], fct=function() end, on_change=function(s) config.settings.chat.filter[l.kind] = not s end} }
+	end
+
+	self:loadUI(uis)
+	self:setupUI(false, true)
+
+	self.key:addBinds{
+		EXIT = function() game:unregisterDialog(self) end,
+	}
+end
+
+function _M:unload()
+	local l = {}
+	for k, _ in pairs(config.settings.chat.filter) do
+		l[#l+1] = "chat.filter."..k.."=true"
+	end
+	game:saveSettings("chat.filter", table.concat(l, "\n"))
+end

game/engines/default/engine/init.lua

@@ -59,6 +59,7 @@ mouse_cursor = true
 display_fps = 30
 gamma_correction = 120
 mouse_move = true
+chat.filter = {}
 ]]
 for i, file in ipairs(fs.list("/settings/")) do
 	if file:find(".cfg$") then

game/modules/tome/class/UserChatExtension.lua

@@ -57,11 +57,11 @@ function _M:event(e)
 		data = data:unserialize()
 		if not data then return end
 		if data.kind == "object-link" then
-			self.chat:addMessage(e.channel, e.login, e.name, "#ANTIQUE_WHITE#has linked an item: #WHITE# "..data.name, {mode="tooltip", tooltip=data.desc})
+			self.chat:addMessage("link", e.channel, e.login, e.name, "#ANTIQUE_WHITE#has linked an item: #WHITE# "..data.name, {mode="tooltip", tooltip=data.desc})
 		elseif data.kind == "actor-link" then
-			self.chat:addMessage(e.channel, e.login, e.name, "#ANTIQUE_WHITE#has linked a creature: #WHITE# "..data.name, {mode="tooltip", tooltip=data.desc})
+			self.chat:addMessage("link", e.channel, e.login, e.name, "#ANTIQUE_WHITE#has linked a creature: #WHITE# "..data.name, {mode="tooltip", tooltip=data.desc})
 		elseif data.kind == "killer-link" then
-			self.chat:addMessage(e.channel, e.login, e.name, "#CRIMSON#"..data.msg.."#WHITE#", data.desc and {mode="tooltip", tooltip=data.desc} or nil)
+			self.chat:addMessage("death", e.channel, e.login, e.name, "#CRIMSON#"..data.msg.."#WHITE#", data.desc and {mode="tooltip", tooltip=data.desc} or nil)
 		end
 	end
 end

game/modules/tome/dialogs/GameOptions.lua

@@ -128,15 +128,6 @@ function _M:generateList()
 		self.c_list:drawItem(item)
 	end,}
 
-	local zone = Textzone.new{width=self.c_desc.w, height=self.c_desc.h, text=string.toTString"If enabled, the chats between players will also appear in the game log, in addition to the normal chat log.#WHITE#"}
-	list[#list+1] = { zone=zone, name=string.toTString"#GOLD##{bold}#Community chat appears in the game log#WHITE##{normal}#", status=function(item)
-		return tostring(config.settings.tome.chat_log and "enabled" or "disabled")
-	end, fct=function(item)
-		config.settings.tome.chat_log = not config.settings.tome.chat_log
-		game:saveSettings("tome.chat_log", ("tome.chat_log = %s\n"):format(tostring(config.settings.tome.chat_log)))
-		self.c_list:drawItem(item)
-	end,}
-
 	local zone = Textzone.new{width=self.c_desc.w, height=self.c_desc.h, text=string.toTString"Select the interface look. Stone is the default one. Simple is basic but takes less screen space.\nYou must restart the game for the change to take effect."}
 	list[#list+1] = { zone=zone, name=string.toTString"#GOLD##{bold}#Interface Style#WHITE##{normal}#", status=function(item)
 		return tostring(config.settings.tome.ui_theme):capitalize()
@@ -196,5 +187,16 @@ function _M:generateList()
 		end, 2))
 	end,}
 
+	local zone = Textzone.new{width=self.c_desc.w, height=self.c_desc.h, text=string.toTString"Configure the chat filters to select what kind of messages to see.#WHITE#"}
+	list[#list+1] = { zone=zone, name=string.toTString"#GOLD##{bold}#Chat message filters#WHITE##{normal}#", status=function(item)
+		return "select to configure"
+	end, fct=function(item)
+		game:registerDialog(require("engine.dialogs.ChatFilter").new({
+			{name="Deaths", kind="death"},
+			{name="Object & Creatures links", kind="link"},
+		}))
+	end,}
+
+
 	self.list = list
 end