showChat | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

showChat

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function is used to show or hide the player's chat.

Syntax

bool showChat ( bool show, bool inputBlocked )
Required Arguments
  • show: A boolean value determining whether to show ( true ) or hide ( false ) the chat.
  • inputBlocked: A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility. If unset, this will keep the default behaviour prior to r20898 ( true when chat is hidden, false when chat is visible).

Returns

  • bool: value

Returns true if the player's chat was shown or hidden successfully, false otherwise.

Code Examples

client

This example toggle's the player's chat when they press the "i" key.

--This example below is for all versions until 1.4:
local isChatVisible = true --Let's assume the chat is visible as soon as the resource starts.


function chat(key, keyState)
    if isChatVisible then --Check or the chat is visible.
        showChat(false) --If it is, hide it.
        isChatVisible = false
    else
        showChat(true) --If it is not, show it.
        isChatVisible = true
    end
end


bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'




--This example below is for version 1.4 and up:
function chat(key, keyState)
    if isChatVisible() then --Check or the chat is visible.
        showChat(false) --If it is, hide it.
    else
        showChat(true) --If it is not, show it.
    end
end


bindKey("i", "down", chat) --Make a bind key to start the function as soon as a player presses the key 'i'

See Also

Output Functions
Reference