Multi Theft Auto: Wiki - User contributions [en]

Template:Handling Properties

2012-03-07T16:03:48Z

MX Master: Changed type of 'headLight' and 'tailLight' to 'String'. Added available values. Data based on testing of MTASA v1.3-release-3898

<br> http://projectcerbera.com/gta/sa/tutorials/handling <br>
{| border="1" cellpadding="1" cellspacing="0" align="center"
|-
! scope="col" style="background:#afafaf;"|Property
! scope="col" style="background:#afafaf;"|Value
! scope="col" style="background:#afafaf;"|Minimum value
! scope="col" style="background:#afafaf;"|Maximum value
! scope="col" style="background:#afafaf;"|Notes
|-
| scope="row" style="background:#cfcfcf;"|'''mass'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|1.0
| style="background:#efefef;"|100000.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''turnMass'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|1000000.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''dragCoeff'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|-200.0
| style="background:#efefef;"|200.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''centerOfMass'''
| style="background:#efefef;"|Table = { [1]=posX, [2]=posY, [3]=posZ } (floats)
| style="background:#efefef;"|-10.0
| style="background:#efefef;"|10.0
| style="background:#efefef;"|Get returns a table, set needs a table.
|-
| scope="row" style="background:#cfcfcf;"|'''percentSubmerged'''
| style="background:#efefef;"|Integer
| style="background:#efefef;"|1
| style="background:#efefef;"|99999
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''tractionMultiplier'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|-100000.0
| style="background:#efefef;"|100000.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''tractionLoss'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|100.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''tractionBias'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|1.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''numberOfGears'''
| style="background:#efefef;"|Integer
| style="background:#efefef;"|1
| style="background:#efefef;"|5
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''maxVelocity'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.1
| style="background:#efefef;"|200000.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''engineAcceleration'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|100000.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''engineInertia'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|-1000.0
| style="background:#efefef;"|1000.0
| style="background:#efefef;"|Inertia of 0 can cause a LSOD. (Unable to divide by zero)
|-
| scope="row" style="background:#cfcfcf;"|'''driveType'''
| style="background:#efefef;"|String
| style="background:#efefef;"|N/A
| style="background:#efefef;"|N/A
| style="background:#efefef;"|Use 'rwd', 'fwd' or 'awd'.
|-
| scope="row" style="background:#cfcfcf;"|'''engineType'''
| style="background:#efefef;"|String
| style="background:#efefef;"|N/A
| style="background:#efefef;"|N/A
| style="background:#efefef;"|Use 'petrol', 'diesel' or 'electric'.
|-
| scope="row" style="background:#cfcfcf;"|'''brakeDeceleration'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.1
| style="background:#efefef;"|100000.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''brakeBias'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|1.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''ABS'''
| style="background:#efefef;"|Boolean
| style="background:#efefef;"|true
| style="background:#efefef;"|false
| style="background:#efefef;"|Has no effect.
|-
| scope="row" style="background:#cfcfcf;"|'''steeringLock'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|360.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''suspensionForceLevel'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|100.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''suspensionDamping'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|100.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''suspensionHighSpeedDamping'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|600.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''suspensionUpperLimit'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|-50.0
| style="background:#efefef;"|50.0
| style="background:#efefef;"|Can't be equal to suspensionLowerLimit.
|-
| scope="row" style="background:#cfcfcf;"|'''suspensionLowerLimit'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|-50.0
| style="background:#efefef;"|50.0
| style="background:#efefef;"|Can't be equal to suspensionUpperLimit.
|-
| scope="row" style="background:#cfcfcf;"|'''suspensionFrontRearBias'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|1.0
| style="background:#efefef;"|Hardcoded maximum is 3.0, but values above 1.0 have no effect.
|-
| scope="row" style="background:#cfcfcf;"|'''suspensionAntiDiveMultiplier'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|30.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''seatOffsetDistance'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|-20.0
| style="background:#efefef;"|20.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''collisionDamageMultiplier'''
| style="background:#efefef;"|Float
| style="background:#efefef;"|0.0
| style="background:#efefef;"|10.0
| style="background:#efefef;"|
|-
| scope="row" style="background:#cfcfcf;"|'''monetary'''
| style="background:#efefef;"|Integer
| style="background:#efefef;"|0
| style="background:#efefef;"|230195200
| style="background:#efefef;"|Get works, set is disabled.
|-
| scope="row" style="background:#cfcfcf;"|'''modelFlags'''
| style="background:#efefef;"|Hexadecimal/Decimal
| style="background:#efefef;"|N/A
| style="background:#efefef;"|N/A
| style="background:#efefef;"|Property uses a decimal value, generated by a hexadecimal value. Either use 0x12345678 or tonumber ( "0x12345678" ). See [http://projectcerbera.com/gta/sa/tutorials/handling projectcerbera] for possible values.
|-
| scope="row" style="background:#cfcfcf;"|'''handlingFlags'''
| style="background:#efefef;"|Hexadecimal/Decimal
| style="background:#efefef;"|N/A
| style="background:#efefef;"|N/A
| style="background:#efefef;"|Property uses a decimal value, generated by a hexadecimal value. Either use 0x12345678 or tonumber ( "0x12345678" ). See [http://projectcerbera.com/gta/sa/tutorials/handling projectcerbera] for possible values.
|-
| scope="row" style="background:#cfcfcf;"|'''headLight'''
| style="background:#efefef;"|String
| style="background:#efefef;"|N/A
| style="background:#efefef;"|N/A
| style="background:#efefef;"|Get works, set is disabled. Available values: 'long', 'small', 'big', 'tall'.
|-
| scope="row" style="background:#cfcfcf;"|'''tailLight'''
| style="background:#efefef;"|String
| style="background:#efefef;"|N/A
| style="background:#efefef;"|N/A
| style="background:#efefef;"|Get works, set is disabled. Available values: 'long', 'small', 'big', 'tall'.
|-
| scope="row" style="background:#cfcfcf;"|'''animGroup'''
| style="background:#efefef;"|Integer
| style="background:#efefef;"|??
| style="background:#efefef;"|??
| style="background:#efefef;"|Get works, set is disabled due to people not knowing this property was vehicle-based and caused crashes.
|}

User:MX Master

2012-02-27T05:45:20Z

MX Master: updated

Russian '''MTA:SA''' fan and scripter;<br />
Web master;<br />
<br />

'''MX_Master''''s contacts:<br />
----
:'''ICQ''': 701920<br />
:'''WEB''': [http://www.multi-theft-auto.ru/ MX_Master's MTA page]
:'''WEB''': [http://code.google.com/p/multi-theft-auto-ru/ MX_Master's MTA GoogleCode project]
:'''WEB''': [http://forum.mtasa.com/viewforum.php?f=123 Russian sub-forum of forum.mtasa.com]
:'''Google Name''': mx.master.kz
:

Something useful:<br />
----
:[http://forum.mtasa.com/viewtopic.php?f=13&t=29363 MTASA wiki site as single CHM file by MX_Master]

SetOcclusionsEnabled

2012-02-27T05:35:06Z

MX Master: removed category "needs example"

__NOTOC__
{{Server client function}}
This function is used to enable or disable occlusions. Occlusions are used by GTA to enhance performance by hiding objects that are (normally) obscured by certain large buildings. However when [[removeWorldModel]] is used they may also have the undesired effect of making parts of the map disappear. Disabling occlusions will fix that.

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

===Required Arguments===
*'''enabled:''' A bool specifying if GTA occlusions should be enabled

===Returns===
Returns ''true'' if the setting was set correctly, ''false'' if invalid arguments were passed.

==Example==
This example shows occlusions being disabled after the whole map has been cleared:
<syntaxhighlight lang="lua">
-- Remove all world models
for i=700,20000 do
removeWorldModel(i,10000,0,0,0)
end
-- Turn off occlusions
setOcclusionsEnabled( false )
</syntaxhighlight>

==Requirements==
{{Requirements|1.3|1.3|}}

==See Also==
{{World functions}}

GetOcclusionsEnabled

2012-02-27T05:33:01Z

MX Master: new page

__NOTOC__
{{Server client function}}
This function is used to get "occlusions enabled" state.

'''Note:''' Occlusions are used by GTA to enhance performance by hiding objects that are (normally) obscured by certain large buildings. However when [[removeWorldModel]] is used they may also have the undesired effect of making parts of the map disappear. Disabling occlusions will fix that.

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

===Returns===
Returns ''true'' if occlusions are enabled, or ''false'' otherwise.

==Example==
This example shows how to disable occlusions after the whole map has been cleared:
<syntaxhighlight lang="lua">
-- Remove all world models
for i=700,20000 do
removeWorldModel(i,10000,0,0,0)
end

-- Turn off occlusions with simple check
if getOcclusionsEnabled() then
setOcclusionsEnabled( false )
end
</syntaxhighlight>

==Requirements==
{{Requirements|1.3|1.3|}}

==See Also==
{{World functions}}

GuiScrollPaneGetHorizontalScrollPosition

2012-02-27T05:16:57Z

MX Master: new page

{{client function}}
This function is used to get the position of a horizontal scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
float guiScrollPaneGetHorizontalScrollPosition ( element horizontalScrollPane )
</syntaxhighlight>

===Required Arguments===
*'''horizontalScrollPane''': The scroll pane you want to know the position of

===Returns===
Returns a [[float]] ranging between 0 and 100, or '''false''' otherwise.

==Example==
This example gets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- get the position
local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiScrollPaneGetVerticalScrollPosition

2012-02-27T05:14:58Z

MX Master: new page

{{client function}}
This function is used to get the position of a vertical scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
float guiScrollPaneGetVerticalScrollPosition ( element verticalScrollPane )
</syntaxhighlight>

===Required Arguments===
*'''verticalScrollPane''': The scroll pane you want to know the position of

===Returns===
Returns a [[float]] ranging between 0 and 100, or '''false''' otherwise.

==Example==
This example gets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- get the position
local position = guiScrollPaneGetVerticalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiScrollPaneSetVerticalScrollPosition

2012-02-27T05:03:42Z

MX Master: new page

{{client function}}
This function is used to set the position of a vertical scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
bool guiScrollPaneSetVerticalScrollPosition ( element verticalScrollPane, float position )
</syntaxhighlight>

===Required Arguments===
*'''verticalScrollPane''': The scroll pane you want to change the position of
*'''position''': a float ranging from 0 - 100

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

==Example==
This example sets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- set the position
guiScrollPaneSetVerticalScrollPosition( myScrollPane, 33.3 ) -- 1/3 from the upside
-- get the position
local position = guiScrollPaneGetVerticalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiScrollPaneSetHorizontalScrollPosition

2012-02-27T05:03:29Z

MX Master: new page

{{client function}}
This function is used to set the position of a horizontal scroll pane as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
bool guiScrollPaneSetHorizontalScrollPosition ( element horizontalScrollPane, float position )
</syntaxhighlight>

===Required Arguments===
*'''horizontalScrollPane''': The scroll pane you want to change the position of
*'''position''': a float ranging from 0 - 100

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

==Example==
This example sets the position of a scroll pane called "myScrollPane" created with [[guiCreateScrollPane]], and outputs it to the chatbox.
<syntaxhighlight lang="lua">
if ( myScrollPane ) then -- if the scroll pane exist then
-- set the position
guiScrollPaneSetHorizontalScrollPosition( myScrollPane, 100 ) -- right end
-- get the position
local position = guiScrollPaneGetHorizontalScrollPosition( myScrollPane )
-- output to the chatbox
outputChatBox ( "Current position of scroll pane:" .. tostring(position) .. "%" )
else -- if the scroll pane was not found
outputChatBox ("scroll pane not found!")
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

Template:Client vehicle functions

2012-01-15T06:02:35Z

MX Master: removed "getModelHandling"

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleController]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleName]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleCurrentGear]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleRotation]]
*[[getVehicleSirensOn]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleWheelStates]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleHandling]]
*[[getOriginalHandling]]
*[[isVehicleDamageProof]]
*[[isVehicleFrozen]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleOnGround]]
*[[removeVehicleUpgrade]]
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFrozen]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehicleRotation]]
*[[setVehicleSirensOn]]
*[[setVehicleTurretPosition]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleTurnVelocity]]
*[[setVehicleWheelStates]]
*[[getHelicopterRotorSpeed]]
*[[getTrainDirection]]
*[[getTrainSpeed]]
*[[getVehicleGravity]]
*[[getVehicleHeadLightColor]]
*[[getVehicleModelFromName]]
*[[getVehicleNameFromModel]]
*[[getVehicleType]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleTaxiLightOn]]
*[[setHelicopterRotorSpeed]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainSpeed]]
*[[setVehicleGravity]]
*[[setVehicleHeadLightColor]]
*[[setVehicleTaxiLightOn]]
{{New items|3.0120|1.2|
*[[getVehicleVariant]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

GetModelHandling

2012-01-15T06:01:16Z

MX Master: type "shared" -> "only server-side"

{{Server function}}
__NOTOC__
This function returns a table containing the handling data of the specified vehicle model.

Note: the data returned may not reflect the actual handling of a particular vehicle, since this may be overriden by the [[setVehicleHandling]] function.

==Syntax==
<syntaxhighlight lang="lua">
table getModelHandling ( int modelId )
</syntaxhighlight>

===Required Arguments===
*'''modelId:''' The vehicle model you wish to get the handling data of.

===Returns===
Returns a ''table'' containing all the handling data, ''false'' if an invalid vehicle model is specified. Here is a list of valid table properties and what they return:
{{Handling Properties}}

==See other vehicle functions==
{{Vehicle functions}}

GetModelHandling

2012-01-13T17:45:51Z

MX Master: typo

{{Needs_Checking|Actually this function exists only server-side.}}
{{Server client function}}
__NOTOC__
This function returns a table containing the handling data of the specified vehicle model.

Note: the data returned may not reflect the actual handling of a particular vehicle, since this may be overriden by the [[setVehicleHandling]] function.

==Syntax==
<syntaxhighlight lang="lua">
table getModelHandling ( int modelId )
</syntaxhighlight>

===Required Arguments===
*'''modelId:''' The vehicle model you wish to get the handling data of.

===Returns===
Returns a ''table'' containing all the handling data, ''false'' if an invalid vehicle model is specified. Here is a list of valid table properties and what they return:
{{Handling Properties}}

==See other vehicle functions==
{{Vehicle functions}}

GetModelHandling

2012-01-13T17:45:07Z

MX Master: added {{Needs_Checking|...}}

{{Needs_Checking|Actually this function exist only server-side.}}
{{Server client function}}
__NOTOC__
This function returns a table containing the handling data of the specified vehicle model.

Note: the data returned may not reflect the actual handling of a particular vehicle, since this may be overriden by the [[setVehicleHandling]] function.

==Syntax==
<syntaxhighlight lang="lua">
table getModelHandling ( int modelId )
</syntaxhighlight>

===Required Arguments===
*'''modelId:''' The vehicle model you wish to get the handling data of.

===Returns===
Returns a ''table'' containing all the handling data, ''false'' if an invalid vehicle model is specified. Here is a list of valid table properties and what they return:
{{Handling Properties}}

==See other vehicle functions==
{{Vehicle functions}}

XmlNodeGetAttribute

2011-11-21T17:10:39Z

MX Master: fixed example

__NOTOC__
{{Server client function}}
This function is used to return an attribute of a node in a configuration file.

==Syntax==
<syntaxhighlight lang="lua">
string xmlNodeGetAttribute ( xmlnode node, string name )
</syntaxhighlight>

===Required Arguments===
*'''node:''' The node from which you wish to return the attribute
*'''name:''' The name of the attribute.

===Returns===
Returns the attribute in string form or ''false'', if the attribute is not defined.

==Example==
Suppose we have a gametype where only one type of car is used, and this type should not depend on the map but rather be set in an external configuration file and be used in all maps. Here's an example where the configuration file is an XML document:

settings.xml
<syntaxhighlight lang="xml">
<car model="528" posX="123.4" posY="456.7" posZ="12.3" rot="90.0" />
</syntaxhighlight>

Lua code
<syntaxhighlight lang="lua">
local xml = getResourceConfig("settings.xml") -- load XML file and get its root element
local carmodel = xmlNodeGetAttribute(xml, "model") -- get attribute of root element
local carX = xmlNodeGetAttribute(xml, "posX")
local carY = xmlNodeGetAttribute(xml, "posY")
local carZ = xmlNodeGetAttribute(xml, "posZ")
local carA = xmlNodeGetAttribute(xml, "rot")
createVehicle(carmodel, tonumber(carX), tonumber(carY), tonumber(carZ), 0.0, 0.0, tonumber(carA))
</syntaxhighlight>

==See Also==
{{XML_functions}}

OnPlayerVoiceStart

2011-11-19T18:33:06Z

MX Master:

{{Server event}}
__NOTOC__
<div style="border: 1px dotted blue; background: #00CC66;padding:4px;margin-bottom:2px;">'''Note''': This event should only be used as a low-level function for advanced users. For typical Voice scripting, please see the [[Resource:Voice|Voice Resource]]</div>
This event is triggered when a player starts talking through voice chat.

==Parameters==
No parameters.

==Source==
The [[event system#Event source|source]] of this event is the player [[element]] that just started talking through voice chat.

==Cancel effect==
If this event is canceled the player will not broadcast his voice chat to anyone in the server.

==Example==
This example shows how to forbid use voice for not logged in players
<syntaxhighlight lang="lua">
addEventHandler( 'onPlayerVoiceStart', root,
function()
-- if player is not logged in
-- do not broadcast his voice to other players
if isGuestAccount( getPlayerAccount(source) ) then
cancelEvent()
end
end
)
</syntaxhighlight>

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

OnPlayerVoiceStart

2011-11-19T18:28:38Z

MX Master: added example

IsVoiceEnabled

2011-11-19T18:24:10Z

MX Master: removed `section` tag around example

{{Server function}}
__NOTOC__
This function allows you to make the server reveal whether or not voice is currently enabled.

==Syntax==

<syntaxhighlight lang="lua">
bool isVoiceEnabled ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the voice is enabled on the server, ''false'' otherwise.

==Example==
This example shows how to forbid use voice for muted (in chat) players
<syntaxhighlight lang="lua">
-- only if voice enabled
if isVoiceEnabled() then
-- adding handler for voice start event
addEventHandler( 'onPlayerVoiceStart', root,
function()
-- if player is muted in chat
-- do not broadcast his voice to other players
if isPlayerMuted(source) then cancelEvent() end
end
)
end
</syntaxhighlight>

==See Also==
{{Player_functions}}

IsVoiceEnabled

2011-11-19T18:19:33Z

MX Master: + description to example

{{Server function}}
__NOTOC__
This function allows you to make the server reveal whether or not voice is currently enabled.

==Syntax==

<syntaxhighlight lang="lua">
bool isVoiceEnabled ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the voice is enabled on the server, ''false'' otherwise.

==Example==
This example shows how to forbid use voice for muted (in chat) players
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- only if voice enabled
if isVoiceEnabled() then
-- adding handler for voice start event
addEventHandler( 'onPlayerVoiceStart', root,
function()
-- if player is muted in chat
-- do not broadcast his voice to other players
if isPlayerMuted(source) then cancelEvent() end
end
)
end
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

IsVoiceEnabled

2011-11-19T18:13:19Z

MX Master: added example

{{Server function}}
__NOTOC__
This function allows you to make the server reveal whether or not voice is currently enabled.

==Syntax==

<syntaxhighlight lang="lua">
bool isVoiceEnabled ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the voice is enabled on the server, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- only if voice enabled
if isVoiceEnabled() then
-- adding handler for voice start event
addEventHandler( 'onPlayerVoiceStart', root,
function()
-- if player is muted in chat
-- do not broadcast his voice to other players
if isPlayerMuted(source) then cancelEvent() end
end
)
end
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

GetResourceMapRootElement

2011-09-05T11:16:10Z

MX Master: example fix

__NOTOC__
{{Server function}}
This function retrieves the root element of a certain [[map]] in a specified [[resource]].

==Syntax==
<syntaxhighlight lang="lua">
element getResourceMapRootElement ( resource theResource, string mapName )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource where the map is located
*'''mapName:''' name of the maps which root element we want to retrieve, file extension is required

===Returns===
Returns an the resource's map root [[element]] if the map exists and resource specified was valid and active (currently running), ''false'' otherwise.

==Example==
This example shows how to get all elements of specific type only from one map.
<syntaxhighlight lang="lua">
-- We have 2 map files in our meta.xml: island_1.map, island_2.map.
-- These maps contains objects, vehicles, pickups, etc.
-- After resource start we must found all vehicles only from island_1.map and lock them.

-- `resourceRoot` is predefined script variable containing current resource root pointer
addEventHandler( 'onResourceStart', resourceRoot,
function()
-- `resource` is predefined script variable containing current resource pointer
local island_1_mapRoot = getResourceMapRootElement( resource, 'island_1.map' )
local island_1_vehicles = getElementsByType( 'vehicle', island_1_mapRoot )

for vehicle in ipairs(island_1_vehicles) do
setVehicleLocked( vehicle, true )
end
end
)
</syntaxhighlight>

==See Also==
{{Resource_functions}}
[[Category:Needs_Example]]

GetResourceDynamicElementRoot

2011-09-05T11:15:10Z

MX Master: added example

__NOTOC__
{{Server client function}}
This function retrieves the ''dynamic element root'' of a specified [[resource]]. The ''dynamic element root'' is the parent of elements that are created by scripts (e.g. with [[createObject]]) unless they specify a different parent.

==Syntax==
<syntaxhighlight lang="lua">
element getResourceDynamicElementRoot ( resource theResource )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource of which dynamic element root we want.

===Returns===
Returns an [[element]] of the resource's dynamic element root if the resource specified was valid and active (currently running), ''false'' otherwise.

==Example==

This example shows how to get all elements by specific type, created only by resource scripts (not maps).
<syntaxhighlight lang="lua">
-- We have some map files with many objects in our meta.xml.
-- And we have some objects, created by some resource scripts.

-- createObject(...) -- 1
-- createObject(...) -- 2
-- ...
-- createObject(...) -- 20

-- After resource start we must found all objects, created only
-- by current resource scripts (not maps) and make them invisible.

-- `resourceRoot` is predefined script variable containing current resource root pointer
addEventHandler( 'onResourceStart', resourceRoot,
function()
-- `resource` is predefined script variable containing current resource pointer
local thisResourceDynamicRoot = getResourceDynamicElementRoot(resource)
local onlyScriptObjects = getElementsByType( 'object', thisResourceDynamicRoot )

for scriptObject in ipairs(onlyScriptObjects) do
setElementAlpha( scriptObject, 0 )
end
end
)
</syntaxhighlight>

==See Also==
{{Resource_functions}}
[[Category:Needs_Example]]

GetResourceMapRootElement

2011-09-05T10:50:27Z

MX Master: added example

__NOTOC__
{{Server function}}
This function retrieves the root element of a certain [[map]] in a specified [[resource]].

==Syntax==
<syntaxhighlight lang="lua">
element getResourceMapRootElement ( resource theResource, string mapName )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource where the map is located
*'''mapName:''' name of the maps which root element we want to retrieve, file extension is required

===Returns===
Returns an the resource's map root [[element]] if the map exists and resource specified was valid and active (currently running), ''false'' otherwise.

==Example==
This example shows how to get all elements of specific type only from one map.
<syntaxhighlight lang="lua">
-- We have 2 map files in our meta.xml: island_1.map, island_2.map.
-- These maps contains objects, vehicles, pickups, etc.
-- After resource start we must found all vehicles only from island_1.map and lock them.

addEventHandler( 'onResourceStart', resourceRoot,
function()
local island_1_mapRoot = getResourceMapRootElement( resource, 'island_1.map' )
local island_1_vehicles = getElementsByType( 'vehicle', island_1_mapRoot )

for vehicle in ipairs(island_1_vehicles) do
setVehicleLocked( vehicle, true )
end
end
)
</syntaxhighlight>

==See Also==
{{Resource_functions}}
[[Category:Needs_Example]]

Talk:GetPlayerCommunityID

2011-09-04T05:34:49Z

MX Master: Created page with "'''Is deprecated function or we can add normal page for it?'''"

'''Is deprecated function or we can add normal page for it?'''

SetMaxPlayers

2011-09-04T05:31:57Z

MX Master: "note" word became bold

__NOTOC__
{{Server function}}
This function set the maximum number of player slots on the server.

'''Note''': the maximum this function can set is what is defined in mtaserver.conf

==Syntax==
<syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight>

===Required Arguments===

*'''slots:''' Maximum number of player slots on the server.

===Returns===

Returns ''true'' if number of player slots was successfully changed, ''false'' or ''nil'' otherwise.

==Example==
This example set server slots count to half value from current value.
<syntaxhighlight lang="lua">
local curMaxPlayers = getMaxPlayers()
local newMaxPlayers = math.ceil( curMaxPlayers / 2 )

setMaxPlayers( newMaxPlayers )
</syntaxhighlight>

==See Also==
{{Server functions}}

SetMaxPlayers

2011-09-04T05:29:02Z

MX Master: new stupid example (:

__NOTOC__
{{Server function}}
This function set the maximum number of player slots on the server. Note: the maximum this function can set is what is defined in mtaserver.conf

==Syntax==
<syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight>

===Required Arguments===

*'''slots:''' Maximum number of player slots on the server.

===Returns===

Returns ''true'' if number of player slots was successfully changed, ''false'' or ''nil'' otherwise.

==Example==
This example set server slots count to half value from current value.
<syntaxhighlight lang="lua">
local curMaxPlayers = getMaxPlayers()
local newMaxPlayers = math.ceil( curMaxPlayers / 2 )

setMaxPlayers( newMaxPlayers )
</syntaxhighlight>

==See Also==
{{Server functions}}

SetMaxPlayers

2011-09-03T19:07:57Z

MX Master: example fix 2

__NOTOC__
{{Server function}}
This function set the maximum number of player slots on the server.

==Syntax==
<syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight>

===Required Arguments===

*'''slots:''' Maximum number of player slots on the server.

===Returns===

Returns ''true'' if number of player slots was successfully changed, ''false'' or ''nil'' otherwise.

==Example==
This example increases server slots count if server is full.
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerJoin", root,
function()
local nowPlayers = getPlayerCount()
local maxPlayers = getMaxPlayers()

if nowPlayers and maxPlayers and nowPlayers >= maxPlayers then
setMaxPlayers( maxPlayers + 1 )
end
end
)</syntaxhighlight>

==See Also==
{{Server functions}}

SetMaxPlayers

2011-09-03T18:41:16Z

MX Master: example fix

__NOTOC__
{{Server function}}
This function set the maximum number of player slots on the server.

==Syntax==
<syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight>

===Required Arguments===

*'''slots:''' Maximum number of player slots on the server.

===Returns===

Returns ''true'' if number of player slots was successfully changed, ''false'' or ''nil'' otherwise.

==Example==
This example increases server slots count if server is full.
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerConnect", root,
function()
local nowPlayers = getPlayerCount()
local maxPlayers = getMaxPlayers()

if nowPlayers and maxPlayers and nowPlayers >= maxPlayers then
setMaxPlayers( maxPlayers + 1 )
end
end
)</syntaxhighlight>

==See Also==
{{Server functions}}

SetMaxPlayers

2011-09-03T18:26:20Z

MX Master: Created page with "__NOTOC__ {{Server function}} This function set the maximum number of player slots on the server. ==Syntax== <syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight> ===Required Argu..."

__NOTOC__
{{Server function}}
This function set the maximum number of player slots on the server.

==Syntax==
<syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight>

===Required Arguments===

*'''slots:''' Maximum number of player slots on the server.

===Returns===

Returns ''true'' if number of player slots was successfully changed, ''false'' or ''nil'' otherwise.

==Example==
This example increases server slots count if server is full.
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerConnect", root,
function()
local nowPlayers = getElementsByType('player')
local maxPlayers = getMaxPlayers()

if nowPlayers and maxPlayers and #nowPlayers >= maxPlayers then
setMaxPlayers( maxPlayers + 1 )
end
end
)</syntaxhighlight>

==See Also==
{{Server functions}}

OnClientMinimize

2011-08-24T02:08:28Z

MX Master: example's typo fix

[[Category:Incomplete Event]]
{{Client event}}
__NOTOC__
This event is triggered when the local player minimizes the game screen.

==Parameters==
''None''

==Example==
This example kills any player who minimizes the game.
<syntaxhighlight lang="lua">
function handleMinimize()
setElementHealth( localPlayer, 0 )
end
addEventHandler( "onClientMinimize", root, handleMinimize )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPlayerWeaponSwitch

2011-08-08T18:22:00Z

MX Master: getPlayerWeapon -> getPedWeapon

__NOTOC__
{{Client event}}
This event is triggered whenever a player's equipped weapon '''slot''' changes. This means giveWeapon and takeWeapon will trigger this function if the equipped slot is forced to change.

==Parameters==
<syntaxhighlight lang="lua">
int previousWeaponSlot, int currentWeaponSlot
</syntaxhighlight>

*'''previousWeaponSlot''': An integer representing the previous weapon slot the player had before he switched.
*'''currentWeaponSlot''': An integer representing the new weapon slot the player has.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who changed his weapon

==Example==
This example disables the use of aiming for the minigun.
<syntaxhighlight lang="lua">
function disableMinigunOnSwitch ( prevSlot, newSlot )
if getPedWeapon(getLocalPlayer(),newSlot) == 38 then --if the switched weapon is the minigun
toggleControl ( "aim_weapon", false ) --disable the aim button
else --if it isnt the minigun
toggleControl ( "aim_weapon", true ) --renable the aim button
end
end
addEventHandler ( "onClientPlayerWeaponSwitch", getRootElement(), disableMinigunOnSwitch )
</syntaxhighlight>

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

GetVehicleHandling

2011-05-21T15:42:13Z

MX Master: Removed `Note`. Now handling functions are part of nightly builds.

{{Server client function}}
__NOTOC__
This function returns a table of the current vehicle handling data.

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleHandling ( element theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to get the handling data of.

===Returns===
Returns a ''table'' containing all the handling data, ''false'' otherwise. Here a list of valid table properties and what they return:
{{Handling Properties}}

==Example==
<section name="Server & Client" class="both" show="true">
This example creates a new function called getVehicleHandlingProperty, which simulates the previous syntax of this function.
<syntaxhighlight lang="lua">
function getVehicleHandlingProperty ( element, property )
if isElement ( element ) and getElementType ( element ) == "vehicle" and type ( property ) == "string" then -- Make sure there's a valid vehicle and a property string
local handlingTable = getVehicleHandling ( element ) -- Get the handling as table and save as handlingTable
local value = handlingTable[property] -- Get the value from the table

if value then -- If there's a value (valid property)
return value -- Return it
end
end

return false -- Not an element, not a vehicle or no valid property string. Return failure
end
</syntaxhighlight>
</section>

==See other vehicle functions==
{{Vehicle functions}}

SetVehicleHandling

2011-05-21T15:41:45Z

MX Master: Removed `Note`. Now handling functions are part of nightly builds.

{{Server function}}
__NOTOC__
This function is used to change the handling data of a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleHandling ( element theVehicle, string property, var value )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to set the handling of.
*'''property:''' The property you wish to set the handling of the vehicle to.
{{Handling Properties}}
*'''value:''' The value of the property you wish to set the handling of the vehicle to.

===Returns===
Returns ''true'' if the handling was set successfully, ''false'' otherwise. See below a list of valid propertys and their required values:

==Example==
<syntaxhighlight lang="lua">
function massChange ( me, command, mass )
mass = tonumber ( mass ) -- Convert mass to a number
local veh = getPedOccupiedVehicle ( me ) -- Get the player's vehicle

if mass and veh then -- If valid mass and in a vehicle
local success = setVehicleHandling ( veh, "mass", mass ) -- Set the vehicle's mass, and check if successful

if success then -- If successful
outputChatBox ( "Your vehicle's mass has been changed to: "..mass.." kg", me, 0, 255, 0 ) -- Notify the player of success
else -- Too bad failure is still an option
outputChatBox ( "Setting mass failed. It's probably above or below allowed limits", me, 255, 0, 0 ) -- Notify the player of failure, and give a possible reason
end
elseif not veh then -- If not in a vehicle
outputChatBox ( "You're not in a vehicle", me, 255, 0, 0 ) -- Tell the player; He / she obviously doesn't know
elseif not mass then -- If not a valid mass
outputChatBox ( "Syntax: /changemass [mass]", me, 255, 0, 0 ) -- Tell the player the proper syntax
end
end
addCommandHandler ( "changemass", massChange )
</syntaxhighlight>

==See other vehicle functions==
{{Vehicle functions}}

Client Scripting Functions

2011-04-28T04:18:34Z

MX Master: added `Client file functions`

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

==Audio functions==
{{Client_audio_functions}}

==Blip functions==
{{Client_blip_functions}}

==Camera functions==
{{Client_camera_functions}}

==Clothes and body functions==
{{Client_Clothes and body functions}}

==Collision shape functions==
{{Client_collision_shape_functions}}

==Cursor functions==
{{Client_cursor_functions}}

==Drawing functions==
{{Drawing_functions}}

==Effects functions==
{{Client_Effects_functions}}

==Element functions==
{{Client_element_functions}}

==Engine functions==
{{Engine_functions}}

==Event functions==
{{Client_event_functions}}

==Explosion functions==
{{Client_explosion_functions}}

==File functions==
{{Client file functions}}

==Fire functions==
{{Client fire functions}}

==GUI functions==
{{GUI_functions}}

==Input functions==
{{Client_input_functions}}

==Marker functions==
{{Client_marker_functions}}

==Object functions==
{{Client_object_functions}}

==Output functions==
{{Client_output_functions}}

==Ped functions==
{{Client_ped_functions}}

==Pickup functions==
{{Client_pickup_functions}}

==Player functions==
{{Client_player_functions}}

==Projectile functions==
{{Client_projectile_functions}}

==Radar-area functions==
{{Client_radar-area_functions}}

==Resource functions==
{{Client_resource_functions}}

==Serial functions==
{{Client_serial_functions}}

==Team functions==
{{Client_team_functions}}

==Utility functions==
{{Client_utility_functions}}

==Vehicle functions==
{{Client_vehicle_functions}}

==Water functions==
{{Client_water_functions}}

==Weapon functions==
{{Client_weapon_functions}}

==World functions==
{{Client_world_functions}}

==XML functions==
{{Client XML functions}}

[[pl:Funkcje po stronie klienta]]
[[it:Funzioni Client-side]]
[[ru:Client Scripting Functions]]

Template:Client file functions

2011-04-28T04:15:53Z

MX Master: new template for client-side file functions list

{{New feature|3.0110|1.1|
*[[fileClose]]
*[[fileCreate]]
*[[fileDelete]]
*[[fileExists]]
*[[fileFlush]]
*[[fileGetPos]]
*[[fileGetSize]]
*[[fileIsEOF]]
*[[fileOpen]]
*[[fileRead]]
*[[fileRename]]
*[[fileSetPos]]
*[[fileWrite]]
}}

Talk:Client Scripting Functions

2011-04-27T17:27:44Z

MX Master:

'''getPlayerUserName''' (http://development.mtasa.com/index.php?title=GetPlayerUserName) is listed in the Client Functions, when it is a Server Function.
*I've removed it.[[User:EAi|eAi]] 08:09, 30 March 2008 (CDT)

File functions already exists for client.. may be add File_Functions template to this page?

User:MX Master

2011-04-27T02:54:33Z

MX Master: add contacts and info about user MX_Master

'''MTA:SA''' fan;<br />
'''MTA:SA''' / '''IV:MP''' / '''SA:MP''' scripter;<br />
Web master;<br />
<br />

'''MX_Master''''s contacts:<br />
----
:'''ICQ''': 701920<br />
:'''WEB''': [http://www.mxgames.kz/ mxgames.kz], MX_Master
:'''Google''': mx.master.kz

Template:File functions

2011-04-26T13:43:05Z

MX Master: Added `fileRename` link. List sorted.

*[[fileClose]]
*[[fileCreate]]
{{New feature|3|1.0|
*[[fileDelete]]
}}
{{New feature|3.0004|1.0.4|
*[[fileExists]]
}}
*[[fileFlush]]
*[[fileGetPos]]
*[[fileGetSize]]
*[[fileIsEOF]]
*[[fileOpen]]
*[[fileRead]]
{{New feature|3.0110|1.1|
*[[fileRename]]
}}
*[[fileSetPos]]
*[[fileWrite]]

FileRename

2011-04-26T13:28:44Z

MX Master: new page for new fileRename function

__NOTOC__
{{Server function}}

Renames the specified file.

'''Note:''' Also with this function you can move specified file to a new location, new folder or even to another resource's folder. But for this action executing resource must have 'ModifyOtherObjects' ACL right set to ''true''.

==Syntax==
<syntaxhighlight lang="lua">
bool fileRename ( string filePath, string newFilePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format.

===Returns===
If successful, returns ''true''. Otherwise returns ''false''.

==Example==
This example renames the file ''test1.txt'' that is in the root of the current resource to ''test2.txt''.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "test2.txt" ) then
outputConsole("File `test1.txt` successfully renamed to `test2.txt`")
else
outputConsole("Unable to rename `test1.txt`")
end</syntaxhighlight>

This example moves the file ''test1.txt'' that is in the root of the current resource to ''myFolder'' folder. If this folder is not exists, it will be created before moving the file ''test1.txt''.
<syntaxhighlight lang="lua">
if fileRename( "test1.txt", "myFolder/test1.txt" ) then
outputConsole("File `test1.txt` successfuly moved to `myFolder` folder")
else
outputConsole("Unable to move `test1.txt`")
end</syntaxhighlight>

==See Also==
{{File functions}}