Multi Theft Auto: Wiki - User contributions [en]

OnClientGUIDoubleClick

2010-03-22T18:39:51Z

Dakilla: /* Example */

{{Client event}}
__NOTOC__
This event is fired when the user double clicks a GUI element.

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the mouse button that the GUI element was double clicked with.
*'''state:''' the state of the mouse button. "down" or "up".
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

==Source==
The source of this event is the GUI element that was double clicked.

==Example==
This example displays in chatbox name of double-clicked player in a gridlist.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", getResourceRootElement( ),
function ( )
gridList = guiCreateGridList( 10, 200, 100, 50, false ); -- create a gridlist
local col = guiGridListAddColumn( gridList, "Players", .9 ); -- add "Players" column

local players = getElementsByType( "player" );
for i, plr in pairs( players ) do -- loop through the table of players
local row = guiGridListAddRow( gridList ); -- add row for player
guiGridListSetItemText( gridList, row, col, getPlayerName( plr ), false, false ); -- change the text of the added row
end

addEventHandler( "onClientGUIDoubleClick", gridList, doubleClickedName, false );
end
);

function doubleClickedName( )
local selectedRow, selectedCol = guiGridListGetSelectedItem( gridList ); -- get double clicked item in the gridlist
local playerName = guiGridListGetItemText( gridList, selectedRow, selectedCol ); -- get its text
outputChatBox( "You double-clicked: " .. playerName ); -- display the text taken from gridlist
end
</syntaxhighlight>

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

[[Category:Incomplete Event]]

AddBan

2010-03-21T12:41:39Z

Dakilla: /* Example 2 */

__NOTOC__
{{Server function}}
This function will add a ban for the specified IP/username/serial to the server.

==Syntax==
<syntaxhighlight lang="lua">
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>
'''Note:''' One of the three: IP, Username or Serial have to be specified.

===Required Arguments===
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''.
'''or'''
*'''Username:''' The username to be banned. If you don't want to ban by username, set this to ''nil''.
'''or'''
*'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''.
''' or any combination.'''

===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the IP/username/serial. This can be a player or the root ([[getRootElement]]()).
*'''reason:''' The reason the IP/username/serial will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.

===Returns===
Returns ''true'' if the IP/username/serial was banned succesfully, ''false'' if invalid arguments are specified.

==Example==
This example bans a player's IP with the reason "Requested" when they type "/ban-me".
<syntaxhighlight lang="lua">
function banMe ( source, command ) -- The function header and where source is defined
local ipToBan = getPlayerIP ( source ) -- Get the player's IP
addBan ( ipToBan, nil, nil, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"
</syntaxhighlight>

==Example 2==
This example add command to ban player serial.
<syntaxhighlight lang="lua">
function banSerial( source, command, noob, reason )
if ( noob ) then
local theNoob = getPlayerFromName( noob )
if ( theNoob ) then
local theNoobSerial = getPlayerSerial( theNoob )
addBan( nil, nil, theNoobSerial, source, reason )
end
end
end
addCommandHandler( "ban-serial", banSerial )
</syntaxhighlight>

==See Also==
{{Admin functions}}
[[ru:addBan]]

IsPedDoingGangDriveby

2010-02-16T09:55:57Z

Dakilla: /* Returns */

{{Server client function}}
__NOTOC__
This function checks if the ped is in the driveby state.

==Syntax==
<syntaxhighlight lang="lua">
bool isPedDoingGangDriveby ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] element whose state is to be checked.

===Returns===
* '''Server-Side:'''
Returns '''1''' if the driveby state is enabled, '''0''' otherwise.
* '''Client-Side:'''
Returns '''true''' if the driveby state is enabled, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example turns on driveby mode when the local player types ''driveby'' in the console.
<syntaxhighlight lang="lua">function setDoingDriveby ( )
-- we check if local player isn't currently doing a gang driveby
if not isPedDoingGangDriveby ( getLocalPlayer () ) then
-- if he got driveby mode off, turn it on
setPedWeaponSlot ( getLocalPlayer (), 4 )
setPedDoingGangDriveby ( getLocalPlayer (), true )
else
-- otherwise, turn it off
setPedWeaponSlot ( getLocalPlayer (), 0 )
setPedDoingGangDriveby ( getLocalPlayer (), false )
end
end
addCommandHandler ( "driveby", setDoingDriveby )</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

IsPedDoingGangDriveby

2010-02-16T08:57:59Z

Dakilla: /* Example */

{{Server client function}}
__NOTOC__
This function checks if the ped is in the driveby state.

==Syntax==
<syntaxhighlight lang="lua">
bool isPedDoingGangDriveby ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] element whose state is to be checked.

===Returns===
'''Server-Side:'''
Returns '''1''' if the driveby state is enabled, '''0''' otherwise.
'''Client-Side:'''
Returns '''true''' if the driveby state is enabled, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example turns on driveby mode when the local player types ''driveby'' in the console.
<syntaxhighlight lang="lua">function setDoingDriveby ( )
-- we check if local player isn't currently doing a gang driveby
if not isPedDoingGangDriveby ( getLocalPlayer () ) then
-- if he got driveby mode off, turn it on
setPedWeaponSlot ( getLocalPlayer (), 4 )
setPedDoingGangDriveby ( getLocalPlayer (), true )
else
-- otherwise, turn it off
setPedWeaponSlot ( getLocalPlayer (), 0 )
setPedDoingGangDriveby ( getLocalPlayer (), false )
end
end
addCommandHandler ( "driveby", setDoingDriveby )</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

IsPedDoingGangDriveby

2010-02-15T20:02:23Z

Dakilla: /* Returns */

{{Server client function}}
__NOTOC__
This function checks if the ped is in the driveby state.

==Syntax==
<syntaxhighlight lang="lua">
bool isPedDoingGangDriveby ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] element whose state is to be checked.

===Returns===
'''Server-Side:'''
Returns '''1''' if the driveby state is enabled, '''0''' otherwise.
'''Client-Side:'''
Returns '''true''' if the driveby state is enabled, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example turns on driveby mode when the local player types ''driveby'' in the console.
<syntaxhighlight lang="lua">function setDoingDriveby ( )
-- we check if local player isn't currently doing a gang driveby
if isPedDoingGangDriveby ( getLocalPlayer () ) == 0 then
-- if he got driveby mode off, turn it on
setPedWeaponSlot ( getLocalPlayer (), 4 )
setPedDoingGangDriveby ( getLocalPlayer (), true )
else
-- otherwise, turn it off
setPedWeaponSlot ( getLocalPlayer (), 0 )
setPedDoingGangDriveby ( getLocalPlayer (), false )
end
end
addCommandHandler ( "driveby", setDoingDriveby )</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

IsPedDoingGangDriveby

2010-02-15T20:00:14Z

Dakilla: /* Example */

{{Server client function}}
__NOTOC__
This function checks if the ped is in the driveby state.

==Syntax==
<syntaxhighlight lang="lua">
bool isPedDoingGangDriveby ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] element whose state is to be checked.

===Returns===
Returns '''1''' if the driveby state is enabled, '''0''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example turns on driveby mode when the local player types ''driveby'' in the console.
<syntaxhighlight lang="lua">function setDoingDriveby ( )
-- we check if local player isn't currently doing a gang driveby
if isPedDoingGangDriveby ( getLocalPlayer () ) == 0 then
-- if he got driveby mode off, turn it on
setPedWeaponSlot ( getLocalPlayer (), 4 )
setPedDoingGangDriveby ( getLocalPlayer (), true )
else
-- otherwise, turn it off
setPedWeaponSlot ( getLocalPlayer (), 0 )
setPedDoingGangDriveby ( getLocalPlayer (), false )
end
end
addCommandHandler ( "driveby", setDoingDriveby )</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

IsPedDoingGangDriveby

2010-02-15T19:59:35Z

Dakilla: /* Returns */

{{Server client function}}
__NOTOC__
This function checks if the ped is in the driveby state.

==Syntax==
<syntaxhighlight lang="lua">
bool isPedDoingGangDriveby ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] element whose state is to be checked.

===Returns===
Returns '''1''' if the driveby state is enabled, '''0''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example turns on driveby mode when the local player types ''driveby'' in the console.
<syntaxhighlight lang="lua">function setDoingDriveby ( )
-- we check if local player isn't currently doing a gang driveby
if not isPedDoingGangDriveby ( getLocalPlayer () ) then
-- if he got driveby mode off, turn it on
setPedWeaponSlot ( getLocalPlayer (), 4 )
setPedDoingGangDriveby ( getLocalPlayer (), true )
else
-- otherwise, turn it off
setPedWeaponSlot ( getLocalPlayer (), 0 )
setPedDoingGangDriveby ( getLocalPlayer (), false )
end
end
addCommandHandler ( "driveby", setDoingDriveby )</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

SetVehicleEngineState

2010-02-13T10:18:05Z

Dakilla: /* Example */

__NOTOC__
{{Server client function}}
This function turns a vehicle's engine on or off. Note that the engine will always be turned on when someone enters the driver seat, unless you override that behaviour with scripts.

==Syntax==
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
bool setVehicleEngineState ( vehicle theVehicle, bool engineState )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to change the engine state of.
*'''engineState''': A boolean value representing whether the engine will be turned on (''true'') or off (''false'').

===Returns===
Returns ''true'' if the vehicle's engine state was successfully changed, ''false'' otherwise.
</section>

==Example==
<section name="Serverside example" class="server" show="true">
This example will turn off a vehicle's engine when the driver gets out of the car.
<syntaxhighlight lang="lua">
function turnEngineOff ( theVehicle, leftSeat, jackerPlayer )
-- if it's the driver who got out, and he was not jacked,
if leftSeat == 0 and not jackerPlayer then
-- turn off the engine
setVehicleEngineState ( theVehicle, false )
end
end
-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"
addEventHandler ( "onPlayerVehicleExit", getRootElement ( ), turnEngineOff )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

GetTypeIndexFromClothes

2010-02-13T10:02:24Z

Dakilla: /* Example */

{{Server client function}}
__NOTOC__
This function is used to get the clothes type and index from the texture and model.
(Scans through the list of clothes for the specific type).

==Syntax==
<syntaxhighlight lang="lua">
int int getTypeIndexFromClothes ( string clothesTexture, string clothesModel )
</syntaxhighlight>

===Required Arguments===
*'''clothesTexture''': A string determining the clothes texture that you wish to retrieve the type and index from. See the [[CJ Clothes|clothes catalog]].
*'''clothesModel''': A string determining the corresponding clothes model that you wish to retrieve the type and index from. See the [[CJ Clothes|clothes catalog]].

==Returns==
This function returns two integers, type and index respectively, ''false'' if invalid arguments were passed to the function.

==Example==
This example gets the current clothes of a certain type on a player, then swaps with the previous in the clothes list.
<syntaxhighlight lang="lua">
function scriptPreviousClothes ( thePlayer, key, clothesType )
local currentTexture, currentModel = getPedClothes ( thePlayer, clothesType ) -- get the current clothes on this slot
local clothesIndex = 1
if ( currentTexture ) then -- if he had clothes of that type
local tempA, tempB = getTypeIndexFromClothes ( currentTexture, currentModel ) -- get the type and index for these clothes, so we can decrease and get the previous in the list
if ( tempA and tempB ) then -- if we found them
clothesType, clothesIndex = tempA, tempB
end
end
clothesIndex = clothesIndex - 1
local texture, model = getClothesByTypeIndex ( clothesType, clothesIndex ) -- get the new texture and model
if ( texture == false ) then -- if we've reached the end of the list
removePedClothes ( thePlayer, clothesType )
else addPedClothes ( thePlayer, texture, model, clothesType )
end
end
addCommandHandler ( "previousClothes", scriptPreviousClothes )
</syntaxhighlight>

==See Also==
{{Clothes and body functions}}

SetSoundVolume

2010-01-26T18:46:00Z

Dakilla:

__NOTOC__
{{Client function}}
This function is used to change the volume level of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which volume you want to modify.
*'''volume:''' A [[float|floating]] point number representing the desired volume level.

===Returns===
Returns ''true'' if the [[sound]] element volume was successfully changed, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

SetSoundVolume

2010-01-26T18:44:22Z

Dakilla:

__NOTOC__
{{Client function}}
This function is used to change the volume level of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which volume you want to modify.
*'''volume:''' A [[floating|float]] point number representing the desired volume level.

===Returns===
Returns ''true'' if the [[sound]] element volume was successfully changed, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

GetDistanceBetweenPointAndSegment2D

2010-01-24T13:47:49Z

Dakilla: /* Example */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.

==Syntax==
<syntaxhighlight lang="lua">float getDistanceBetweenPointAndSegment2D(float pointX, float pointY, float x1, float y1, float x2, float y2)</syntaxhighlight>

===Required Arguments===
* '''pointX''': The X coordinate of the point.
* '''pointY''': The Y coordinate of the point.
* '''x1''': The X coordinate of the starting point of the line.
* '''y1''': The Y coordinate of the starting point of the line.
* '''x2''': The X coordinate of the ending point of the line.
* '''y2''': The Y coordinate of the ending point of the line.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getDistanceBetweenPointAndSegment2D(pointX, pointY, x1, y1, x2, y2)
local A = pointX - x1
local B = pointY - y1
local C = x2 - x1
local D = y2 - y1

local point = A * C + B * D
local lenSquare = C * C + D * D
local parameter = point / lenSquare

local shortestX
local shortestY

if parameter < 0 then
shortestX = x1
shortestY = y1
elseif parameter > 1 then
shortestX = x2
shortestY = y2
else
shortestX = x1 + parameter * C
shortestY = y1 + parameter * D
end

local distance = getDistanceBetweenPoints2D(pointX, pointY, shortestX, shortestY)

return distance
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="client" show="true">
This code draws a red line, enables mouse cursor and tells client how far from the line was clicked.
<syntaxhighlight lang="lua">
-- Draw a red line
addEventHandler("onClientRender", getRootElement(),
function()
dxDrawLine(20, 20, 200, 100, tocolor(255, 0, 0))
end
)

-- Show cursor
showCursor(true)

-- Fires when left mouse button is clicked
function cursorPositionFromTheRedLine(button, state, clickedX, clickedY)
-- Allow function to continue only if left button was pressed and button was pressed down
if button ~= "left" or state == "up" then
return
end

-- Calculate the distance
local distance = getDistanceBetweenPointAndSegment2D(clickedX, clickedY, 20, 20, 200, 100)

-- Tell user the distance
outputChatBox("You clicked "..distance.." away from the Red Line!")
end

-- Read mouse clicks
addEventHandler("onClientClick", root, cursorPositionFromTheRedLine)
</syntaxhighlight>
</section>

Code from: http://www.allegro.cc/forums/thread/589720

==See Also==
{{Useful_Functions}}

OnPlayerWeaponSwitch

2010-01-16T17:44:59Z

Dakilla: /* Parameters */

__NOTOC__
{{Server event}}
This event is triggered when a player switches weapons.

==Parameters==
<syntaxhighlight lang="lua">
int previousWeaponID, int currentWeaponID
</syntaxhighlight>

*'''previousWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched from
*'''currentWeaponID''': An [[int|integer]] representing the [[weapons|weapon]] that was switched to

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that switched his weapon.

==Example==
This example disables use of the minigun upon switch. It should be noted that this can be done more efficiently clientside.
<syntaxhighlight lang="lua">
function weaponSwitchDisableMinigun ( previousWeaponID, currentWeaponID ) --when a player switches his weapon
if currentWeaponID == 38 then --if the weapon ID is minigun
toggleControl ( source, "fire", false ) --disable the fire button
else --otherwise
toggleControl ( source, "fire", true ) --enable it
end
end
--add an event handler for onPlayerWeaponSwitch
addEventHandler ( "onPlayerWeaponSwitch", getRootElement(), weaponSwitchDisableMinigun )
</syntaxhighlight>

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

OnClientPlayerChangeNick

2010-01-10T13:57:38Z

Dakilla: /* Example: ouputChatbox must be 'outputChatBox' */

[[Category:Incomplete Event]]
{{Client event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.

==Source==
The source of this event is the player that changed his nick

==Example==
This disallows changing a nick
<syntaxhighlight lang="lua">
addEventHandler( "onClientPlayerChangeNick", getRootElement(),
function()
cancelEvent()
outputChatBox( "You can't change your nick!", source, 255, 0, 0, false )
end)
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

IsVehicleTaxiLightOn

2009-12-01T20:08:59Z

Dakilla:

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

===Returns===
Returns ''true'' if the light is on, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example binds the 'o' key to a function that toggles the taxi's light on and off, if you're in a taxi.
<syntaxhighlight lang="lua">
function toggleTaxiLight()
local thePlayer = getLocalPlayer()
local theVehicle = getPedOccupiedVehicle(thePlayer)
if thePlayer == getVehicleOccupant(theVehicle, 0) then -- if is a driver
local lights = getVehicleTaxiLightOn(theVehicle) -- getting vehicle lights state
local id = getElementModel(theVehicle) -- getting vehicle model
if ((id == 420) or (id== 438)) then -- if is a taxi
setVehicleTaxiLightOn(theVehicle, not lights) -- switch lights
end
end
end

bind("o", "down", toggleTaxiLight) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}

IsVehicleTaxiLightOn

2009-11-30T16:51:13Z

Dakilla: fixed a typo

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

===Returns===
Returns ''true'' if the light is on, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function myfunction()
local player = getLocalPlayer()
local vehicle = getPedOccupiedVehicle(player)
if player == getVehicleOccupant(vehicle, 0) then -- if is a driver
local lights = getVehicleTaxiLightOn(vehicle) -- getting vehicle lights state
local id = getElementModel(vehicle) -- getting vehicle model
if ((id == 420) or (id== 438)) then -- if is a taxi
setVehicleTaxiLightOn(vehicle, not lights) -- switch lights
end
end
end

bind("o", "down", myfunction) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}

SetSoundPosition

2009-11-29T08:44:06Z

Dakilla:

__NOTOC__
{{Client function}}
This function is used to change the seek position of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, int pos )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which seek position you want to modify.
*'''pos:''' An [[int]]eger value representing the new seek position of the sound in milliseconds.

===Returns===
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.

==Example==
This example allows the player to set how many milliseconds into the song he wants it to play from
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function setSongPos(cmd, ms)
local ssp = setSoundPosition(theSound, ms)
if(ssp == true) then
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox("Sound is now playing from: "..seconds.." Seconds!")
else
outputChatBox("An error has occured. Please make shore there are atleast")
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox(seconds.." Seconds in this song!")
end
end
addCommandHandler("skipsong", setSongPos)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

SetSoundPosition

2009-11-29T08:43:54Z

Dakilla: outputChatBox client-side doesnt have a 'visibleTo' parameter!

__NOTOC__
{{Client function}}
This function is used to change the seek position of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, int pos )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which seek position you want to modify.
*'''pos:''' An [[int]]eger value representing the new seek position of the sound in milliseconds.

===Returns===
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.

==Example==
This example allows the player to set how many milliseconds into the song he wants it to play from
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function setSongPos(cmd, ms)
local ssp = setSoundPosition(theSound, ms)
if(ssp == true) then
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox("Sound is now playing from: "..seconds.." Seconds!")
else
outputChatBox("An error has occured. Please make shore there are atleast"))
local seconds = ms / 1000 --this will get the amount of seconds from milliseconds
outputChatBox(seconds.." Seconds in this song!")
end
end
addCommandHandler("skipsong", setSongPos)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

IsSoundPaused

2009-11-28T19:28:44Z

Dakilla:

__NOTOC__
{{Client function}}
This function is used to return the current pause state of the specified [[sound]] element.

==Syntax==
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight>

===Required Arguments===
*'''theSound:''' The [[sound]] element which pause state you want to return.

===Returns===
Returns ''true'' if the [[sound]] element is paused, ''false'' if unpaused or invalid arguments were passed.

==Example==
This example will check and see if the sound is paused or not, and tell the player.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function checkSongPause()
local pause = isSoundPaused(theSound)
if(pause == true) then
outputChatBox("The sound is paused!")
else
outputChatBox("The sound is not paused!")
end
end
addCommandHandler("checkpause", checkSongPause)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

SetWeaponAmmo

2009-11-14T14:42:33Z

Dakilla: /* Optional Arguments */

__NOTOC__
{{Server function}}
Sets the ammo to a certain amount for a specified weapon (if they already have it), regardless of current ammo.

==Syntax==
<syntaxhighlight lang="lua">bool setWeaponAmmo ( player thePlayer, int weapon, int totalAmmo, [int ammoInClip = 0] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player
*'''weapon:''' A whole number integer that refers to a [[weapon]] ID.
*'''totalAmmo:''' A whole number integer serving as the total ammo amount for the given weapon (including ammo in clip).

===Optional Arguments===
{{OptionalArg}}
*'''ammoInClip:''' The amount of ammo to set in the player's clip. This will be taken from the main ammo. If left unspecified or set to 0, the current clip will remain.

==Returns==
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not.

==Example==
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

==See Also==
{{Weapon functions}}
[[Category:Needs Example]]
[[ru:setWeaponAmmo]]

RU/Resource:Editor

2009-11-09T12:21:28Z

Dakilla: /* Создание новых элементов */

{{RU/Resource page}}
{{translate}}
MTA:SA Редактор Карт позволяет создавать карты для вашего игрового мода.

==Начало==
Чтобы запустить редактор, просто нажмите на кнопку "Map editor" в главном меню MTA.

==Меню==
После запуска вы увидите два меню: в главном меню вверху, и элемент меню в левом нижнем углу.

===Главное меню===
Это меню состоит из нескольких кнопок:
* [[Image:Editor_New.png]] Создать новую карту.
* [[Image:Editor_Open.png]] Открыть существующую карту.
* [[Image:Editor_Save.png]] Сохранить карту.
* [[Image:Editor_Save_as.png]] Сохраните карту под другим именем.
* [[Image:Editor_Options.png]] Общие настройки карты.
* [[Image:Editor_Undo.png]] Отменить последнее действие.
* [[Image:Editor_Redo.png]] Восстановить отмененное действие.
* [[Image:Editor_Locations.png]] Сохраненные местоположения мира игры. Редактор идет с большим списком местоположений Интерьера San Andreas, но Вы можете также добавить свои собственные внутренние и внешние местоположения к списку.
* [[Image:Editor_Current_elements.png]] Все элементы, которые содержит карта (Объекты, транспорт маркеры, пикапы и т. п.)
* [[Image:Editor_Map_settings.png]] Настройки карты, такие как как время дня, сила тяжести и т.д. Здесь Вы можете также определить, с каким модом (gamemode) будет совместима ваша карта
* [[Image:Editor_Definitions.png]] Загрузить [[Resource:Editor/EDF|editor definition files (EDF)]]которые вы хотите использовать.
* [[Image:Editor_Test.png]] Вход в игру для тестирования вашей карты.

===Элементы меню===
Эти кнопки позволяют добавлять новые объекты на вашу карту.
* [[Image:Editor_Vehicle.png]] Создать новую машину.
* [[Image:Editor_Object.png]] Создать новый объект (Здания, дороги и другие декорации).
* [[Image:Editor_Pickup.png]] Создать новый пикап.
* [[Image:Editor_Marker.png]] Создать новый маркер.

Additionally, if you have [[Resource:Editor/EDF|editor definitions loaded]], you can roll the mousewheel in this menu to bring up custom elements.

==Использование редактора==
Этот раздел научит вас создавать и редактировать карты.

===Перемещение по карте===
Когда вы запускаете редактор, у вас включен режим ''camera mode''(Режим камеры). Используйте клавиши '''WSAD''' и мышь для управления камерой. Если вам нужно перемещать объект или камеру медленнее, зажмите'''ALT''', для быстрого перемещения, используйте '''SHIFT'''.

Чтобы получить доступ к панели управления редактором, перейдите в ''cursor mode''(Режим курсора). Вы можете переключаться между режимом курсора и режимом камеры, нажимая '''F'''. Когда вы в режиме курсора, позиция камеры зафиксирована, и вы можете использовать курсор для управления элементами карты и интерфейсом.

Режим камеры может быть полезен для быстрого перемещения по карте. Вы можете использовать его для выбора и перемещения элементов.

[[Image:Editor_Crosshair.png|center]]

===Запуск карты===
* Запустите редактор, выберите в меню ''New''.
* Выберите ''Map settings''. В разделе ''Meta'' заполните все поля. Откройте ''Gamemodes'' и добавьте игровой мод к вашей карте (Переместите их в список ''Added gamemodes''). Вы можете делать это выбирая и нажимая ''Add'', или двойным кликом по нему. Нажмите ОК когда закончите.
[[Image:Editor_Mapsettings.png|center]]
* Выберите пункт ''Definitions'' и добавьте ресурсы, которые вы хотите использовать как стандартные элементы. These will consist of the gamemodes you selected in the ''Map settings'' window, plus eventual additional resources. For more information about editor definitions, see [[Resource:Editor/EDF|EDF]]. Click OK when you're done.

===Создание новых элементов===
Добавлять новые элементы на карту очень просто!
* Если вы в режиме камеры, переключитесь к курсору кнопкой '''F'''.
* Кликните о нужной кнопке добавления объекта. Например, нажмите на кнопку Car для добавления автомобилей.
* Созданные вами объекты можно двигать.Зажмите на объекте левую кнопку мыши и перемещайте его.

[[Image:Editor_Addelem.png|center]]

To create custom elements that are specific to a resource, hover the cursor over the element menu and turn the scroll wheel until the desired resource comes up. Note that for this to work, you first have to add the [[Resource:Editor/EDF|EDF]] file of the resource in the ''Definitions'' window.

[[Image:Editor_Selectedf.png|center]]

===Выбор===
* '''Left click''' an element to select it in ''keyboard mode''.
* '''Right click''' it to select it in ''mouse mode''.
* Press the '''Spacebar''' or click in an empty area to deselect.

The selected element, if any, is denoted by a yellow cone marker. Elements (particularly objects) with poor collisions can be detected easier by enabling ''High sensitivity mode'', by pressing the '''E''' key. This increases detection at the expense of accuracy.

The ''Current elements'' dialog can also be used to select elements. Double-clicking an item within the list will select it in ''Keyboard mode''.

===Перемещение===
Moving elements can be done in several ways.

'''With the mouse'''
* Simply drag and drop with the '''left mouse button'''.
Or:
* Select the element in mouse mode ('''right click'''), move it to where you want it, and click to drop it off.

You can also adjust the ''Hold distance'' of an element toward and away from the camera by switching to camera mode, '''right clicking''' the element, and rolling the '''mouse wheel'''.

'''With the keyboard'''
* Select the element in keyboard mode ('''left click''').
* Use the '''arrow keys''' to move the element in the horizontal plane, and '''PgUp'''/'''PgDn''' to move it vertically. Hold '''ALT''' to decrease the movement speed, or '''SHIFT''' to increase it.

By default, elements move relative to the camera and are not locked to any axes. This can be disabled in the ''Options'' menu.

===Вращение===
'''With the mouse'''

You can rotate selected elements around the Z axis with the mouse wheel.
* Select the element in keyboard mode ('''left click''') and roll the mouse wheel while holding '''Left CTRL'''.
Or:
* Select the element in mouse mode ('''right click'''), hold '''CTRL''', and roll the mouse wheel.

'''With the keyboard'''
* Select the element in keyboard mode ('''left click''').
* While holding '''CTRL''' (the selection marker will turn green), use the '''arrow keys''' and '''PgUp'''/'''PgDn''' to rotate the element around the different axes.

With both methods you can additionally hold '''ALT''' to decrease the rotation speed or '''SHIFT''' to increase it.

[[Image:Editor_Rotateelem.png|center]]

==Настройки модели==
У большинства элементов есть множество вариантов настроек, которые нужны, чтобы изменить их внешность и поведение. Примеры - модель, цвет и визуальные модернизации автомобиля.

* Откройте окно свойств элемента двойным щелчком на нем или нажав клавишу "F3".
* Сделайте изменения по вашему усмотрению. Например, чтобы изменить модель автомобиля или объекта, щелкните кнопку "Browse " рядом с "model", чтобы открыть браузер моделей.
* Нажмите OK для закрытия и сохранения.

[[Image:Editor_Props.png|center]]

===Копирование===
Вы можете клонировать элемент, выбирая его и нажимая C.

* In mouse mode the cloned element will be attached to your cursor. '''Left click''' to place it in the map.
* In keyboard mode the cloned element will be cloned in the identical position.

If you hold '''CTRL''' while clicking, the element will be cloned again and will again be attached to the cursor. This way you can easily place large quantities of something.

Alternatively you can use the ''Pullout'' button located in the bottom-right corner of the properties box to clone an element.

===Удаление===
Simply select the element and press '''DEL''' ''(Delete)''.

Alternatively you can use the ''Pullout'' button located in the bottom-right corner of the properties box to delete an element.

==Управление==
Here is a list of all default controls. To change them please go to the MTA Settings menu while the Editor is started.

===Камера===
{|
|-
| camera_move_forwards
| '''w'''
|-
| camera_move_backwards
| '''s'''
|-
| camera_move_left
| '''a'''
|-
| camera_move_right
| '''d'''
|-
| high_sensitivity_mode
| '''e'''
|}

===Клонирование===
{|
|-
| клонировать выбранный элемент
| '''c'''
|-
| clone_drop_modifier
| '''lctrl''' || ''(Left CTRL)''
|}

===Манипуляции с элементами===
{|
|-
| element_move_forward
| '''arrow_u''' || ''(Arrow key Up)''
|-
| element_move_backward
| '''arrow_d''' || ''(Arrow key Down)''
|-
| element_move_left
| '''arrow_l''' || ''(Arrow key Left)''
|-
| element_move_right
| '''arrow_r''' || ''(Arrow key Right)''
|-
| element_move_downwards
| '''pgdn''' || ''(Page Down)''
|-
| element_move_upwards
| '''pgup''' || ''(Page Up)''
|-
| zoom_in
| '''mouse_wheel_down'''
|-
| zoom_out
| '''mouse_wheel_up'''
|-
| quick_rotate_increase
| '''mod_rotate''' + '''mouse_wheel_up''' || ''(Left CTRL + Mouse wheel Up)''
|-
| quick_rotate_decrease
| '''mod_rotate''' + '''mouse_wheel_down''' || ''(Left CTRL + Mouse wheel Down)''
|-
| mod_rotate
| '''lctrl''' || ''(Left CTRL)''
|-
| mod_slow_speed
| '''lalt''' || ''(Left ALT)''
|-
| mod_fast_speed
| '''lshift''' || ''(Left SHIFT)''
|-
| destroy_selected_element
| '''delete'''
|-
| drop_selected_element
| '''space'''
|-
| pickup_selected_element
| '''F2'''
|-
| reset_rotation
| '''mod_rotate''' + '''r''' || ''(Left CTRL + R)''
|}

===GUI===
{|
| toggle_gui_display
| '''F4'''
|-
| toggle_cursor
| '''f'''
|-
| select_target_keyboard
| '''mouse1''' || ''(Left Mouse button)''
|-
| select_target_mouse
| '''mouse2''' || ''(Right Mouse button)''
|-
| edf_next
| '''mouse_wheel_up'''
|-
| edf_prev
| '''mouse_wheel_down'''
|-
| Отменить
| '''Ctrl''' + '''z'''
|-
| Вернуть
| '''Ctrl''' + '''y'''
|-
| properties_toggle
| '''F3'''
|-
| browser_up
| '''arrow_u''' || ''(Arrow key Up)''
|-
| browser_down
| '''arrow_d''' || ''(Arrow key Down)''
|-
| browser_zoom_in
| '''mouse_wheel_up'''
|-
| browser_zoom_out
| '''mouse_wheel_down'''
|-
| browser_confirm
| '''enter'''
|-
| currentelements_up
| '''num_8''' || ''(Numpad key 8)''
|-
| currentelements_down
| '''num_2''' || ''(Numpad key 2)''
|-
| toggle_test
| '''F5'''
|}

==Мультиплеер==
The editor is built with both serverside and clientside components, and therefore supports multiplayer out of the box. To use the editor in multiplayer with other players, simply copy all of the editor's resources into your server, start the '''editor''' resource and allow other players to join.

Please note that currently the editor lacks any permissions system, ao all users have access to every function.

==Плагины и внешние ресурсы==
{{Main|Resource:Editor/Plugins}}

The editor allows basic importing of elements from external resources. This is useful for resources that may have to manipulate an element in a specific way that cannot be performed by the editor. For example, a map resource which uses custom models (and has a script to import these models) cannot be manipulated by default within the editor.

By using the '''import <resourceName>''' command in console the resource's elements can be imported within the editor.

==FAQ==
==== I get an "Could not start the local server. See console for details" when using the "Map Editor" button====
This is because you do not have a valid editor.conf installed. You can download the default one [http://multitheftauto.googlecode.com/svn/trunk/MTA10_Server/mods/deathmatch/editor.conf here]. It should be placed in '''server/mods/deathmatch/''' in your MTA: San Andreas installation directory.

==== I have saved a map but cannot find it in my server's resources directory, despite the Editor itself being able to see it ====
This is due to the fact that Vista limits write-access for non-admin processes in Program Files directory. Files get written in the "VirtualStore" dir instead of real Program Files folder. You should be able to locate your map resource in a similar directory to:
C:\Users\<USERNAME>\AppData\Local\VirtualStore\Program Files\MTA San Andreas\server\mods\deathmatch\resources\

Running the Server/MTA San Andreas with Administrative rights will allow the map to be saved to the proper location.

==== I have found a bug or have a suggestion/feedback for the map editor ====
Please use the official [http://bugs.mtasa.com bugtracker] for reporting bugs. Feel free to also join us on [http://mtasa.com/irc.html IRC].

<nowiki>Insert non-formatted text here</nowiki>

User:Dakilla

2009-11-03T20:39:59Z

Dakilla: Created page with 'Got any questions? Skype me: daki-boy. I don't know what to write here :P so i'll leave this place all white...'

Got any questions? Skype me: daki-boy.

I don't know what to write here :P so i'll leave this place all white...

OnMarkerHit

2009-11-03T20:38:10Z

Dakilla:

__NOTOC__
{{Server event}}
This event is triggered when an element enters a marker created using [[createMarker]].

==Parameters==
<syntaxhighlight lang="lua">
player hitElement, bool matchingDimension
</syntaxhighlight>

*'''hitElement''': The element that hit the marker
*'''matchingDimension''': True if the element is in the same dimension as the marker he hit

==Source==
The [[event system#Event source|source]] of this event is the [[marker]] that got hit by the element.

==Example==

This example will output a message what type of element has entered a marker.

<syntaxhighlight lang="lua">

local myMarker = createMarker( -2596.6259765625, 579.3583984375, 15.626741409302, 'cylinder', 2.0, 255, 0, 0, 150 )

function MarkerHit( hitElement, matchingDimension )
if getElementType( hitElement ) == "player" then
outputChatBox( "Player inside myMarker", getRootElement(), 255, 255, 0 )
elseif getElementType( hitElement ) == "vehicle" then
outputChatBox( "Vehicle inside myMarker", getRootElement(), 255, 255, 0 )
end
end
addEventHandler( "onMarkerHit", myMarker, MarkerHit )</syntaxhighlight>

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

OnMarkerLeave

2009-11-03T20:36:57Z

Dakilla: Minor changes + example

__NOTOC__
{{Server event}}
This event is triggered when an element leaves the area of a marker created using [[createMarker]].

==Parameters==
<syntaxhighlight lang="lua">
player leftElement, bool matchingDimension
</syntaxhighlight>

*'''leftPlayer''': The element that left the marker's area
*'''matchingDimension''': True if the element is in the same dimension as the marker he left

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

==Example==
This example shows a message in the chat box when element (in this case a player) leaves a marker.
<syntaxhighlight lang="lua">

local myMarker = createMarker( -2596.6259765625, 579.3583984375, 15.626741409302, "cylinder", 2.0, 255, 0, 0, 150 )

function markerLeave( leaveElement, matchingDimension )
if getElementType( leaveElement ) == "player" then
outputChatBox ( "Player has left a marker", getRootElement(), 255, 255, 0 )
end
end

addEventHandler( "onMarkerLeave", myMarker, markerLeave )
</syntaxhighlight>

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

OnMarkerHit

2009-11-03T20:32:20Z

Dakilla:

__NOTOC__
{{Server event}}
This event is triggered when an element enters a marker created using [[createMarker]].

==Parameters==
<syntaxhighlight lang="lua">
player hitElement, bool matchingDimension
</syntaxhighlight>

*'''hitElement''': The element that hit the marker
*'''matchingDimension''': True if the element is in the same dimension as the marker he hit

==Source==
The [[event system#Event source|source]] of this event is the [[marker]] that got hit by the element.

==Example==

This will output 'hi' in the chatbox when the marker is hit.

<syntaxhighlight lang="lua">

local myMarker = createMarker( -2596.6259765625, 579.3583984375, 15.626741409302, 'cylinder', 2.0, 255, 0, 0, 150 )

function MarkerHit( hitElement, matchingDimension )
if getElementType( hitElement ) == "player" then
outputChatBox( "Player inside myMarker", getRootElement(), 255, 255, 0 )
elseif getElementType( hitElement ) == "vehicle" then
outputChatBox( "Vehicle inside myMarker", getRootElement(), 255, 255, 0 )
end
end
addEventHandler( "onMarkerHit", myMarker, MarkerHit )</syntaxhighlight>

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

OnMarkerHit

2009-11-03T20:31:47Z

Dakilla: Minor changes + example

__NOTOC__
{{Server event}}
This event is triggered when a player enters a marker created using [[createMarker]].

==Parameters==
<syntaxhighlight lang="lua">
player hitElement, bool matchingDimension
</syntaxhighlight>

*'''hitElement''': The element that hit the marker
*'''matchingDimension''': True if the element is in the same dimension as the marker he hit

==Source==
The [[event system#Event source|source]] of this event is the [[marker]] that got hit by the element.

==Example==

This will output 'hi' in the chatbox when the marker is hit.

<syntaxhighlight lang="lua">

local myMarker = createMarker( -2596.6259765625, 579.3583984375, 15.626741409302, 'cylinder', 2.0, 255, 0, 0, 150 )

function MarkerHit( hitElement, matchingDimension )
if getElementType( hitElement ) == "player" then
outputChatBox( "Player inside myMarker", getRootElement(), 255, 255, 0 )
elseif getElementType( hitElement ) == "vehicle" then
outputChatBox( "Vehicle inside myMarker", getRootElement(), 255, 255, 0 )
end
end
addEventHandler( "onMarkerHit", myMarker, MarkerHit )</syntaxhighlight>

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

OnPlayerWasted

2009-10-30T15:32:48Z

Dakilla: /* Example: fixed a typo */

__NOTOC__
{{Server event}}
This event is triggered when a player is killed or dies.

==Parameters==
{{New feature|3|1.0|<syntaxhighlight lang="lua">
int totalAmmo, element killer, int killerWeapon, int bodypart [, bool stealth ]
</syntaxhighlight>}}

{{Deprecated_feature|3|1.0|<syntaxhighlight lang="lua">
int totalAmmo, element killer, int killerWeapon, int bodypart
</syntaxhighlight>}}

*'''totalAmmo''': an integer representing the total ammo the victim had when he died.
*'''killer''': an [[element]] representing the player or vehicle who was the killer. If there was no killer this is ''false''.
*'''killerWeapon''': an integer representing the [[weapon]] the killer used to kill the player.
*'''bodypart''': an integer representing the bodypart ID the victim was hit on when he died.
{{BodyParts}}
*{{New feature|3|1.0|'''stealth''': boolean value representing whether or not this was a stealth kill}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that died or got killed.

==Example==
This example prints the killer and bodypart to the chat when a player dies.
<syntaxhighlight lang="lua">
-- register player_Wasted as a handler for onPlayerWasted
function player_Wasted ( ammo, attacker, weapon, bodypart )
-- if there was an attacker
if ( attacker ) then
-- we declare our variable outside the following checks
local tempString
-- if the element that killed him was a player,
if ( getElementType ( attacker ) == "player" ) then
-- put the attacker, victim and weapon info in the string
tempString = getPlayerName ( attacker ).." killed "..getPlayerName ( source ).." ("..getWeaponNameFromID ( weapon )..")"
-- else, if it was a vehicle,
elseif ( getElementType ( attacker ) == "vehicle" ) then
-- we'll get the name from the attacker vehicle's driver
local tempString = getPlayerName ( getVehicleController ( attacker ) ).." killed "..getPlayerName ( source ).." ("..getWeaponNameFromID ( weapon )..")"
end
-- if the victim was shot in the head, append a special message
if ( bodypart == 9 ) then
tempString = tempString.." (HEADSHOT!)"
-- else, just append the bodypart name
else
tempString = tempString.." ("..getBodyPartName ( bodypart )..")"
end
-- display the message
outputChatBox ( tempString )
-- if there was no attacker,
else
-- output a death message without attacker info
outputChatBox ( getPlayerName ( source ).." died. ("..getWeaponNameFromID ( weapon )..") ("..getBodyPartName ( bodypart )..")" )
end
end
addEventHandler ( "onPlayerWasted", getRootElement(), player_Wasted )
</syntaxhighlight>

And another example, this will spawn you in the middle of GTA SA world (x=0, y=0, z=3) after 2 seconds of your death
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerWasted", getRootElement( ),
function()
setTimer( spawnPlayer, 2000, 1, source, 0, 0, 3 )
end
)
</syntaxhighlight>

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

GetVehicleName

2009-10-25T15:03:18Z

Dakilla: /* Example */

{{Server client function}}
__NOTOC__
This function returns a string containing the name of the vehicle

==Syntax==
<syntaxhighlight lang="lua">
string getVehicleName ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you want to get the name of.

===Returns===
Returns a string containing the requested vehicle's name, or ''false'' if the vehicle passed to the function is invalid.

==Example==
This example checks whether a player enters an AT-400 or a Shamal. If they do, it announces it to the chat specifying what vehicle was stolen.
<syntaxhighlight lang="lua">
function planeEnter ( theVehicle, seat, jacked ) -- when someone enters a vehicle
local id = getVehicleID ( theVehicle ) -- get the model ID of the vehicle
if id == 519 or id == 577 then -- if theVehicle is either Shamal or AT-400
local vehicleName = getVehicleName ( theVehicle ) -- get the name of theVehicle
outputChatBox ( "Someone has stolen a " .. vehicleName .. "!" ) -- announce that someone has stolen the plane
end
end
-- add the event handler to the event
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), planeEnter )
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}