Class engine.UserChat
Module that handles multiplayer chats
Methods
engine.UserChat:init ()
Creates the log zone
engine.UserChat:setupOnGame ()
Hook up in the current running game
engine.UserChat:filterMessage (item)
Filter messages
engine.UserChat:registerTalkEvents (fct)
Register to receive events
engine.UserChat:unregisterTalkEvents (fct)
Register to not receive events
engine.UserChat:talkBox (on_end, only_friends)
Request a line to send
engine.UserChat:setCurrentTarget (channel, name, no_switch)
Sets the current talk target, channel or whisper
engine.UserChat:getCurrentTarget ()
Gets the current talk target, channel or whisper
engine.UserChat:showUserInfo (login)
Display user infos
engine.UserChat:getUserInfo (login)
Get user infos
engine.UserChat:getLog (channel, extra, timestamp)
Returns the full log
engine.UserChat:showLogDialog (title, shadow)
Make a dialog popup with the full log
engine.UserChat:resize (x, y, w, h, fontname, fontsize, color, bgcolor)
Resize the display area
engine.UserChat:scrollUp (i)
Scroll the zone
Methods
- engine.UserChat:init ()
- Creates the log zone
- engine.UserChat:setupOnGame ()
- Hook up in the current running game
- engine.UserChat:filterMessage (item)
-
Filter messages
Parameters:
- item
- engine.UserChat:registerTalkEvents (fct)
-
Register to receive events
Parameters:
- fct
- engine.UserChat:unregisterTalkEvents (fct)
-
Register to not receive events
Parameters:
- fct
- engine.UserChat:talkBox (on_end, only_friends)
-
Request a line to send
Parameters:
- on_end
- only_friends
- engine.UserChat:setCurrentTarget (channel, name, no_switch)
-
Sets the current talk target, channel or whisper
Parameters:
- channel
- name
- no_switch
- engine.UserChat:getCurrentTarget ()
- Gets the current talk target, channel or whisper
- engine.UserChat:showUserInfo (login)
-
Display user infos
Parameters:
- login
- engine.UserChat:getUserInfo (login)
-
Get user infos
Parameters:
- login
- engine.UserChat:getLog (channel, extra, timestamp)
-
Returns the full log
Parameters:
- channel
- extra
- timestamp
- engine.UserChat:showLogDialog (title, shadow)
-
Make a dialog popup with the full log
Parameters:
- title
- shadow
- engine.UserChat:resize (x, y, w, h, fontname, fontsize, color, bgcolor)
-
Resize the display area
Parameters:
- x
- y
- w
- h
- fontname
- fontsize
- color
- bgcolor
- engine.UserChat:scrollUp (i)
-
Scroll the zone
Parameters:
- i number representing how many lines to scroll