ShowChat: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | |||
This function is used to show or hide the local player's chat. | This function is used to show or hide the local player's chat. | ||
| Line 14: | Line 15: | ||
==Example== | ==Example== | ||
<section name="Client" class="client" show="true"> | |||
This example toggle's the player's chat when they press the "'''i'''" key. | This example toggle's the player's chat when they press the "'''i'''" key. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 27: | Line 29: | ||
bindKey ( "i", "down", "toggle chat", chat ) -- the player's "i" key will toggle the chat | bindKey ( "i", "down", "toggle chat", chat ) -- the player's "i" key will toggle the chat | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Client_output_functions}} | {{Client_output_functions}} | ||
Revision as of 16:08, 4 August 2007
This function is used to show or hide the local player's chat.
Syntax
bool showChat ( bool show )
Required Arguments
- show: A boolean value determining whether to show (true) or hide (false) the chat.
Returns
Returns true if the player's chat was shown or hidden successfully, false otherwise.
Example
Click to collapse [-]
ClientThis example toggle's the player's chat when they press the "i" key.
local isChatVisible = true -- let's assume the chat is visible function chat ( key, keyState ) if ( isChatVisible ) then -- if it's on showChat ( false ) -- turn it off isChatVisible = false else showChat ( true ) -- if it's off isChatVisible = true -- turn it on end end bindKey ( "i", "down", "toggle chat", chat ) -- the player's "i" key will toggle the chat
See Also
- clearChatBox
- clearDebugBox
- isChatInputBlocked
- isChatVisible
- outputChatBox
- outputConsole
- outputDebugString
- showChat