Multi Theft Auto: Wiki - User contributions [en]

OnClientDoubleClick

2010-08-09T20:21:22Z

Gamesnert: Created page with '{{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…'

{{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==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

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

[[Category:Needs_Example]]

GetValidPedModels

2010-08-09T20:13:14Z

Gamesnert: Created page with '{{Server client function}} __NOTOC__ This function returns all valid ped models. ==Syntax== <syntaxhighlight lang="lua"> table getValidPedModels ( ) </syntaxhighlight> ===Returns=== Returns a table …'

{{Server client function}}
__NOTOC__
This function returns all valid ped models.

==Syntax==
<syntaxhighlight lang="lua">
table getValidPedModels ( )
</syntaxhighlight>

===Returns===
Returns a [[table]] with all valid ped models.

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

==See Also==
{{Ped functions}}
[[Category:Needs_Example]]

GetPedMoveState

2010-08-09T20:09:51Z

Gamesnert:

{{Client function}}
__NOTOC__
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

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

==See Also==
{{Ped functions}}
[[Category:Needs_Example]]

GetPedMoveState

2010-08-09T20:09:39Z

Gamesnert: Created page with '{{Server function}} __NOTOC__ This function returns the current move state for the specified ped. ==Syntax== <syntaxhighlight lang="lua"> string getPedMoveState ( ped thePed ) </syntaxhighlight> ===…'

{{Server function}}
__NOTOC__
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

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

==See Also==
{{Ped functions}}
[[Category:Needs_Example]]

Template:Ped move states

2010-08-09T20:09:22Z

Gamesnert: Created page with '<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div> * '''stand''': The ped is standing still…'

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
* '''stand''': The ped is standing still
* '''walk''': The ped is walking
* '''powerwalk''': The ped is walking quickly
* '''jog''': The ped is jogging
* '''sprint''': The ped is sprinting
* '''crouch''': The ped is crouching still
</div>

GetCameraViewMode

2010-08-09T19:59:38Z

Gamesnert:

__NOTOC__
{{Client function}}
This function allows you to get the camera's view mode. This indicates at what distance the camera will follow the player.
*'''Note:''' It currently only returns vehicle view modes

==Syntax==
<syntaxhighlight lang="lua">
int getCameraView ( )
</syntaxhighlight>

===Returns===
Returns an [[int]] indicating the current camera view mode. Their meanings can be seen below.

{{Camera view modes}}

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

==See Also==
{{Camera functions}}
[[Category:Needs_Example]]

SetCameraViewMode

2010-08-09T19:59:22Z

Gamesnert: Created page with '__NOTOC__ {{Client function}} This function allows you to set the camera's view mode. This indicates at what distance the camera will follow the player. *'''Note:''' It can curre…'

__NOTOC__
{{Client function}}
This function allows you to set the camera's view mode. This indicates at what distance the camera will follow the player.
*'''Note:''' It can currently only set vehicle view modes

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraView ( int viewMode )
</syntaxhighlight>

===Required Arguments===
*'''viewMode''': The view mode you wish to use
{{Camera view modes}}

===Returns===
Returns ''true'' if the view was set correctly, ''false'' otherwise.

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

==See Also==
{{Camera functions}}
[[Category:Needs_Example]]

GetCameraViewMode

2010-08-09T19:57:30Z

__NOTOC__
{{Client function}}
This function allows you to set the camera's view mode. This indicates at what distance the camera will follow the player.
*'''Note:''' It currently only returns vehicle view modes

==Syntax==
<syntaxhighlight lang="lua">
int getCameraView ( )
</syntaxhighlight>

===Returns===
Returns an [[int]] indicating the current camera view mode. Their meanings can be seen below.

{{Camera view modes}}

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

==See Also==
{{Camera functions}}
[[Category:Needs_Example]]

Template:Camera view modes

2010-08-09T19:55:38Z

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
* '''0''': Bumper
* '''1''': Close external
* '''2''': Middle external
* '''3''': Far external
* '''4''': Low external
* '''5''': Cinematic
</div>

ShowPlayerHudComponent

2010-08-09T19:39:00Z

Gamesnert:

__NOTOC__
{{Server client function}}
This function will show or hide a part of the player's HUD.
{{Deprecated_feature|3|1.0|
Component 'clock' does not hide the clock
}}

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( player thePlayer, string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' description
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature|3.0110|1.1|
:*'''all:''' All of the above at the same time
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool showPlayerHudComponent ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature|3.0110|1.1|
:*'''all:''' All of the above at the same time
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>

===Returns===
Returns ''true'' if the component was shown or hidden succesfully, ''false'' if an invalid argument was specified.

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
function hudChanger ()
showPlayerHudComponent ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
showPlayerHudComponent ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
-- Make our hudChanger function called when the player joins
addEventHandler ( "onPlayerJoin", getRootElement(), hudChanger )
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

EngineLoadTXD

2010-08-09T18:31:00Z

Gamesnert:

{{Client function}}
__NOTOC__
This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.

This is a client side function. Be sure to transfer your TXD file by including it in the meta file.

==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file [, bool filteringEnabled = true ] )
</syntaxhighlight>

===Required Arguments===
*'''txd_file:''' The [[filepath]] to the txd file you want to load

===Optional Arguments===
*'''filteringEnabled:''' Texture filtering

===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
col_floors = engineLoadCOL ( "models/office_floors.col" )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceCOL ( col_floors, 3781 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

Template:Ped functions

2010-08-09T18:29:22Z

Gamesnert:

*[[addPedClothes]]
*[[createPed]]
*[[doesPedHaveJetPack]]
*[[getPedAnimation]]
*[[getPedAmmoInClip]]
*[[getPedArmor]]
*[[getPedClothes]]
*[[getPedContactElement]]
*[[getPedFightingStyle]]
*[[getPedGravity]]
{{New feature|3.0110|1.1|
*[[getPedMoveState]]
}}
*[[getPedOccupiedVehicle]]
*[[getPedOccupiedVehicleSeat]]
*[[getPedRotation]]
*[[getPedSkin]]
*[[getPedStat]]
*[[getPedTarget]]
*[[getPedTotalAmmo]]
*[[getPedWeapon]]
*[[getPedWeaponSlot]]
*[[getValidPedModels]]
*[[givePedJetPack]]
*[[isPedChoking]]
*[[isPedDead]]
*[[isPedDoingGangDriveby]]
*[[isPedDucked]]
*[[isPedFrozen]]
*[[isPedHeadless]]
*[[isPedInVehicle]]
*[[isPedInWater]]
*[[isPedOnFire]]
*[[isPedOnGround]]
*[[killPed]]
*[[reloadPedWeapon]]
*[[removePedClothes]]
*[[removePedFromVehicle]]
*[[removePedJetPack]]
*[[setPedAnimation]]
*[[setPedArmor]]
*[[setPedChoking]]
*[[setPedDoingGangDriveby]]
*[[setPedFightingStyle]]
*[[setPedFrozen]]
*[[setPedGravity]]
*[[setPedHeadless]]
*[[setPedOnFire]]
*[[setPedRotation]]
*[[setPedSkin]]
*[[setPedStat]]
*[[setPedWeaponSlot]]
*[[warpPedIntoVehicle]]

Template:Ped functions

2010-08-09T18:23:42Z

Gamesnert:

*[[addPedClothes]]
*[[createPed]]
*[[doesPedHaveJetPack]]
*[[getPedAnimation]]
*[[getPedAmmoInClip]]
*[[getPedArmor]]
*[[getPedClothes]]
*[[getPedContactElement]]
*[[getPedFightingStyle]]
*[[getPedGravity]]
{{New feature|3.0110|1.1|
*[[getPedMoveState]]
}}
*[[getPedOccupiedVehicle]]
*[[getPedOccupiedVehicleSeat]]
*[[getPedRotation]]
*[[getPedSkin]]
*[[getPedStat]]
*[[getPedTarget]]
*[[getPedTotalAmmo]]
*[[getPedWeapon]]
*[[getPedWeaponSlot]]
{{New feature|3.0110|1.1|
*[[getValidPedModels]]
}}
*[[givePedJetPack]]
*[[isPedChoking]]
*[[isPedDead]]
*[[isPedDoingGangDriveby]]
*[[isPedDucked]]
*[[isPedFrozen]]
*[[isPedHeadless]]
*[[isPedInVehicle]]
*[[isPedInWater]]
*[[isPedOnFire]]
*[[isPedOnGround]]
*[[killPed]]
*[[reloadPedWeapon]]
*[[removePedClothes]]
*[[removePedFromVehicle]]
*[[removePedJetPack]]
*[[setPedAnimation]]
*[[setPedArmor]]
*[[setPedChoking]]
*[[setPedDoingGangDriveby]]
*[[setPedFightingStyle]]
*[[setPedFrozen]]
*[[setPedGravity]]
*[[setPedHeadless]]
*[[setPedOnFire]]
*[[setPedRotation]]
*[[setPedSkin]]
*[[setPedStat]]
*[[setPedWeaponSlot]]
*[[warpPedIntoVehicle]]

Template:Server functions

2010-08-09T18:19:59Z

Gamesnert:

*[[addCommandHandler]]
*[[executeCommandHandler]]
*[[fromJSON]]
*[[getFPSLimit]]
*[[getMaxPlayers]]
*[[getServerHttpPort]]
*[[getServerName]]
*[[getServerPassword]]
*[[getServerPort]]
*[[getVersion]]
*[[isGlitchEnabled]]
*[[outputChatBox]]
*[[outputConsole]]
*[[outputDebugString]]
*[[outputServerLog]]
*[[removeCommandHandler]]
*[[setFPSLimit]]
*[[setGlitchEnabled]]
{{New feature|3.0110|1.1|
*[[setServerName]]
}}
*[[setServerPassword]]
*[[showChat]]
*[[shutdown]]
*[[toJSON]]

Template:GUI events

2010-08-09T18:16:46Z

Gamesnert:

*[[onClientGUIClick]]
*[[onClientGUIDoubleClick]]
*[[onClientGUIChanged]]
*[[onClientGUIAccepted]]
*[[onClientGUIScroll]]
*[[onClientClick]]
{{New feature|3.0110|1.1|
*[[onClientDoubleClick]]
}}
*[[onClientMouseEnter]]
*[[onClientMouseLeave]]
*[[onClientMouseMove]]
*[[onClientMouseWheel]]
*[[onClientCursorMove]]
*[[onClientGUIMouseDown]]
*[[onClientGUIMouseUp]]
*[[onClientGUIMove]]
*[[onClientGUISize]]
*[[onClientGUITabSwitched]]

Template:Ped functions

2010-08-09T18:13:26Z

Gamesnert:

*[[addPedClothes]]
*[[createPed]]
*[[doesPedHaveJetPack]]
*[[getPedAnimation]]
*[[getPedAmmoInClip]]
*[[getPedArmor]]
*[[getPedClothes]]
*[[getPedContactElement]]
*[[getPedFightingStyle]]
*[[getPedGravity]]
{{New feature|3.0110|1.1|
*[[getPedMoveState]]
}}
*[[getPedOccupiedVehicle]]
*[[getPedOccupiedVehicleSeat]]
*[[getPedRotation]]
*[[getPedSkin]]
*[[getPedStat]]
*[[getPedTarget]]
*[[getPedTotalAmmo]]
*[[getPedWeapon]]
*[[getPedWeaponSlot]]
*[[givePedJetPack]]
*[[isPedChoking]]
*[[isPedDead]]
*[[isPedDoingGangDriveby]]
*[[isPedDucked]]
*[[isPedFrozen]]
*[[isPedHeadless]]
*[[isPedInVehicle]]
*[[isPedInWater]]
*[[isPedOnFire]]
*[[isPedOnGround]]
*[[killPed]]
*[[reloadPedWeapon]]
*[[removePedClothes]]
*[[removePedFromVehicle]]
*[[removePedJetPack]]
*[[setPedAnimation]]
*[[setPedArmor]]
*[[setPedChoking]]
*[[setPedDoingGangDriveby]]
*[[setPedFightingStyle]]
*[[setPedFrozen]]
*[[setPedGravity]]
*[[setPedHeadless]]
*[[setPedOnFire]]
*[[setPedRotation]]
*[[setPedSkin]]
*[[setPedStat]]
*[[setPedWeaponSlot]]
*[[warpPedIntoVehicle]]

Template:Camera functions

2010-08-09T18:09:31Z

Gamesnert:

* [[fadeCamera]]
* [[getCameraInterior]]
* [[getCameraMatrix]]
* [[getCameraTarget]]
{{New feature|3.0110|1.1|
* [[getCameraView]]
}}
* [[setCameraInterior]]
* [[setCameraMatrix]]
* [[setCameraTarget]]
{{New feature|3.0110|1.1|
* [[setCameraView]]
}}

Template:Utility functions

2010-08-09T18:03:21Z

Gamesnert:

*[[getColorFromString]]
*[[getDistanceBetweenPoints2D]]
*[[getDistanceBetweenPoints3D]]

{{New feature|3.0110|1.1|
*[[getPerformanceStats]]
}}
*[[getRealTime]]
*[[getTickCount]]
*[[getTimerDetails]]
*[[getTimers]]
*[[gettok]]
*[[killTimer]]
*[[resetTimer]]
*[[setTimer]]
*[[split]]
*[[isTimer]]
*[[md5]]

OnClientVehicleExplode

2010-08-09T17:51:12Z

Gamesnert: Created page with '{{Client event}} __NOTOC__ This event is triggered when a vehicle explodes. ==Parameters== This event has no parameters. ==Source== The source of this event is the vehicle th…'

{{Client event}}
__NOTOC__
This event is triggered when a vehicle explodes.

==Parameters==
This event has no parameters.

==Source==
The source of this event is the vehicle that exploded.

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

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

[[Category:Needs_Example]]

SetSoundEffectEnabled

2010-08-09T16:53:40Z

Gamesnert:

__NOTOC__
{{Client function}}
Used to enable or disable specific sound effects.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundEffectEnabled ( element sound, string effectName, bool toggle )</syntaxhighlight>

===Required Arguments===
*'''sound:''' a [[sound]] element.
*'''effectName:''' the effect you want to enable or disable
{{Sound_Effects}}
*'''toggle:''' ''true'' if you want to enable the effect, ''false'' if you want to disable it.

===Returns===
Returns ''true'' if the effect was set successfully, ''false'' otherwise.

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

==See Also==
{{Client_audio_functions}}

[[Category:Needs_Example]]

GetSoundEffects

2010-08-09T16:53:28Z

Gamesnert:

__NOTOC__
{{Client function}}
Returns the states of all effects of a sound.

==Syntax==
<syntaxhighlight lang="lua">table getSoundEffects ( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' a [[sound]] element.

===Returns===
Returns a [[table]] with the effect names as the keys, and their states as the values if successful. Otherwise, it returns ''false''.

'''Sound effect names:'''
{{Sound_Effects}}

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

==See Also==
{{Client_audio_functions}}

[[Category:Needs_Example]]

GetSoundMetaTags

2010-08-09T16:53:05Z

Gamesnert:

__NOTOC__
{{Client function}}
Used to get the meta tags attached to a sound. These provide information about the sound, for instance the title or the artist.

==Syntax==
<syntaxhighlight lang="lua">table getSoundMetaTags ( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' a [[sound]] element.

===Returns===
Returns a [[table]] with all data available (keys are listed below) for the sound if successful, ''false'' otherwise.

{{Sound_Meta_Tags}}

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

==See Also==
{{Client_audio_functions}}

[[Category:Needs_Example]]

GetSoundMetaTags

2010-08-09T16:52:37Z

Gamesnert: Created page with '__NOTOC__ {{Client function}} Used to get the meta tags attached to a sound. These provide information about the sound, for instance the title or the artist. ==Syntax== <syntaxhighlight lang="lua">…'

__NOTOC__
{{Client function}}
Used to get the meta tags attached to a sound. These provide information about the sound, for instance the title or the artist.

==Syntax==
<syntaxhighlight lang="lua">table getSoundMetaTags ( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' a [[sound]] element.

===Returns===
Returns a [[table]] with all data available for the sound if successful, ''false'' otherwise.

{{Sound_Meta_Tags}}

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

==See Also==
{{Client_audio_functions}}

[[Category:Needs_Example]]

Template:Sound Meta Tags

2010-08-09T16:49:51Z

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
* '''title'''
* '''artist'''
* '''album'''
* '''genre'''
* '''year'''
* '''comment'''
* '''track'''
* '''composer'''
* '''copyright'''
* '''subtitle'''
* '''album_artist'''
* '''stream_name'''
* '''stream_title'''
</div>

SetSoundEffectEnabled

2010-08-09T16:43:43Z

Gamesnert: Created page with '__NOTOC__ {{Client function}} Used to enable or disable specific sound effects. ==Syntax== <syntaxhighlight lang="lua">int setSoundEffectEnabled ( element sound, string effectName, bool togg…'

__NOTOC__
{{Client function}}
Used to enable or disable specific sound effects.

==Syntax==
<syntaxhighlight lang="lua">int setSoundEffectEnabled ( element sound, string effectName, bool toggle )</syntaxhighlight>

===Required Arguments===
*'''sound:''' a [[sound]] element.
*'''effectName:''' the effect you want to enable or disable
{{Sound_Effects}}
*'''toggle:''' ''true'' if you want to enable the effect, ''false'' if you want to disable it.

===Returns===
Returns ''true'' if the effect was set successfully, ''false'' otherwise.

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

==See Also==
{{Client_audio_functions}}

[[Category:Needs_Example]]

GetSoundEffects

2010-08-09T16:40:30Z

Gamesnert: Created page with '__NOTOC__ {{Client function}} Returns the states of all effects of a sound. ==Syntax== <syntaxhighlight lang="lua">int getSoundEffects ( element sound )</syntaxhighlight> ===Required Arguments=== *'…'

__NOTOC__
{{Client function}}
Returns the states of all effects of a sound.

==Syntax==
<syntaxhighlight lang="lua">int getSoundEffects ( element sound )</syntaxhighlight>

===Required Arguments===
*'''sound:''' a [[sound]] element.

===Returns===
Returns a [[table]] with the effect names as the keys, and their states as the values if successful. Otherwise, it returns ''false''.

'''Sound effect names:'''
{{Sound_Effects}}

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

==See Also==
{{Client_audio_functions}}

[[Category:Needs_Example]]

Template:Sound Effects

2010-08-09T16:35:51Z

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
* '''gargle'''
* '''compressor'''
* '''echo'''
* '''i3dl2reverb'''
* '''distortion'''
* '''chorus'''
* '''parameq'''
* '''reverb'''
* '''flanger'''
</div>

OnClientSoundChangedMeta

2010-08-09T16:31:23Z

Gamesnert: Created page with '__NOTOC__ {{Client event}} This event is triggered when a sound's meta tags have been modified. ==Parameters== <syntaxhighlight lang="lua"> string streamTitle </syntaxhighlight> *'''streamTitle''': The…'

__NOTOC__
{{Client event}}
This event is triggered when a sound's meta tags have been modified.

==Parameters==
<syntaxhighlight lang="lua">
string streamTitle
</syntaxhighlight>

*'''streamTitle''': The title of a specific stream

==Source==
The [[event system#Event source|source]] of this event is the [[sound]] of which the meta tags have just been modified.

==Example==

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

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

[[Category:Needs_Example]]

OnClientSoundFinishedDownload

2010-08-09T16:27:32Z

Gamesnert: Created page with '__NOTOC__ {{Client event}} This event is triggered when a sound has just finished downloading. This means the complete sound file is now loaded in the player's RAM, and can be pl…'

__NOTOC__
{{Client event}}
This event is triggered when a sound has just finished downloading. This means the complete sound file is now loaded in the player's RAM, and can be played completely from start to end. Unlike [[onClientSoundStream]], this event only triggers for file streams, not for live ones since live streams never actually end.

==Parameters==
<syntaxhighlight lang="lua">
int length
</syntaxhighlight>

*'''length''': The length of the stream in milliseconds

==Source==
The [[event system#Event source|source]] of this event is the [[sound]] which just finished downloading.

==Example==

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

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

[[Category:Needs_Example]]

OnClientSoundStream

2010-08-09T16:21:11Z

Gamesnert: Created page with '__NOTOC__ {{Client event}} This event is triggered when a sound has just finished initial streaming. For file streams, this means the sound will now start playing, but isn't done…'

__NOTOC__
{{Client event}}
This event is triggered when a sound has just finished initial streaming. For file streams, this means the sound will now start playing, but isn't done downloading yet. For live streams, this just means the stream will start playing. This event will also trigger when, for some reason, the streaming failed.

==Parameters==
<syntaxhighlight lang="lua">
bool success, int length, string streamName
</syntaxhighlight>

*'''success''': A [[boolean]] indicating whether the stream was a success or not
*'''length''': The length of the stream in milliseconds. Always returns '''0''' for a live stream
*'''streamName''': The name of the stream. Note that this isn't the filename. Also note that this isn't always provided

==Source==
The [[event system#Event source|source]] of this event is the [[sound]] which either successfully streamed or failed to stream.

==Example==

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

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

[[Category:Needs_Example]]

SetTrafficLightState

2010-08-09T16:01:30Z

Gamesnert:

__NOTOC__
{{Server client function}}
Sets the current traffic light state. This state controls the traffic light colors. For instance, state '''1''' will cause the north and south traffic lights to be amber, and the ones left and east will turn red.

==Syntax==
<syntaxhighlight lang="lua">
bool setTrafficLightState ( int state )
</syntaxhighlight>

===Required Arguments===
*'''state''': The [[Traffic_light_states|state]] you wish to use (possible values: 0-9)

===Returns===
Returns ''true'' if the state was successfully set, ''false'' otherwise.

==Example==
This example causes all traffic lights to be out of order. (flashing amber)

<syntaxhighlight lang="lua">
function handleTrafficLightsOutOfOrder()
-- See if the lights are currently off
local lightsOff = getTrafficLightState() == 9

if lightsOff then
-- If they're off, turn them on
setTrafficLightState(6)
else
-- If they're on, turn them off
setTrafficLightState(9)
end
end
-- Repeat it every half a second
setTimer(handleTrafficLightsOutOfOrder,500,0)
</syntaxhighlight>

==See Also==
{{World_functions}}

GetTrafficLightState

2010-08-09T16:01:20Z

Gamesnert:

__NOTOC__
{{Server client function}}
Gets the current traffic light state. This state controls the traffic light colors. For instance, state '''1''' will cause the north and south traffic lights to be amber, and the ones left and east will turn red.

==Syntax==
<syntaxhighlight lang="lua">
int getTrafficLightState ( )
</syntaxhighlight>

===Returns===
Returns the current [[Traffic_light_states|state]] of the traffic lights.

==Example==
This example causes all traffic lights to be out of order. (flashing amber)

<syntaxhighlight lang="lua">
function handleTrafficLightsOutOfOrder()
-- See if the lights are currently off
local lightsOff = getTrafficLightState() == 9

if lightsOff then
-- If they're off, turn them on
setTrafficLightState(6)
else
-- If they're on, turn them off
setTrafficLightState(9)
end
end
-- Repeat it every half a second
setTimer(handleTrafficLightsOutOfOrder,500,0)
</syntaxhighlight>

==See Also==
{{World_functions}}

SetTrafficLightState

2010-08-09T16:01:05Z

Gamesnert: /* Example */

GetTimerDetails

2010-08-08T21:46:57Z

Gamesnert:

__NOTOC__
{{Server client function}}

This function is for getting the details of a running timer.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int getTimerDetails ( timer theTimer )
</syntaxhighlight>

===Required Arguments===
*'''theTimer:''' A timer element.

===Returns===
* Integer one represents the time left in miliseconds (1000th of a second) of the current time left in the loop.
* Integer two represents the ammount of times the timer has left to execute.
* Integer three represents the ammount of times the timer will execute.

* Returns false if the timer doesn't exist or stopped running. Also, debugscript will say "Bad Argument @ 'getTimerDetails'". To prevent this, you can check if the timer exists with [[isTimer]]().

==Example==
This example creates a 1 second (1000 ms) timer that will run 1000 times, and you can see the timer details by using the command: timerdetails.
<syntaxhighlight lang="lua">
theTimer = setTimer(function() end, 1000, 10) -- A timer that does nothing.

function timerDetails()
remaining, executesRemaining, totalExecutes = getTimerDetails(theTimer) -- Get the timers details
if (remaining and executesRemaining and totalExecutes) then
outputChatBox("Time remaining this second: "..remaining.." Executes remaining: "..executesRemaining.." Total executes: "..totalExecutes)
else
outputChatBox("Timer no longer exists")
end
end
addCommandHandler("timerdetails", timerDetails)
</syntaxhighlight>

==See Also==
{{Utility functions}}

GetTimerDetails

2010-08-08T21:46:09Z

Gamesnert:

Traffic light states

2010-08-08T21:11:18Z

Gamesnert:

Here you can see the traffic light states used by [[setTrafficLightState]] and [[getTrafficLightState]]. The upper light represents the traffic light on the north side, the lower represents the south side, etc etc. If there isn't any traffic light on one or more of the sides, it doesn't affect the others.

{| cellspacing="50"
|-
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 0'''
|-
! !! [[File:Traffic_green.png]] !!
|-
! [[File:Traffic_red.png]] !! !! [[File:Traffic_red.png]]
|-
! !! [[File:Traffic_green.png]] !!
|}
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 1'''
|-
! !! [[File:Traffic_amber.png]] !!
|-
! [[File:Traffic_red.png]] !! !! [[File:Traffic_red.png]]
|-
! !! [[File:Traffic_amber.png]] !!
|}
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 2'''
|-
! !! [[File:Traffic_red.png]] !!
|-
! [[File:Traffic_red.png]] !! !! [[File:Traffic_red.png]]
|-
! !! [[File:Traffic_red.png]] !!
|}
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 3'''
|-
! !! [[File:Traffic_red.png]] !!
|-
! [[File:Traffic_green.png]] !! !! [[File:Traffic_green.png]]
|-
! !! [[File:Traffic_red.png]] !!
|}
|-
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 4'''
|-
! !! [[File:Traffic_red.png]] !!
|-
! [[File:Traffic_amber.png]] !! !! [[File:Traffic_amber.png]]
|-
! !! [[File:Traffic_red.png]] !!
|}
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 5'''
|-
! !! [[File:Traffic_green.png]] !!
|-
! [[File:Traffic_green.png]] !! !! [[File:Traffic_green.png]]
|-
! !! [[File:Traffic_green.png]] !!
|}
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 6'''
|-
! !! [[File:Traffic_amber.png]] !!
|-
! [[File:Traffic_amber.png]] !! !! [[File:Traffic_amber.png]]
|-
! !! [[File:Traffic_amber.png]] !!
|}
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 7'''
|-
! !! [[File:Traffic_amber.png]] !!
|-
! [[File:Traffic_green.png]] !! !! [[File:Traffic_green.png]]
|-
! !! [[File:Traffic_amber.png]] !!
|}
|-
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 8'''
|-
! !! [[File:Traffic_green.png]] !!
|-
! [[File:Traffic_amber.png]] !! !! [[File:Traffic_amber.png]]
|-
! !! [[File:Traffic_green.png]] !!
|}
!
{| border="0" cellpadding="2" cellspacing="0" style="border-collapse: collapse;"
|+ '''State 9'''
|-
! !! [[File:Traffic_off.png]] !!
|-
! [[File:Traffic_off.png]] !! !! [[File:Traffic_off.png]]
|-
! !! [[File:Traffic_off.png]] !!
|}
|}

File:Traffic off.png

2010-08-08T21:08:49Z

Gamesnert:

Template:Client audio functions

2010-08-08T15:41:01Z

Gamesnert:

*[[playSoundFrontEnd]]
*[[getRadioChannel]]
*[[getRadioChannelName]]
{{New feature|3.0110|1.1|
*[[getSoundEffects]]
}}
*[[getSoundLength]]
*[[getSoundMaxDistance]]
{{New feature|3.0110|1.1|
*[[getSoundMetaTags]]
}}
*[[getSoundMinDistance]]
*[[getSoundPosition]]
*[[getSoundSpeed]]
*[[getSoundVolume]]
*[[isSoundPaused]]
*[[playSound]]
*[[playSound3D]]
*[[setRadioChannel]]
{{New feature|3.0110|1.1|
*[[setSoundEffectEnabled]]
}}
*[[setSoundMaxDistance]]
*[[setSoundMinDistance]]
*[[setSoundPaused]]
*[[setSoundPosition]]
*[[setSoundSpeed]]
*[[setSoundVolume]]
*[[stopSound]]

Client Scripting Events

2010-08-08T15:12:38Z

Gamesnert:

<pageclass class="client"></pageclass>
This page lists all '''client-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]].

'''Server-side scripting events can be found here: [[Server Scripting Events]]

==Colshape events==
{{Client_colshape_events}}

==Element events==
{{Client_element_events}}

==GUI events==
{{GUI_events}}

==Marker events==
{{Client_marker_events}}

==Ped events==
{{Client_ped_events}}

==Player events==
{{Client_player_events}}

==Projectile events==
{{Client_projectile_events}}

==Resource events==
{{Client_resource_events}}

==Sound events==
{{Sound_events}}

==Vehicle events==
{{Client_vehicle_events}}

==Other events==
{{Client_other_events}}

[[pl:Zdarzenia_po_stronie_klienta]]
[[ru:Client Scripting Events]]

Sound events

2010-08-08T15:12:26Z

Gamesnert: moved Sound events to Template:Sound events: Oops

#REDIRECT [[Template:Sound events]]

Template:Sound events

2010-08-08T15:12:26Z

Gamesnert: moved Sound events to Template:Sound events: Oops

{{New feature|3.0110|1.1|
* [[onClientSoundChangedMeta]]
* [[onClientSoundFinishedDownload]]
* [[onClientSoundStream]]
}}

Template:Sound events

2010-08-08T15:11:35Z

Gamesnert: Created page with '{{New feature|3.0110|1.1| * onClientSoundChangedMeta * onClientSoundFinishedDownload * onClientSoundStream }}'

{{New feature|3.0110|1.1|
* [[onClientSoundChangedMeta]]
* [[onClientSoundFinishedDownload]]
* [[onClientSoundStream]]
}}

Template:Element functions

2010-08-08T15:08:48Z

Gamesnert:

*[[clearElementVisibleTo]]
*[[cloneElement]]
*[[createElement]]
*[[destroyElement]]
*[[getAllElementData]]
*[[getAttachedElements]]
*[[getElementAlpha]]
{{New feature|3.0110|1.1|
* [[getElementAttachedOffsets]]
}}
*[[getElementAttachedTo]]
*[[getElementByID]]
*[[getElementByIndex]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementColShape]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementInterior]]
*[[getElementParent]]
*[[getElementPosition]]
{{New feature|3.0004|1.0.4|
*[[getElementRotation]]
}}
*[[getElementsByType]]
*[[getElementsWithinColShape]]
*[[getElementType]]
*[[getElementVelocity]]
*[[getElementZoneName]]
*[[getRootElement]]
*[[isElement]]
*[[isElementAttached]]
{{New feature|3.0004|1.0.4|
*[[isElementDoubleSided]]
}}
*[[isElementVisibleTo]]
*[[isElementWithinColShape]]
*[[removeElementData]]
*[[setElementAlpha]]
*[[setElementData]]
{{New feature|3.0004|1.0.4|
*[[setElementDoubleSided]]
}}
*[[setElementDimension]]
*[[setElementHealth]]
*[[setElementID]]
*[[setElementInterior]]
*[[setElementParent]]
*[[setElementPosition]]
{{New feature|3.0004|1.0.4|
*[[setElementSyncer]]
*[[setElementRotation]]
}}
*[[setElementVelocity]]
*[[setElementVisibleTo]]
{{New feature|3|1.0|
*[[attachElements]]
*[[detachElements]]
*[[getElementModel]]
*[[getElementSyncer]]
*[[isElementInWater]]
*[[setElementAttachedOffsets]]
*[[setElementModel]]
}}
{{Deprecated_feature|3|1.0|
*[[attachElementToElement]]
*[[detachElementFromElement]]
}}

Template:Client element functions

2010-08-08T15:07:50Z

Gamesnert:

*[[createElement]]
*[[destroyElement]]
*[[getAttachedElements]]
{{New feature|3.0110|1.1|
* [[getElementAttachedOffsets]]
}}
*[[getElementAttachedTo]]
*[[getElementBoundingBox]]
*[[getElementByID]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementDistanceFromCentreOfMassToBaseOfModel]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementInterior]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementRadius]]
*[[getElementsByType]]
*[[getElementsWithinColShape]]
*[[getElementType]]
*[[getElementVelocity]]
*[[getRootElement]]
*[[isElement]]
*[[isElementAttached]]
*[[isElementLocal]]
*[[isElementOnScreen]]
*[[isElementStreamable]]
*[[isElementStreamedIn]]
*[[isElementWithinColShape]]
*[[setElementAlpha]]
*[[setElementCollisionsEnabled]]
*[[setElementData]]
*[[setElementDimension]]
{{New feature|3.0004|1.0.4|
*[[setElementDoubleSided]]
}}
*[[setElementHealth]]
*[[setElementInterior]]
*[[setElementParent]]
*[[setElementPosition]]
*[[setElementStreamable]]
*[[setElementVelocity]]
{{New feature|3|1.0|
*[[attachElements]]
*[[detachElements]]
*[[getElementColShape]]
*[[getElementMatrix]]
*[[getElementModel]]
*[[getElementRotation]]
*[[isElementInWater]]
*[[isElementSyncer]]
*[[setElementModel]]
*[[setElementRotation]]
}}
{{New feature|3.0001|1.0.1|
*[[isElementCollidableWith]]
*[[setElementCollidableWith]]
}}
{{New feature|3.0004|1.0.4|
*[[isElementDoubleSided]]
}}
{{Deprecated_feature|3|1.0|
*[[attachElementToElement]]
*[[detachElementFromElement]]
}}

Template:Client world functions

2010-08-08T15:03:46Z

Gamesnert:

{{New feature|3.0110|1.1|
* [[areTrafficLightsLocked]]
}}
*[[getGameSpeed|getGameSpeed]]
*[[getGravity|getGravity]]
*[[getGroundPosition|getGroundPosition]]
*[[getScreenFromWorldPosition|getScreenFromWorldPosition]]
*[[getTime|getTime]]
{{New feature|3.0110|1.1|
* [[getTrafficLightState]]
}}
*[[getWeather|getWeather]]
*[[getWorldFromScreenPosition|getWorldFromScreenPosition]]
*[[getZoneName|getZoneName]]
*[[isLineOfSightClear|isLineOfSightClear]]
*[[processLineOfSight|processLineOfSight]]
*[[resetSkyGradient|resetSkyGradient]]
*[[setGameSpeed|setGameSpeed]]
*[[setGravity|setGravity]]
*[[setSkyGradient|setSkyGradient]]
*[[setTime|setTime]]
{{New feature|3.0110|1.1|
* [[setTrafficLightState]]
* [[setTrafficLightsLocked]]
}}
*[[setWeather|setWeather]]
*[[setWeatherBlended|setWeatherBlended]]
*[[testLineAgainstWater|testLineAgainstWater]]
{{New feature|3|1.0|
*[[getCloudsEnabled|getCloudsEnabled]]
*[[getGarageBoundingBox|getGarageBoundingBox]]
*[[getGaragePosition|getGaragePosition]]
*[[getGarageSize|getGarageSize]]
*[[getMinuteDuration|getMinuteDuration]]
*[[getPlayerBlurLevel|getBlurLevel]]
*[[isGarageOpen|isGarageOpen]]
*[[isWorldSpecialPropertyEnabled|isWorldSpecialPropertyEnabled]]
*[[setCloudsEnabled|setCloudsEnabled]]
*[[setGarageOpen|setGarageOpen]]
*[[setJetpackMaxHeight|setJetpackMaxHeight]]
*[[setMinuteDuration|setMinuteDuration]]
*[[setPlayerBlurLevel|setBlurLevel]]
*[[setWorldSpecialPropertyEnabled|setWorldSpecialPropertyEnabled]]
}}

AreTrafficLightsLocked

2010-08-08T14:58:41Z

Gamesnert: Created page with '__NOTOC__ {{Server client function}} Gets whether the traffic lights are currently locked or not. If the lights are locked, it means they won't change unless you do [[setTrafficL…'

__NOTOC__
{{Server client function}}
Gets whether the traffic lights are currently locked or not. If the lights are locked, it means they won't change unless you do [[setTrafficLightState]].

==Syntax==
<syntaxhighlight lang="lua">
bool areTrafficLightsLocked ( )
</syntaxhighlight>

===Returns===
Returns ''true'' the traffic lights are currently locked, ''false'' otherwise.

==Example==
This example doesn't exist

==See Also==
{{World_functions}}

[[Category:Needs_Example]]

SetTrafficLightsLocked

2010-08-08T14:57:11Z

Gamesnert: Created page with '__NOTOC__ {{Server client function}} Toggles whether you want the traffic lights to be locked. If the lights are locked, it means they won't change unless you do [[setTrafficLigh…'

__NOTOC__
{{Server client function}}
Toggles whether you want the traffic lights to be locked. If the lights are locked, it means they won't change unless you do [[setTrafficLightState]].

==Syntax==
<syntaxhighlight lang="lua">
bool setTrafficLightsLocked ( bool toggle )
</syntaxhighlight>

===Required Arguments===
*'''toggle''': A [[bool]] indicating whether you want the traffic lights to change automatically, or not

===Returns===
Returns ''true'' if the successful, ''false'' otherwise.

==Example==
This example doesn't exist

==See Also==
{{World_functions}}

[[Category:Needs_Example]]

GetTrafficLightState

2010-08-08T14:54:50Z

Gamesnert: Created page with '__NOTOC__ {{Server client function}} Gets the current traffic light state. This state controls the traffic light colors. For instance, state '''1''' will cause the north and sout…'

Template:World functions

2010-08-08T14:52:14Z

Gamesnert:

{{New feature|3.0110|1.1|
* [[areTrafficLightsLocked]]
}}
*[[getCloudsEnabled]]
*[[getGameSpeed]]
*[[getGravity]]
*[[getTime]]
{{New feature|3.0110|1.1|
* [[getTrafficLightState]]
}}
*[[getWeather]]
*[[getZoneName]]
*[[isGarageOpen]]
*[[resetSkyGradient]]
*[[setCloudsEnabled]]
*[[setGameSpeed]]
*[[setGarageOpen]]
*[[setGravity]]
*[[setMinuteDuration]]
*[[setSkyGradient]]
*[[setTime]]
{{New feature|3.0110|1.1|
* [[setTrafficLightState]]
* [[setTrafficLightsLocked]]
}}
*[[setWeather]]
*[[setWeatherBlended]]

SetTrafficLightState

2010-08-08T14:49:39Z

Gamesnert: Created page with '__NOTOC__ {{Server client function}} Sets the current traffic light state. This state controls the traffic light colors. For instance, state '''1''' will cause the north and sout…'