{"__v":5,"_id":"5710296c10300c0e007f616a","category":{"project":"56abbf55f25f160d00e17f4e","version":"56abbf55f25f160d00e17f51","_id":"570a5676ade45d0e00c1ad33","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-10T13:34:46.864Z","from_sync":false,"order":3,"slug":"client-side-api","title":"Client Side API"},"parentDoc":null,"project":"56abbf55f25f160d00e17f4e","user":"56abbec30b9e0b0d00616274","version":{"__v":12,"_id":"56abbf55f25f160d00e17f51","project":"56abbf55f25f160d00e17f4e","createdAt":"2016-01-29T19:36:53.665Z","releaseDate":"2016-01-29T19:36:53.665Z","categories":["56abbf56f25f160d00e17f52","56abca6bf9757e0d007c6650","56acddfa0ab3c00d00ce3332","56af65da9d32e30d0006d30f","56af66cab34d210d003d9ad0","56af6afcd21e9c0d00b628d1","56af6d6ecc4cbd0d00ce2c88","5705b12221cfed0e00e8c580","570a5676ade45d0e00c1ad33","570d7d25d1e4b82000d9e385","570eac3c3160d10e0041df0e","575709000fd6a3200010dded"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-14T23:36:12.042Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":3,"body":"The `displayMessage` function on the `chat` property of the Kongregate API object can be used to create a virtual chat message from a given user in the custom chat tab. It accepts the following arguments:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`message`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The message to display\",\n    \"1-0\": \"`username`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The username the message is from\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**Example:** Display a message \"Hi there!\" from user \"BenV\"\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"kongregate.chat.displayMessage(\\\"Hi there!\\\",\\\"BenV\\\");\",\n      \"language\": \"javascript\",\n      \"name\": \"ActionScript 3\"\n    },\n    {\n      \"code\": \"kongregate.chat.displayMessage(\\\"Hi there!\\\",\\\"BenV\\\");\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nRelated:\n\n* [Custom Chat](doc:api-custom-chat) \n* [Chat.AddEventListener](doc:client-api-chat-addeventlistener)\n* [Chat.ClearMessages](doc:client-api-chat-clearmessages) \n* [Chat.CloseTab](doc:client-api-chat-closetab) \n* [Chat.ShowTab](doc:client-api-chat-showtab)","excerpt":"Display a message in the custom chat tab\n`displayMessage(message, username)`","slug":"client-api-chat-displaymessage","type":"fn","title":"Chat.DisplayMessage"}

fnChat.DisplayMessage

Display a message in the custom chat tab `displayMessage(message, username)`

The `displayMessage` function on the `chat` property of the Kongregate API object can be used to create a virtual chat message from a given user in the custom chat tab. It accepts the following arguments: [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "`message`", "0-1": "String", "0-2": "The message to display", "1-0": "`username`", "1-1": "String", "1-2": "The username the message is from" }, "cols": 3, "rows": 2 } [/block] **Example:** Display a message "Hi there!" from user "BenV" [block:code] { "codes": [ { "code": "kongregate.chat.displayMessage(\"Hi there!\",\"BenV\");", "language": "javascript", "name": "ActionScript 3" }, { "code": "kongregate.chat.displayMessage(\"Hi there!\",\"BenV\");", "language": "javascript" } ] } [/block] Related: * [Custom Chat](doc:api-custom-chat) * [Chat.AddEventListener](doc:client-api-chat-addeventlistener) * [Chat.ClearMessages](doc:client-api-chat-clearmessages) * [Chat.CloseTab](doc:client-api-chat-closetab) * [Chat.ShowTab](doc:client-api-chat-showtab)