ShowChat: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Update to include new feature/item template for inputBlocked argument)
mNo edit summary
Line 11: Line 11:
===Required Arguments===  
===Required Arguments===  
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.
===Optional Arguments===
{{New feature/item|3.0159|1.5.8|20898|
{{New feature/item|3.0159|1.5.8|20898|
*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.
*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.
Line 25: Line 27:
*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.
*'''thePlayer:''' The [[player]] whose chat is to be hidden or shown.
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.
*'''show:''' A boolean value determining whether to show (''true'') or hide (''false'') the chat.
===Optional Arguments===
{{New feature/item|3.0159|1.5.8|20898|
{{New feature/item|3.0159|1.5.8|20898|
*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.
*'''inputBlocked:''' A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.

Revision as of 01:12, 29 July 2021

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

Syntax

Click to collapse [-]
Client
bool showChat ( bool show [, bool inputBlocked ] )

Required Arguments

  • show: A boolean value determining whether to show (true) or hide (false) the chat.

Optional Arguments

  • inputBlocked: A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.

Returns

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

Click to collapse [-]
Server
bool showChat ( player thePlayer, bool show [, bool inputBlocked ] )

Required Arguments

  • thePlayer: The player whose chat is to be hidden or shown.
  • show: A boolean value determining whether to show (true) or hide (false) the chat.

Optional Arguments

  • inputBlocked: A boolean value determining whether chat input is blocked/hidden, regardless of chat visibility.

Returns

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

Example

Click to collapse [-]
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