Multi Theft Auto: Wiki - User contributions [en]

SetVehicleVariant

2011-12-18T00:01:14Z

Marwin: /* Syntax */

{{Server function}}
__NOTOC__
{{New feature/item|3.0120|1.2||
Only available in MTA:SA v1.2 and onwards.
}}
This function sets the variant of a specified vehicle. In GTA SA some vehicles are different for example the labelling on trucks or the contents of a pick-up truck and the varying types of a motor bike. For the default GTA SA variant list see: [[Vehicle variants]]

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleVariant ( vehicle theVehicle, [ int variant1, int variant2 ] )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' A handle to the [[vehicle]] that you want to get the variant of. Specifying no variant will result in random one being picked.

==Optional Arguments==
* '''variant1''': An integer for the second vehicle variant see [[Vehicle variants]]
* '''variant2''': An integer for the first vehicle variant see [[Vehicle variants]]

==Returns==
On success:
* '''bool''': Returns true as the vehicle variants were successfully set.
On failure:
* '''bool''': False because the specified vehicle didn't exist or specified variants were invalid.

==Example==
This example lets the vehicle driver set their vehicle variant with setvehvar
<syntaxhighlight lang="lua">
function setMyVehiclesVariant(theUser, command, var1, var2)
local var1, var2 = tonumber(var1), tonumber(var2) -- If anything was passed make sure its number or nil
local myVeh = getPedOccupiedVehicle(theUser) -- Get the vehicle that they're in
if (myVeh and getVehicleController(myVeh) == theUser) then -- Make sure they're in control
local wasSet = setVehicleVariant(myVeh, var1, var2) -- Set what they wanted
if (wasSet) then
outputChatBox("Vehicle variant successfully set!", theUser, 0, 255, 0)
else
outputChatBox("Vehicle variant unsuccessfully set.", theUser, 255, 255, 0)
end
end
end
addCommandHandler("setvehvar", setMyVehiclesVariant) -- Add the command
</syntaxhighlight>
==Requirements==
{{Requirements|1.2|n/a|}}
==See Also==
{{Vehicle functions}}

OnClientDoubleClick

2011-11-22T13:36:49Z

Marwin: /* Example */

{{Client event}}
__NOTOC__
This event triggers whenever the user double-clicks his mouse. This is linked to the GTA world, as appose to GUI for which [[onClientGUIDoubleClick]] is to be used. This event allows detection of click positions of the 3D world.

==Parameters==
<syntaxhighlight lang="lua">string button, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ, element clickedWorld
</syntaxhighlight>
* '''button''': This refers the button used to click on the mouse, can be ''left'', ''right'', or ''middle'
* '''absoluteX''': This refers to the 2D ''x coordinate'' the user clicked on his screen, and is an ''absolute'' position in pixels.
* '''absoluteY''': This refers to the 2D ''y coordinate'' the user clicked on his screen, and is an ''absolute'' position in pixels.
* '''worldX''': This represents the 3D ''x coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''worldY''': This represents the 3D ''y coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''worldZ''': This represents the 3D ''z coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''clickedWorld''': This represents any physical [[entity]] elements that were clicked. If the player clicked on no MTA element, it's set to false.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
button = guiCreateButton(0.3,0.475,0.4,0.05,"Repair(doubleclick)",true)

function onMyButtonDoubleClick (button, absoluteX, absoluteY, worldX, worldY, worldZ, clickedWorld)
if button == "left" then
playSoundFrontEnd (40)
end
end
addEventHandler("OnClientDoubleClick",button,onMyButtonDoubleClick)
</syntaxhighlight>
</section>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

[[Category:Needs_Example]]

OnClientDoubleClick

2011-11-22T13:36:24Z

Marwin: /* Example */

{{Client event}}
__NOTOC__
This event triggers whenever the user double-clicks his mouse. This is linked to the GTA world, as appose to GUI for which [[onClientGUIDoubleClick]] is to be used. This event allows detection of click positions of the 3D world.

==Parameters==
<syntaxhighlight lang="lua">string button, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ, element clickedWorld
</syntaxhighlight>
* '''button''': This refers the button used to click on the mouse, can be ''left'', ''right'', or ''middle'
* '''absoluteX''': This refers to the 2D ''x coordinate'' the user clicked on his screen, and is an ''absolute'' position in pixels.
* '''absoluteY''': This refers to the 2D ''y coordinate'' the user clicked on his screen, and is an ''absolute'' position in pixels.
* '''worldX''': This represents the 3D ''x coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''worldY''': This represents the 3D ''y coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''worldZ''': This represents the 3D ''z coordinate'' the player clicked on the screen, and is relative to the GTA world.
* '''clickedWorld''': This represents any physical [[entity]] elements that were clicked. If the player clicked on no MTA element, it's set to false.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
button = guiCreateButton(0.3,0.475,0.4,0.05,"Repair(doubleclick)",true)

function onMyButtonClick (button, absoluteX, absoluteY, worldX, worldY, worldZ, clickedWorld)
if button == "left" then
playSoundFrontEnd (40)
end
end
addEventHandler("OnClientDoubleClick",button,onMyButtonClick)
</syntaxhighlight>
</section>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

[[Category:Needs_Example]]