Multi Theft Auto: Wiki - User contributions [en]

OnPlayerTarget

2010-02-19T22:53:56Z

Samgreen:

__NOTOC__
{{Server event}}
This event is triggered when a player targets an element with his crosshair while aiming, or simply facing it while standing close. It's triggered again when the player no longer targets anything.

==Parameters==
<syntaxhighlight lang="lua">
element targettedElement
</syntaxhighlight>

*'''targettedElement''': The element the player is targetting. ''false'' if no element is being targetted anymore.


==Source==
The [[event system#Event source|source]] of this event is the [[player]] that is targetting the element.

==Example==
<section name="Server" class="server" show="true">
This example destroys a haystack when a player targets it
<syntaxhighlight lang="lua">
function onPlayerTarget ( targetElem )
-- if the targeted object is a haystack (an object with model ID 3374) remove it from the game
if getElementType ( targetElem ) == "object" and getElementModel ( targetElem ) == 3374 then
destroyElement ( targetElem )
end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTarget ) -- add above function as handler for targeting event
</syntaxhighlight>
</section>

{{See also/Server event|Player events}}

OnPlayerTarget

2010-02-19T22:53:33Z

Samgreen:

OutputChatBox

2010-02-19T20:36:26Z

Samgreen: Removed reference to visibleTo from Client section.

{{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="true">
<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.
</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 = getPlayerName ( 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}}

OnClientResourceStart

2010-02-19T20:22:29Z

Samgreen: Fixed a minor typo.

{{Client event}}
__NOTOC__
This event is triggered when a [[resource]] is started. Please note that this is '''not''' triggered the same time as the serverside event [[onResourceStart]] is. The event is triggered when any ''clientside resources'' are started. This means it is triggered when a clientside script is initiated after a download, which includes downloading after join. So:

* If a resource is running '''before''' a player joins, the onClientResourceStart event will be triggered after they join and have downloaded that resource.
* If a resource is started '''after''' a player has joined, the player will be made to download the required files, and then the onClientResourceStart event will be triggered.

==Parameters==
<syntaxhighlight lang="lua">
resource startedResource
</syntaxhighlight>

*'''startedResource''': the [[resource]] that was started.

==Source==
The [[event system#Event source|source]] of this event is the started resource's [[root element]].

==Example==
This example outputs name of resource that was started.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", getRootElement( ),
function ( startedRes )
outputChatBox( "Resource started: " .. getResourceName( startedRes ) );
end
);
</syntaxhighlight>

==See Also==
===Client resource events===
{{Client_resource_events}}
===Client event functions===
{{Client_event_functions}}