OnChatMessage: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
m (→Parameters) |
||
| Line 9: | Line 9: | ||
string theMessage, resource / element theElement | string theMessage, resource / element theElement | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''theMessage:''' | *'''theMessage:''' a [[string]] representing the text that was output to the chatbox. | ||
*'''theElement:''' | *'''theElement:''' a [[player]] element if chatbox output was done via ''say'', ''teamsay'' or ''me''. [[Resource]] if it was done via [[outputChatBox]]. | ||
==Source== | ==Source== | ||
Revision as of 22:09, 2 April 2018
This event is triggered when a player uses say, teamsay, me successfully. Or when any message is output to chat using outputChatBox on the server side. It can be used to get the resource responsible for specific outputChatBox call via the second parameter.
Parameters
string theMessage, resource / element theElement
- theMessage: a string representing the text that was output to the chatbox.
- theElement: a player element if chatbox output was done via say, teamsay or me. Resource if it was done via outputChatBox.
Source
The source of this event is the root element.
Example
This example outputs all chat messages to debug view.
function onChatMessageHandler(theMessage, thePlayer)
outputDebugString(theMessage)
end
addEventHandler("onChatMessage", root, onChatMessageHandler)
Requirements
This template will be deleted.
See Also
Server events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled