OutputChatBox: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Left bracket missing for clientside optional args in syntax)
mNo edit summary
Line 47: Line 47:
</syntaxhighlight>
</syntaxhighlight>


'''Example 2:''' This example allows for coloured chat, according to a player's nametag.  This makes use of colour coded outputs.
'''Example 2:''' This example outputs a simple colour coded message, "Red White", where the 'White' is in white colour, and 'Red' is in a red colour.
<syntaxhighlight lang="lua">
outputChatBox ( "Red #ffffffWhite", 255,0,0,true )
</syntaxhighlight>
 
'''Example 3:''' This example allows for coloured chat, according to a player's nametag.  This makes use of colour coded outputs.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function colouredChat ( message, theType )
function colouredChat ( message, theType )
Line 61: Line 66:
</syntaxhighlight>
</syntaxhighlight>


'''Example 3:''' This example displays a chat message to a single user called ''someguy''.
'''Example 4:''' This example displays a chat message to a single user called ''someguy''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Find the player element for the player called 'someguy'
-- Find the player element for the player called 'someguy'

Revision as of 03:43, 4 January 2008

This outputs the specified text string to the chatbox. It can be specified as a message to certain player(s) or all players.

Syntax

Click to collapse [-]
Server
bool outputChatBox ( string text, [ element visibleTo=getRootElement(), int r=255, int g=255, int b=255, bool colorCoded=false ] )

Required Arguments

  • text: The text string that you wish to send to the chat window.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • visibleTo: This specifies who the chat is visible to. Any players in this element will see the chat message. See visibility.
  • r: The amount of red in the color of the text. Default value is 255.
  • g: The amount of green in the color of the text. Default value is 255.
  • b: The amount of blue in the color of the text. Default value is 255.
  • colorCoded: A boolean value determining whether or not '#RRGGBB' tags should be used.

Note: visibleTo can also be a Team object, in this case, the text will be visible to all the players of that team.

Click to expand [+]
Client

Returns

Returns true if the message was displayed successfully. Returns false if invalid arguments are specified.

Example

Click to collapse [-]
Server

Example 1: This example displays a chat message to all users. 

x = 5
y = 10  
-- Displays the message
outputChatBox ( "I have " .. x .. " apples and " .. y .. " oranges." )

Example 2: This example outputs a simple colour coded message, "Red White", where the 'White' is in white colour, and 'Red' is in a red colour. 

 outputChatBox ( "Red #ffffffWhite", 255,0,0,true )

Example 3: This example allows for coloured chat, according to a player's nametag. This makes use of colour coded outputs. 

function colouredChat ( message, theType )
	if theType == 0 then --if its normal chat (not /me or teamchat) then
		cancelEvent() --prevent MTA from outputting chat
		message = string.gsub(message, "#%x%x%x%x%x%x", "") --remove any hex tags in a player's chat to prevent custom colours by using lua's string.gsub
		local r,g,b = getPlayerNametagColor ( source ) --get the player's nametag colour
		local chatterName = getClientName ( source ) --get his name
		--output a message with the name as his nametag colour, and the rest in white.
		outputChatBox ( chatterName..":#FFFFFF "..message, getRootElement(), r, g, b, true )
	end
end

Example 4: This example displays a chat message to a single user called someguy. 

-- Find the player element for the player called 'someguy'
myPlayer = getPlayerFromNick ( "someguy" )
-- If a player was found called 'someguy' then...
if ( myPlayer ~= false ) then
    x = 5
    y = 10
    -- Display the message
    outputChatBox ( "I have " .. x .. " apples and " .. y .. " oranges.", myPlayer )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/OutputChatBox?oldid=14429"