OnElementClicked: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(11 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
{{Server event}}
This event is triggered when an element is clicked on by the client. These events can only trigger when the client has its cursor enabled. It triggers for all three mousebuttons in both their up and down states.


__NOTOC__
==Parameters==
This event is blahblah and is used for blahblah.
<syntaxhighlight lang="lua">
string mouseButton, string buttonState, player playerWhoClicked, float clickPosX, float clickPosY, float clickPosZ
</syntaxhighlight>
 
*'''mouseButton''': a [[string]] representing the mouse button that was clicked. This might be ''left'', ''middle'' or ''right''.
*'''buttonState''': a [[string]] representing what state the button clicked is in. This might be ''up'' or ''down''.
*'''playerWhoClicked''': the [[player]] that clicked on the [[element]].
*'''clickPosX''': the X position in the world the [[player]] clicked at.
*'''clickPosY''': the Y position in the world the [[player]] clicked at.
*'''clickPosZ''': the Z position in the world the [[player]] clicked at.


==Syntax==  
==Source==
The [[event system#Event source|source]] of this event is the [[element]] that got clicked by the player.
 
==Examples==
This example prints type of the element you clicked to chatbox when you click it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onElementClicked ( string button, string state, player clicker, float posX, float posY, float posZ )
function elementClicked( theButton, theState, thePlayer )
</syntaxhighlight>  
    if theButton == "left" and theState == "down" then -- if left mouse button was pressed down
        outputChatBox( "You clicked " .. getElementType( source ), thePlayer ) -- print the element type to players chatbox
    end
end
addEventHandler( "onElementClicked", root, elementClicked ) -- add a handler function for the event
</syntaxhighlight>


==Example==
This example check if the clicked element is a vehicle. If is, then repairs it.
This example does...
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function repairClickedVehicle( button, state, player ) -- Add the function
blabhalbalhb --abababa
    if button == "left" and state == "down" then
--This line does this...
        if getElementType( source ) == "vehicle" then -- If the clicked element is a vehicle...
mooo
            local x, y, z = getElementPosition( player )
            local x1, y1, z1 = getElementPosition( source )
            local distance = getDistanceBetweenPoints3D( x, y, z, x1, y1, z1 ) -- Some distance calculations
            if distance < 4 then -- Check if the player is near the vehicle
                if getElementHealth( source ) < 1000 then
                    fixVehicle( source )
                    outputChatBox( "You have repaired a "..getVehicleNameFromModel( getElementModel( source ) ), player, 0, 255, 0 )
                else
                    outputChatBox( "Vehicle is not damaged!", player, 255, 0, 0 )
                end
            end
        end
    end
end
addEventHandler( "onElementClicked", root, repairClickedVehicle ) -- Add the event handler
</syntaxhighlight>
</syntaxhighlight>
{{See also/Server event|Element events}}

Latest revision as of 02:56, 27 September 2018

This event is triggered when an element is clicked on by the client. These events can only trigger when the client has its cursor enabled. It triggers for all three mousebuttons in both their up and down states.

Parameters

string mouseButton, string buttonState, player playerWhoClicked, float clickPosX, float clickPosY, float clickPosZ
  • mouseButton: a string representing the mouse button that was clicked. This might be left, middle or right.
  • buttonState: a string representing what state the button clicked is in. This might be up or down.
  • playerWhoClicked: the player that clicked on the element.
  • clickPosX: the X position in the world the player clicked at.
  • clickPosY: the Y position in the world the player clicked at.
  • clickPosZ: the Z position in the world the player clicked at.

Source

The source of this event is the element that got clicked by the player.

Examples

This example prints type of the element you clicked to chatbox when you click it.

function elementClicked( theButton, theState, thePlayer )
    if theButton == "left" and theState == "down" then -- if left mouse button was pressed down
        outputChatBox( "You clicked " .. getElementType( source ), thePlayer ) -- print the element type to players chatbox
    end
end
addEventHandler( "onElementClicked", root, elementClicked ) -- add a handler function for the event

This example check if the clicked element is a vehicle. If is, then repairs it.

function repairClickedVehicle( button, state, player ) -- Add the function
    if button == "left" and state == "down" then
        if getElementType( source ) == "vehicle" then -- If the clicked element is a vehicle...
            local x, y, z = getElementPosition( player )
            local x1, y1, z1 = getElementPosition( source ) 
            local distance = getDistanceBetweenPoints3D( x, y, z, x1, y1, z1 ) -- Some distance calculations
            if distance < 4 then -- Check if the player is near the vehicle
                if getElementHealth( source ) < 1000 then
                    fixVehicle( source )
                    outputChatBox( "You have repaired a "..getVehicleNameFromModel( getElementModel( source ) ), player, 0, 255, 0 )
                else
                    outputChatBox( "Vehicle is not damaged!", player, 255, 0, 0 )
                end
            end
        end
    end
end
addEventHandler( "onElementClicked", root, repairClickedVehicle ) -- Add the event handler

See Also

Element events


Event functions