{{Server client function}}
{{Note_box|Avoid outputting text to the chatbox that isn't actually chat, as this can be annoying for players. Output information and status messages to the HUD.}}
__NOTOC__
This outputs the specified text string to the chatbox. It can be specified as a message to certain player(s) or all players.

It can optionally allow you to embed color changes into the string by setting the colorCoded boolean to true. This allows:
<syntaxhighlight lang="lua">
outputChatBox ( "#FF0000Hello #00FF00World", getRootElement(), 255, 255, 255, true )
</syntaxhighlight>
This will display as: '''<span style='color:red;'>Hello</span> <span style='color:green'>World</span> '''

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool outputChatBox ( string text, [ element visibleTo=getRootElement(), int r=255, int g=255, int b=255, bool colorCoded=false ] )</syntaxhighlight>

==Required Arguments==
*'''text:''' The text string that you wish to send to the chat window.

==Optional Arguments==
{{OptionalArg}}
*'''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. Also the #RRGGBB format must contain capital letters a-f is not acceptable but A-F is.
</section>
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">bool outputChatBox ( string text, [ int r=255, int g=255, int b=255, bool colorCoded=false ] )</syntaxhighlight>

==Required Arguments==
*'''text:''' The text string that you wish to send to the chat window.

==Optional Arguments==
{{OptionalArg}}
*'''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.
</section>

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

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example displays a chat message to all users.
<syntaxhighlight lang="lua">
x = 5
y = 10
-- Displays the message
outputChatBox ( "I have " .. x .. " apples and " .. y .. " oranges." )
</syntaxhighlight>

'''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", getRootElement(), 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">
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
</syntaxhighlight>

'''Example 4:''' This example displays a chat message to a single user called ''someguy''.
<syntaxhighlight lang="lua">
-- 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
</syntaxhighlight>

'''Example 5:''' These two functions can speed up typing, and display a message when a player Joins.
<syntaxhighlight lang="lua">
local msg_red,msg_green,msg_blue = 255,255,0

function servertalkprivate(message, sendto)
--Talk to one client only
outputChatBox(tostring(message), sendto, msg_red, msg_green, msg_blue, true)
end

function servertalk(message)
--Talk to everyone
servertalkprivate(message, getRootElement())
end

function onJoin()
servertalkprivate("Welcome to My Server", source)
end

addEventHandler("onPlayerJoin",getRootElement(),onJoin)
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

OutputChatBox

2009-01-15T19:11:40Z

Trjack:

{{Server client function}}
{{Note_box|Avoid outputting text to the chatbox that isn't actually chat, as this can be annoying for players. Output information and status messages to the HUD.}}
__NOTOC__
This outputs the specified text string to the chatbox. It can be specified as a message to certain player(s) or all players.

It can optionally allow you to embed color changes into the string by setting the colorCoded boolean to true. This allows:
<syntaxhighlight lang="lua">
outputChatBox ( "#FF0000Hello #00FF00World", getRootElement(), 255, 255, 255, true )
</syntaxhighlight>
This will display as: '''<span style='color:red;'>Hello</span> <span style='color:green'>World</span> '''

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool outputChatBox ( string text, [ element visibleTo=getRootElement(), int r=255, int g=255, int b=255, bool colorCoded=false ] )</syntaxhighlight>

==Required Arguments==
*'''text:''' The text string that you wish to send to the chat window.

==Optional Arguments==
{{OptionalArg}}
*'''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. Also the #RRGGBB format must contain capital letters a-f is not acceptable but A-F is.
</section>
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">bool outputChatBox ( string text, [ int r=255, int g=255, int b=255, bool colorCoded=false ] )</syntaxhighlight>

==Required Arguments==
*'''text:''' The text string that you wish to send to the chat window.

==Optional Arguments==
{{OptionalArg}}
*'''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.
</section>

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

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example displays a chat message to all users.
<syntaxhighlight lang="lua">
x = 5
y = 10
-- Displays the message
outputChatBox ( "I have " .. x .. " apples and " .. y .. " oranges." )
</syntaxhighlight>

'''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", getRootElement(), 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">
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
</syntaxhighlight>

'''Example 4:''' This example displays a chat message to a single user called ''someguy''.
<syntaxhighlight lang="lua">
-- 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
</syntaxhighlight>

'''Example 5:''' These two functions can speed up typing, and display a message when a player Joins.
<syntaxhighlight lang="lua">
function servertalkprivate(message, sendto)
--Talk to one client only
outputChatBox(tostring(message), sendto, 255, 255, 0, true)
end

function servertalk(message)
--Talk to everyone
servertalkprivate(message, getRootElement())
end

function onJoin()
servertalkprivate("Welcome to My Server", source)
end

addEventHandler("onPlayerJoin",getRootElement(),onJoin)
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

CreateExplosion

2009-01-15T19:06:57Z

Trjack:

__NOTOC__
{{Server client function}}
Creates an explosion of a certain type at a specified point in the world.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool createExplosion ( float x, float y, float z, int type [, player creator = nil )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float value that specifies the X world coordinate where the explosion is created at.
*'''y:''' A float value that specifies the Y world coordinate where the explosion is created at.
*'''z:''' A float value that specifies the Z world coordinate where the explosion is created at.
*'''type:''' A integer specifying the explosion type. Valid types are:
{{Explosions}}

===Optional Arguments===
*'''creator:''' The explosion's simulated creator, the [[player]] responsible for it.
</section>

<section name="Client" class="client">
<syntaxhighlight lang="lua">
bool createExplosion ( float x, float y, float z, int type [, bool makeSound = true, float camShake = -1.0, bool damaging = true ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float value that specifies the X world coordinate where the explosion is created at.
*'''y:''' A float value that specifies the Y world coordinate where the explosion is created at.
*'''z:''' A float value that specifies the Z world coordinate where the explosion is created at.
*'''type:''' A integer specifying the explosion type. Valid types are:
{{Explosions}}

===Optional Arguments===
*'''makeSound:''' A boolean specifying whether the explosion should be heard or not.
*'''camShake:''' A float specifying the camera shake's intensity.
*'''damaging:''' A boolean specifying whether the explosion should cause damage or not.
</section>

===Returns===
Returns ''true'' if the explosion was created, ''false'' if invalid parameters were passed.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This code will create an explosion at the player's position when they spawn.
<syntaxhighlight lang="lua">function explosionOnSpawn ( )
-- get the spawned player's position
local pX, pY, pZ = getElementPosition ( source )
-- and create an explosion there, making him the creator
createExplosion ( pX, pY, pZ, 6, source )
end
-- add this function as a handler for any player that spawns
addEventHandler ( "onPlayerSpawn", getRootElement(), explosionOnSpawn )
</syntaxhighlight>

'''Example 2:''' This example allows creation of claymore mines, which trigger and explode.
<syntaxhighlight lang="lua">function createClaymore ( creator )
local x, y, z = getElementPosition ( creator )
local claymoreObject = createObject ( 1945, x, y, z - 1, 0, 0, 90 ) --create an object which looks like a claymore
local claymoreCol = createColSphere ( x, y, z, 1 ) --create a collision sphere with radius 1
setElementData ( claymoreCol , "type", "claymore" ) --store the type of colshape so it can be retrieved
setElementData ( claymoreCol, "object", claymoreObject ) --store the object of the claymore
setElementData ( claymoreCol, "creatorPlayer", creator ) --store the person who created it
end

function claymoreHit ( player )
if getElementData ( source, "type" ) == "claymore" then --ensure its a claymore
--retrieve the object associated to the claymore, and who created it
local claymoreObject = getElementData ( source, "object" )
local claymoreCreator = getElementData ( source, "creatorPlayer" )
--get the position of the claymore
local x, y, z = getElementPosition ( source )
createExplosion ( x, y, z, 12, claymoreCreator ) --create an explosion, associated to the creator, of a small size at the col's position
--destroy the claymore object, and the col shape so it doesnt trigger again.
destroyElement ( claymoreObject )
destroyElement ( source )
end
end
addEventHandler ( "onColShapeHit", getRootElement(), claymoreHit )
</syntaxhighlight>
'''Example 3:''' This will cause an explosion that will not harm the player.
<syntaxhighlight lang="lua">function fakeBombAt(el)
if isElement(el) then
local x,y,z = getElementPosition(el)
triggerClientEvent ( "fakeBomb", getRootElement(), x, y, z, 0 )
end
end

function onPlayerSpawnEvent(spawnpoint, team)
fakeBombAt(source)
end

function onPlayerQuitEvent(reason)
fakeBombAt(source)
end

function onPlayerDiedEvent(totalAmmo, killer, killerWeapon, bodypart)
setTimer(fadeCamera, 2000, 1, source, false)
fakeBombAt(source)
setTimer(spawnPlayer, 4000, 1, source, 0, 0, 0)
setTimer(fadeCamera, 4500, 1, source, true)
end

addEventHandler("onPlayerQuit",getRootElement(),onPlayerQuitEvent)
addEventHandler("onPlayerWasted",getRootElement(),onPlayerDiedEvent)
addEventHandler("onPlayerSpawn",getRootElement(),onPlayerSpawnEvent)
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
This code will create an explosion for the local player when they spawn.
<syntaxhighlight lang="lua">function explosionOnSpawn ( )
-- get the spawned player's position
local pX, pY, pZ = getElementPosition ( source )
-- and create an explosion there
createExplosion ( pX, pY, pZ, 6 )
end
-- add this function as a handler for any player that spawns
addEventHandler ( "onClientPlayerSpawn", getLocalPlayer(), explosionOnSpawn )
</syntaxhighlight>
'''Example 3:''' This will cause an explosion that will not harm the player.
<syntaxhighlight lang="lua">function fakeBomb(x,y,z,d)
if d then --Check the players Dimension
if getElementDimension(getLocalPlayer()) == d then
--If the players Dimension is the current dimension
--Then people on other dimensions cant see this explosion
createExplosion(x, y, z, 0, true, -1.0, false)
end
else
createExplosion(x,y,z,0,true,-1.0,false)
end
end
addEvent("fakeBomb",true)
addEventHandler("fakeBomb",getRootElement(),fakeBomb)
</syntaxhighlight>
</section>

==See Also==
{{Explosion functions}}