Multi Theft Auto: Wiki - User contributions [en]

SetPlayerHudComponentVisible

2023-02-21T23:53:50Z

Lopez: remove redundant note about showPlayerHudComponent

__NOTOC__
{{Server client function}}
This function will show or hide a part of the player's HUD.

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( player thePlayer, string component, bool show )
</syntaxhighlight>
{{OOP||[[player]]:setHudComponentVisible||}}
===Required Arguments===
*'''thePlayer:''' The player element for which you wish to show/hide a HUD component
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''all:''' All of the following at the same time
:*'''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|
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''crosshair:''' The weapon crosshair and sniper scope
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''all:''' All of the following at the same time
:*'''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/item|3.0110|1.1||
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''crosshair:''' The weapon crosshair and sniper scope
}}
*'''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.

==Requirements==
{{Requirements|1.3.2|1.3.2}}

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
-- Hide some of the hud components when a player joins the server
addEventHandler ( "onPlayerJoin", root,
function ()
setPlayerHudComponentVisible ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
setPlayerHudComponentVisible ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example lets players hide or bring up their bottom-left radar with a command
<syntaxhighlight lang="lua">
function toggleRadar()
state = not state
setPlayerHudComponentVisible("radar", state)
end
addCommandHandler( "toggleradar", toggleRadar)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example hides the weapon icon, weapon ammo, health bar, clock, money, breath bar, armor bar & wanted level stars displays for players when they join.
<syntaxhighlight lang="lua">
-- Hide the hud when the resource is started
local components = { "weapon", "ammo", "health", "clock", "money", "breath", "armour", "wanted" }

addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
for _, component in ipairs( components ) do
setPlayerHudComponentVisible( component, false )
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

CreateObject

2022-10-31T11:32:52Z

Lopez: remove false note about broken object sync

__NOTOC__
{{Server client function}}
Creates an [[object]] [[element]] at a given position and rotation.
{{Note|Dynamic objects do not automatically have physics applied to them. Use [[setElementVelocity]](object, 0, 0, 0) to fix this.}}

==Syntax==
<syntaxhighlight lang="lua">object createObject ( int modelId, float x, float y, float z, [ float rx, float ry, float rz, bool isLowLOD = false ] )</syntaxhighlight>
{{OOP||[[Object]]||}}

===Required Arguments===
*'''modelId:''' A whole integer specifying the GTA:SA object model ID.
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rx:''' A floating point number representing the rotation about the X axis in degrees.
*'''ry:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rz:''' A floating point number representing the rotation about the Z axis in degrees.
{{New items|3.0120|1.2|
*'''isLowLOD:''' A bool value specifying if the object will be low LOD. A low LOD object has no collision and a longer draw distance.
}}

===Returns===
* Returns the [[object]] element if the creation was successful, ''false'' otherwise.

==Example==
<section name="Server-only Example 1" class="server" show="true">
This example creates an object when the resource starts:
<syntaxhighlight lang="lua">
function loadMapObjects()
-- create an object at a specified position with a specified rotation
createObject(1337, 5540.6654, 1020.55122, 1240.545, 90, 0, 0)
end
addEventHandler("onResourceStart", resourceRoot, loadMapObjects)
</syntaxhighlight>
</section>

<section name="Server-only Example 2" class="server" show="true">
This example creates an object near the player who write /createObject in the chat:
<syntaxhighlight lang="lua">
-- this function is called whenever someone types 'createObject' in the console:
function createObjectCommand(thePlayer, commandName)
if (thePlayer) then
local x, y, z = getElementPosition(thePlayer)
-- create a object next to the player:
local theObject = createObject(980, x + 2, y + 2, z, 0, 0, 0)
if (theObject) then -- check if the object was created successfully
outputChatBox("Object created successfully.", thePlayer)
else
outputChatBox("Failed to create the object.", thePlayer)
end
end
end
addCommandHandler("createobject", createObjectCommand)
</syntaxhighlight>
</section>

==See Also==
{{Object functions}}

IsCoronaReflectionEnabled

2022-10-18T19:12:16Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function gets visibility of corona reflection.}}
==Syntax==
<syntaxhighlight lang="lua">
bool isCoronaReflectionEnabled ( marker theMarker )
</syntaxhighlight>
{{OOP||[[Marker]]:isCoronaReflectionEnabled||setCoronaReflectionEnabled}}
===Required Arguments===
*'''theMarker:''' marker

===Returns===
* Returns ''false'' is [[setMarkerType|marker type]] is not ''corona''.
* Returns ''true'' if corona reflection is enabled, ''false'' otherwise.

==See Also==
{{client marker functions}}* [[setCoronaReflectionsEnabled]]
* [[getCoronaReflectionsEnabled]]

SetCoronaReflectionEnabled

2022-10-18T19:11:21Z

Lopez: /* See Also */

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function sets visibility of corona reflection.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setCoronaReflectionEnabled ( marker theMarker, bool enabled )
</syntaxhighlight>
{{OOP||[[Marker]]:setCoronaReflectionEnabled||isCoronaReflectionEnabled}}
===Required Arguments===
*'''theMarker:''' the corona marker that you wish set visibility of corona reflection
*'''enabled:''' whenever corona reflection should be visible

===Returns===
Returns ''true'' if [[setMarkerType|marker type]] is ''corona'', ''false'' otherwise.

==Issues==
{{Issues|
{{Issue|2755|Corona reflections do not render on custom placed objects}}
{{Issue|2750|Corona reflections do not render on all roads}}
}}

==See Also==
{{client marker functions}}* [[setCoronaReflectionsEnabled]]
* [[getCoronaReflectionsEnabled]]

SetCoronaReflectionEnabled

2022-10-18T19:10:54Z

Lopez: /* See Also */

File:2.png

2022-10-07T22:05:05Z

Lopez: Lopez uploaded File:2.png

File:1.png

2022-10-07T22:04:44Z

Lopez: Lopez uploaded File:1.png

File:2.png

2022-10-07T22:00:47Z

Lopez: blank

File:1.png

2022-10-07T22:00:34Z

Lopez: blank

GetCoronaReflectionsEnabled

2022-10-07T21:55:17Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function gets visibility of corona reflections.}}

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

===Returns===
One of the following integers will be returned:
* '''0''': corona reflections are disabled
* '''1''': corona reflections are enabled (are visible during rain)
* '''2''': corona reflections are force enabled (are visible even if there is no rain)

==See Also==
{{client world functions}}

GetCoronaReflectionsEnabled

2022-10-07T21:54:39Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function gets visibility of corona reflections.}}

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

===Returns===
One of the following integers will be returned:
* '''0''': corona reflections are disabled
* '''1''': corona reflections are enabled (will be visible during rain)
* '''2''': corona reflections are force enabled (will be visible even if there is no rain)

==See Also==
{{client world functions}}

SetCoronaReflectionsEnabled

2022-10-07T21:54:23Z

Lopez: /* Required Arguments */

{{Client function}}
__NOTOC__
[[File:Corona-reflections.png|500px|thumb|right|Corona reflections.]]
{{Added feature/item|1.5.9|1.5.8|21251|This function sets visibility of corona reflections.}}

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

===Required Arguments===
*'''enabled:'''
** '''0''': disabled
** '''1''': enabled (will be visible during rain)
** '''2''': force enabled (will be visible even if there is no rain)

===Returns===
Returns ''true'' if passed arguments are correct, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- Force enable corona reflections even if there is no rain
setCoronaReflectionsEnabled(2)
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|2755|Corona reflections do not render on custom placed objects}}
{{Issue|2750|Corona reflections do not render on all roads}}
}}

==See Also==
{{client world functions}}

Template:Client world functions

2022-10-07T21:49:54Z

Lopez:

* [[areTrafficLightsLocked]]
* [[createSWATRope]]
* [[getAircraftMaxHeight]]
* [[getAircraftMaxVelocity]]
* [[getBirdsEnabled]]
* [[getCloudsEnabled]]
* [[getCoronaReflectionsEnabled]]
* [[getFarClipDistance]]
* [[getFogDistance]]
* [[getGameSpeed]]
* [[getGarageBoundingBox]]
* [[getGaragePosition]]
* [[getGarageSize]]
* [[getGravity]]
* [[getGroundPosition]]
* [[getHeatHaze]]
* [[getInteriorFurnitureEnabled]]
* [[getInteriorSoundsEnabled]]
* [[getJetpackMaxHeight]]
* [[getMinuteDuration]]
* [[getMoonSize]]
* [[getNearClipDistance]]
* [[getOcclusionsEnabled]]
* [[getPedsLODDistance]]
* [[getPlayerBlurLevel]]
* [[getRainLevel]]
{{Added feature/item|1.5.9|1.5.8|20675|
* [[getRoofPosition]]
}}
* [[getScreenFromWorldPosition]]
* [[getSunColor]]
* [[getSunSize]]
* [[getTime]]
* [[getTrafficLightState]]
* [[getVehiclesLODDistance]]
* [[getWeather]]
* [[getWindVelocity]]
* [[getWorldFromScreenPosition]]
* [[getZoneName]]
* [[isAmbientSoundEnabled]]
* [[isGarageOpen]]
* [[isLineOfSightClear]]
* [[isWorldSoundEnabled]]
* [[isWorldSpecialPropertyEnabled]]
* [[processLineOfSight]]
* [[removeWorldModel]]
* [[resetAmbientSounds]]
* [[resetBlurLevel]]
* [[resetColorFilter]]
* [[resetCoronaReflectionsEnabled]]
* [[resetFarClipDistance]]
* [[resetFogDistance]]
* [[resetHeatHaze]]
* [[resetMoonSize]]
* [[resetNearClipDistance]]
* [[resetPedsLODDistance]]
* [[resetRainLevel]]
* [[resetSkyGradient]]
* [[resetSunColor]]
* [[resetSunSize]]
* [[resetVehiclesLODDistance]]
* [[resetWindVelocity]]
* [[resetWorldSounds]]
* [[restoreAllWorldModels]]
* [[restoreWorldModel]]
* [[setAircraftMaxHeight]]
* [[setAircraftMaxVelocity]]
* [[setAmbientSoundEnabled]]
* [[setBirdsEnabled]]
* [[setCloudsEnabled]]
* [[setColorFilter]]
* [[setCoronaReflectionsEnabled]]
* [[setFarClipDistance]]
* [[setFogDistance]]
* [[setGameSpeed]]
* [[setGarageOpen]]
* [[setGravity]]
* [[setHeatHaze]]
* [[setInteriorFurnitureEnabled]]
* [[setInteriorSoundsEnabled]]
* [[setJetpackMaxHeight]]
* [[setMinuteDuration]]
* [[setMoonSize]]
* [[setNearClipDistance]]
* [[setOcclusionsEnabled]]
* [[setPedsLODDistance]]
* [[setPlayerBlurLevel]]
* [[setRainLevel]]
* [[setSkyGradient]]
* [[setSunColor]]
* [[setSunSize]]
* [[setTime]]
* [[setTrafficLightsLocked]]
* [[setTrafficLightState]]
* [[setVehiclesLODDistance]]
* [[setWeather]]
* [[setWeatherBlended]]
* [[setWindVelocity]]
* [[setWorldSoundEnabled]]
* [[setWorldSpecialPropertyEnabled]]
* [[testLineAgainstWater]]

<noinclude>[[Category:Functions templates]]</noinclude>

Template:Client world functions

2022-10-07T21:49:21Z

Lopez: add resetCoronaRainReflections

* [[areTrafficLightsLocked]]
* [[createSWATRope]]
* [[getAircraftMaxHeight]]
* [[getAircraftMaxVelocity]]
* [[getBirdsEnabled]]
* [[getCloudsEnabled]]
* [[getCoronaReflectionsEnabled]]
* [[getFarClipDistance]]
* [[getFogDistance]]
* [[getGameSpeed]]
* [[getGarageBoundingBox]]
* [[getGaragePosition]]
* [[getGarageSize]]
* [[getGravity]]
* [[getGroundPosition]]
* [[getHeatHaze]]
* [[getInteriorFurnitureEnabled]]
* [[getInteriorSoundsEnabled]]
* [[getJetpackMaxHeight]]
* [[getMinuteDuration]]
* [[getMoonSize]]
* [[getNearClipDistance]]
* [[getOcclusionsEnabled]]
* [[getPedsLODDistance]]
* [[getPlayerBlurLevel]]
* [[getRainLevel]]
{{Added feature/item|1.5.9|1.5.8|20675|
* [[getRoofPosition]]
}}
* [[getScreenFromWorldPosition]]
* [[getSunColor]]
* [[getSunSize]]
* [[getTime]]
* [[getTrafficLightState]]
* [[getVehiclesLODDistance]]
* [[getWeather]]
* [[getWindVelocity]]
* [[getWorldFromScreenPosition]]
* [[getZoneName]]
* [[isAmbientSoundEnabled]]
* [[isGarageOpen]]
* [[isLineOfSightClear]]
* [[isWorldSoundEnabled]]
* [[isWorldSpecialPropertyEnabled]]
* [[processLineOfSight]]
* [[removeWorldModel]]
* [[resetAmbientSounds]]
* [[resetBlurLevel]]
* [[resetColorFilter]]
* [[resetCoronaRainReflections]]
* [[resetFarClipDistance]]
* [[resetFogDistance]]
* [[resetHeatHaze]]
* [[resetMoonSize]]
* [[resetNearClipDistance]]
* [[resetPedsLODDistance]]
* [[resetRainLevel]]
* [[resetSkyGradient]]
* [[resetSunColor]]
* [[resetSunSize]]
* [[resetVehiclesLODDistance]]
* [[resetWindVelocity]]
* [[resetWorldSounds]]
* [[restoreAllWorldModels]]
* [[restoreWorldModel]]
* [[setAircraftMaxHeight]]
* [[setAircraftMaxVelocity]]
* [[setAmbientSoundEnabled]]
* [[setBirdsEnabled]]
* [[setCloudsEnabled]]
* [[setColorFilter]]
* [[setCoronaReflectionsEnabled]]
* [[setFarClipDistance]]
* [[setFogDistance]]
* [[setGameSpeed]]
* [[setGarageOpen]]
* [[setGravity]]
* [[setHeatHaze]]
* [[setInteriorFurnitureEnabled]]
* [[setInteriorSoundsEnabled]]
* [[setJetpackMaxHeight]]
* [[setMinuteDuration]]
* [[setMoonSize]]
* [[setNearClipDistance]]
* [[setOcclusionsEnabled]]
* [[setPedsLODDistance]]
* [[setPlayerBlurLevel]]
* [[setRainLevel]]
* [[setSkyGradient]]
* [[setSunColor]]
* [[setSunSize]]
* [[setTime]]
* [[setTrafficLightsLocked]]
* [[setTrafficLightState]]
* [[setVehiclesLODDistance]]
* [[setWeather]]
* [[setWeatherBlended]]
* [[setWindVelocity]]
* [[setWorldSoundEnabled]]
* [[setWorldSpecialPropertyEnabled]]
* [[testLineAgainstWater]]

<noinclude>[[Category:Functions templates]]</noinclude>

ResetCoronaReflectionsEnabled

2022-10-07T21:48:32Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function resets visibility of corona reflections. Default value depends on client setting. If client has enabled ''corona rain reflections'' in video options, value will be reset to '''1''', otherwise to '''0'''. You can check value of this option using [[dxGetStatus]] (''SettingCoronaReflections'').}}

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

===Returns===
Returns ''true''.

==Issues==
{{Issues|
{{Issue|2755|Corona reflections do not render on custom placed objects}}
{{Issue|2750|Corona reflections do not render on all roads}}
}}

==See Also==
{{client world functions}}

ResetCoronaReflectionsEnabled

2022-10-07T21:47:51Z

Lopez: Created page with "{{Client function}} __NOTOC__ {{Added feature/item|1.5.9|1.5.8|21251|This function resets visibility of corona reflections. Default value depends on client setting. If client has enabled ''corona rain reflections'' in video options, value will be reset to ''true'', otherwise to ''false''. You can check value of this option using dxGetStatus (''SettingCoronaReflections'').}} ==Syntax== <syntaxhighlight lang="lua"> bool resetCoronaReflectionsEnabled ( ) </syntaxhighl..."

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function resets visibility of corona reflections. Default value depends on client setting. If client has enabled ''corona rain reflections'' in video options, value will be reset to ''true'', otherwise to ''false''. You can check value of this option using [[dxGetStatus]] (''SettingCoronaReflections'').}}

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

===Returns===
Returns ''true''.

==Issues==
{{Issues|
{{Issue|2755|Corona reflections do not render on custom placed objects}}
{{Issue|2750|Corona reflections do not render on all roads}}
}}

==See Also==
{{client world functions}}

SetCoronaReflectionsEnabled

2022-10-07T21:44:12Z

Lopez: add img

{{Client function}}
__NOTOC__
[[File:Corona-reflections.png|500px|thumb|right|Corona reflections.]]
{{Added feature/item|1.5.9|1.5.8|21251|This function sets visibility of corona reflections.}}

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

===Required Arguments===
*'''enabled:'''
** '''0''': disabled
** '''1''': enabled
** '''2''': force enabled, even if there is no rain

===Returns===
Returns ''true'' if passed arguments are correct, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- Force enable corona reflections even if there is no rain
setCoronaReflectionsEnabled(2)
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|2755|Corona reflections do not render on custom placed objects}}
{{Issue|2750|Corona reflections do not render on all roads}}
}}

==See Also==
{{client world functions}}

File:Corona-reflections.png

2022-10-07T21:43:07Z

Lopez:

IsElementCollidableWith

2022-10-07T21:32:03Z

Lopez: add Weapon to supported element types

{{Client function}}
__NOTOC__
This function can be used to check whether specified element is collidable with another element.<br>
'''Note:''' You can only use this function with the element types listed below.
*[[Player]]
*[[Ped]]
*[[Vehicle]]
*[[Object]]
{{Added feature/item|1.5.9|1.5.8|21348|
* [[Element/Weapon|Weapon]]
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isElementCollidableWith ( element theElement, element withElement )
</syntaxhighlight>
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[element]]:isCollidableWith||setElementCollidableWith}}}}

===Required Arguments===
*'''theElement:''' The [[element]] which colliding you want to get
*'''withElement:''' The other [[element]] which colliding with the first entity you want to get

===Returns===
Returns ''true'' if the elements collide with eachother, ''false'' otherwise.

==Example==
This example adds the command ''togglecol'' which toggles the collision between the player and ped.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local tPed = {}
addEventHandler( "onClientPlayerSpawn", localPlayer,
function()
local x, y, z = getElementPosition(source)
if isElement(tPed["thePed"]) then
destroyElement(tPed["thePed"])
end
-- Creates a random ped near player
tPed["thePed"] = createPed(math.random(209, 238), x+1, y+1, z)
end
)

function toggleColisionFunc()
if not isElement(tPed["thePed"]) then
return
end
-- Is the local player collidable with the ped?
local isCollidable = isElementCollidableWith( localPlayer, tPed["thePed"] )
-- Toggles the colision with the ped.
setElementCollidableWith( localPlayer, tPed["thePed"], not isCollidable )
end
-- Adds a command handler to enable/disable colisions with the ped
addCommandHandler("togglecol", toggleColisionFunc)
</syntaxhighlight>
</section>

==See Also==
{{Client element functions}}

SetElementCollidableWith

2022-10-07T21:31:33Z

Lopez: add Weapon to supported element types

{{Client function}}
__NOTOC__
This function can be used to set an element to collide with another element. An element with collisions disabled does not interact physically with the other element.<br>
'''Note:''' You can only use this function with the element types listed below.
*[[Player]]
*[[Ped]]
*[[Vehicle]]
*[[Object]]
{{Added feature/item|1.5.9|1.5.8|21348|
* [[Element/Weapon|Weapon]]
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementCollidableWith ( element theElement, element withElement, bool enabled )
</syntaxhighlight>
{{OOP||[[element]]:setCollidableWith||isElementCollidableWith}}

===Required Arguments===
*'''theElement:''' The [[element]] which colliding you want to change
*'''withElement:''' The other [[element]] you wish the first entity to collide with
*'''enabled:''' A boolean to indicate whether elements should be able to collide with eachother (''true'') or not (''false'')

===Returns===
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function ghostmode_on()
local playerVehicle = getPedOccupiedVehicle(localPlayer) -- Get the players vehicle
if(playerVehicle) then -- Check the return value.
for i,v in pairs(getElementsByType("vehicle")) do --LOOP through all vehicles
setElementCollidableWith(v, playerVehicle, false) -- Set the collison off with the other vehicles.
end
outputChatBox("You are now a Ghost")
end
end
addCommandHandler("ghostmode", ghostmode_on) -- Add the /ghostmode Command.
</syntaxhighlight>
</section>

==See Also==
{{Client element functions}}

DxGetStatus

2022-10-07T21:26:56Z

Lopez: add SettingDynamicPedShadows

{{Client function}}
__NOTOC__
This function gets information about various internal datum.

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

===Returns===
Returns a table with the following entries:
*'''TestMode:''' The current dx test mode. See [[dxSetTestMode]].
*'''VideoCardName:''' The name of the graphics card.
*'''VideoCardRAM:''' The installed memory in MB of the graphics card.
*'''VideoCardPSVersion:''' The maximum pixel shader version of the graphics card.
*'''VideoCardMaxAnisotropy:''' The maximum anisotropic filtering available. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
*'''VideoCardNumRenderTargets:''' The maximum number of simultaneous render targets a shader can use.
*'''VideoMemoryFreeForMTA:''' The amount of memory in MB available for MTA to use. '''When this gets to zero, [[guiCreateFont]], [[dxCreateFont]] and [[dxCreateRenderTarget]] will fail.'''
*'''VideoMemoryUsedByFonts:''' The amount of graphic memory in MB used by custom fonts.
*'''VideoMemoryUsedByTextures:''' The amount of graphic memory in MB used by textures.
*'''VideoMemoryUsedByRenderTargets:''' The amount of graphic memory in MB used by render targets.
*'''SettingWindowed:''' The windowed setting. (true/false)
*'''SettingFullScreenStyle:''' Display style when in full screen mode. (0-2 which respectively mean: Standard, Borderless window, Borderless keep res)
*'''SettingFXQuality:''' The FX Quality. (0-3)
*'''SettingDrawDistance:''' The draw distance setting. (0-100)
*'''SettingVolumetricShadows:''' The volumetric shadows setting. (true/false)
*'''SettingStreamingVideoMemoryForGTA:''' The usable graphics memory setting. (64-256)
*'''SettingAnisotropicFiltering:''' The anisotropic filtering setting. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
*'''SettingAntiAliasing:''' The anti-aliasing setting. (0-3 which respectively mean: off, 1x, 2x, 3x)
*'''SettingHeatHaze:''' The heat haze setting. (true/false)
*'''SettingGrassEffect:''' The grass effect setting. (true/false)
*'''Setting32BitColor:''' The color depth of the screen. (false is 16bit, true is 32bit)
*'''SettingHUDMatchAspectRatio:''' The hud match aspect ratio setting. (true/false)
*'''SettingAspectRatio:''' The aspect ratio setting. ("auto", "4:3", "16:10", "16:9")
*'''SettingFOV:''' The FOV setting.
*'''SettingHighDetailVehicles:''' High detail vehicles setting. (true/false)
{{Added feature/item|1.5.9|1.5.8|20508|
*'''SettingHighDetailPeds:''' High detail peds setting. (true/false)
}}
{{Added feature/item|1.5.9|1.5.8|21251|
*'''SettingCoronaReflections:''' Corona rain reflections setting. (true/false)
}}
{{Added feature/item|1.5.9|1.5.8|21348|
*'''SettingDynamicPedShadows:''' Dynamic ped shadows setting. (true/false)
}}
*'''AllowScreenUpload:''' The allows screen uploads setting. (true/false)
*'''DepthBufferFormat:''' The format of the shader readable depth buffer, or 'unknown' if not available.
{{Added feature/item|1.5.9|1.5.8|20901|
*'''TotalPhysicalMemory:''' The amount of total physical memory in MB.
}}
*'''UsingDepthBuffer:''' ''true'' if the depth buffer is used, ''false'' otherwise.
==Example==
<syntaxhighlight lang="lua">
addCommandHandler("getinfo",
function ()
local info = dxGetStatus ()
for k, v in pairs (info) do
outputChatBox (k .. " : " .. tostring (v))
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04715|Added DepthBufferFormat argument}}
{{ChangelogItem|1.3.0-9.04811|Added VideoCardMaxAnisotropy, SettingAnisotropicFiltering, SettingAntiAliasing,<br/> SettingHeatHaze, SettingGrassEffect and Setting32BitColor arguments}}
{{ChangelogItem|1.3.4-9.05731|Added SettingHUDMatchAspectRatio and SettingAspectRatio}}
{{ChangelogItem|1.4.1-9.07181|Added SettingFOV}}
{{ChangelogItem|1.4.1-9.07310|Added VideoCardNumRenderTargets}}
{{ChangelogItem|1.5.2-9.07816|Added UsingDepthBuffer}}
{{ChangelogItem|1.5.3-9.11199|Added SettingHighDetailVehicles}}
{{ChangelogItem|1.5.5-9.11814|Added SettingFullScreenStyle<br/>Fixed SettingWindowed}}
{{ChangelogItem|1.5.8-9.20508|Added SettingHighDetailPeds}}
{{ChangelogItem|1.5.8-9.20901|Added TotalPhysicalMemory}}

==See Also==
{{Drawing_functions}}

[[hu:dxGetStatus]]

DxGetStatus

2022-10-07T21:25:26Z

Lopez: add SettingCoronaReflections

{{Client function}}
__NOTOC__
This function gets information about various internal datum.

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

===Returns===
Returns a table with the following entries:
*'''TestMode:''' The current dx test mode. See [[dxSetTestMode]].
*'''VideoCardName:''' The name of the graphics card.
*'''VideoCardRAM:''' The installed memory in MB of the graphics card.
*'''VideoCardPSVersion:''' The maximum pixel shader version of the graphics card.
*'''VideoCardMaxAnisotropy:''' The maximum anisotropic filtering available. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
*'''VideoCardNumRenderTargets:''' The maximum number of simultaneous render targets a shader can use.
*'''VideoMemoryFreeForMTA:''' The amount of memory in MB available for MTA to use. '''When this gets to zero, [[guiCreateFont]], [[dxCreateFont]] and [[dxCreateRenderTarget]] will fail.'''
*'''VideoMemoryUsedByFonts:''' The amount of graphic memory in MB used by custom fonts.
*'''VideoMemoryUsedByTextures:''' The amount of graphic memory in MB used by textures.
*'''VideoMemoryUsedByRenderTargets:''' The amount of graphic memory in MB used by render targets.
*'''SettingWindowed:''' The windowed setting. (true/false)
*'''SettingFullScreenStyle:''' Display style when in full screen mode. (0-2 which respectively mean: Standard, Borderless window, Borderless keep res)
*'''SettingFXQuality:''' The FX Quality. (0-3)
*'''SettingDrawDistance:''' The draw distance setting. (0-100)
*'''SettingVolumetricShadows:''' The volumetric shadows setting. (true/false)
*'''SettingStreamingVideoMemoryForGTA:''' The usable graphics memory setting. (64-256)
*'''SettingAnisotropicFiltering:''' The anisotropic filtering setting. (0-4 which respectively mean: off, 2x, 4x, 8x, 16x)
*'''SettingAntiAliasing:''' The anti-aliasing setting. (0-3 which respectively mean: off, 1x, 2x, 3x)
*'''SettingHeatHaze:''' The heat haze setting. (true/false)
*'''SettingGrassEffect:''' The grass effect setting. (true/false)
*'''Setting32BitColor:''' The color depth of the screen. (false is 16bit, true is 32bit)
*'''SettingHUDMatchAspectRatio:''' The hud match aspect ratio setting. (true/false)
*'''SettingAspectRatio:''' The aspect ratio setting. ("auto", "4:3", "16:10", "16:9")
*'''SettingFOV:''' The FOV setting.
*'''SettingHighDetailVehicles:''' High detail vehicles setting. (true/false)
{{Added feature/item|1.5.9|1.5.8|20508|
*'''SettingHighDetailPeds:''' High detail peds setting. (true/false)
}}
{{Added feature/item|1.5.9|1.5.8|21251|
*'''SettingCoronaReflections:''' Corona rain reflections setting. (true/false)
}}
*'''AllowScreenUpload:''' The allows screen uploads setting. (true/false)
*'''DepthBufferFormat:''' The format of the shader readable depth buffer, or 'unknown' if not available.
{{Added feature/item|1.5.9|1.5.8|20901|
*'''TotalPhysicalMemory:''' The amount of total physical memory in MB.
}}
*'''UsingDepthBuffer:''' ''true'' if the depth buffer is used, ''false'' otherwise.
==Example==
<syntaxhighlight lang="lua">
addCommandHandler("getinfo",
function ()
local info = dxGetStatus ()
for k, v in pairs (info) do
outputChatBox (k .. " : " .. tostring (v))
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04715|Added DepthBufferFormat argument}}
{{ChangelogItem|1.3.0-9.04811|Added VideoCardMaxAnisotropy, SettingAnisotropicFiltering, SettingAntiAliasing,<br/> SettingHeatHaze, SettingGrassEffect and Setting32BitColor arguments}}
{{ChangelogItem|1.3.4-9.05731|Added SettingHUDMatchAspectRatio and SettingAspectRatio}}
{{ChangelogItem|1.4.1-9.07181|Added SettingFOV}}
{{ChangelogItem|1.4.1-9.07310|Added VideoCardNumRenderTargets}}
{{ChangelogItem|1.5.2-9.07816|Added UsingDepthBuffer}}
{{ChangelogItem|1.5.3-9.11199|Added SettingHighDetailVehicles}}
{{ChangelogItem|1.5.5-9.11814|Added SettingFullScreenStyle<br/>Fixed SettingWindowed}}
{{ChangelogItem|1.5.8-9.20508|Added SettingHighDetailPeds}}
{{ChangelogItem|1.5.8-9.20901|Added TotalPhysicalMemory}}

==See Also==
{{Drawing_functions}}

[[hu:dxGetStatus]]

SetPedsLODDistance

2022-10-07T21:23:13Z

Lopez: change arg desc

__NOTOC__
{{Client function}}
{{New feature/item|3.0156|1.5.5|13771|This function sets the peds LOD distance.}}
[[File:Peds Lod Distance = 60.png|200px|thumb|right|60 units]]
[[File:Peds Lod Distance = 100.png|200px|thumb|right|100 units]]
[[File:Peds Lod Distance = 500.png|200px|thumb|right|500 units]]

==Syntax==
<syntaxhighlight lang="lua">bool setPedsLODDistance ( float distance )</syntaxhighlight>

===Required arguments===
*'''distance:''' the new peds LOD distance. This value is clamped to '''0''' – '''500'''. (Default for ''high_detail_peds'' on is '''500''', when off, it is '''60''').

===Returns===
This function returns ''true'' if the argument is valid. Returns ''false'' otherwise.

==Example==
This example sets the peds LOD distance to 120.
<syntaxhighlight lang="lua">setPedsLODDistance( 120 )</syntaxhighlight>

==See also==
* [[engineGetModelLODDistance]]
* [[engineSetModelLODDistance]]
{{Client world functions}}

SetVehiclesLODDistance

2022-10-07T21:21:31Z

Lopez:

{{Client function}}__NOTOC__
{{New feature/item|3.0154|1.5.3|11199|
Sets the distance of vehicles LOD.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehiclesLODDistance(float vehiclesDistance [, float trainsAndPlanesDistance = vehiclesDistance * 2.14])
</syntaxhighlight>

===Required Arguments===
*'''vehiclesDistance:''' general distance used for most vehicles, this value is clamped to 0 – 500

===Optional Arguments===
{{OptionalArg}}
*'''trainsAndPlanesDistance:''' distance used for trains and planes, this value is clamped to 0 – 500

== Returns ==
This function returns ''true'' if arguments are valid. Returns ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart",resourceRoot,function()
setVehiclesLODDistance(10)
end)
</syntaxhighlight>

==See Also==
* [[engineGetModelLODDistance]]
* [[engineSetModelLODDistance]]
{{Client world functions}}

SetCoronaReflectionEnabled

2022-10-07T21:05:44Z

Lopez:

SetCoronaReflectionsEnabled

2022-10-07T21:04:13Z

Lopez: /* Example */

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function sets visibility of corona reflections.}}

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

===Required Arguments===
*'''enabled:'''
** '''0''': disabled
** '''1''': enabled
** '''2''': force enabled, even if there is no rain

===Returns===
Returns ''true'' if passed arguments are correct, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- Force enable corona reflections even if there is no rain
setCoronaReflectionsEnabled(2)
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|2755|Corona reflections do not render on custom placed objects}}
{{Issue|2750|Corona reflections do not render on all roads}}
}}

==See Also==
{{client world functions}}

Translating

2022-09-27T14:13:12Z

Lopez:

{{ Outdated | "See https://multitheftauto.crowdin.com/multitheftauto" }}

It's proposed that we have a way of translating MTA into different languages, and allowing our community to contribute their translations.

==Why?==
We've seen a couple of people try to fork MTA to make arabic and polish translations. We want to discourage forking for such trivial reasons if we can. Also, we'd encourage more players to play MTA if they can understand it.

==How==
The library ''gettext'' seems to be the standard way of doing this, at least in the Linux world.

Writing our own seems to be a bad idea - we don't know enough about languages to do this.

We should be able to use utf8 to encode the strings, meaning very little of our code should need to change. Most of our current support for unicode is done with utf8 so this seems easy. It remains to be seen how much needs to be changed to support this.

==The code==
Gettext works by wrapping strings in calls to the ''gettext'' function.
So:
<syntaxhighlight lang="lua">[c++]
Print ( "Press Q to shut down the server!\n" );
</syntaxhighlight>
Becomes:
<syntaxhighlight lang="lua">[c++]
Print ( gettext("Press Q to shut down the server!\n") );
</syntaxhighlight>
Though, we probably don't want to include new line characters, so it becomes:
<syntaxhighlight lang="lua">[c++]
Print ( "%s\n", gettext("Press Q to shut down the server!"));
</syntaxhighlight>
Plus, it can be convenient to have a shorthand, and it seems that defining _ as gettext is conventional, so you end up with:
<syntaxhighlight lang="lua">[c++]
Print ( "%s\n", _("Press Q to shut down the server!"));
</syntaxhighlight>

Maybe we should make a short hand version of Print that always does a new line?

==Generating the translation template==
From the code you can generate the template that lists the strings that need to be generated. gettext comes with a tool for this, and I've wrapped it up in a script that makes it more convenient. It's currently utils/build_gettext_catalog.py (though not yet committed).

This scans all the cpp and h files in the MTA10 and MTA10_SERVER directories and passes them into the xgettext executable which generates a ''pot'' file, which looks something like the following:
<syntaxhighlight lang="lua">
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2010-12-20 19:27+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"

#. Couldn't load our mod
msgid "Press Q to shut down the server!"
msgstr ""
</syntaxhighlight>

Notice that comments from the code are extracted and placed above the strings, so we can provide guidance for what each string's purpose is.

==Editing==
The template itself isn't edited, I think. You can create a copy of it and generate a new translation by filling in the msgstr strings. There are editors, such as the cross platform poedit that deals with these files and handles various useful things such as validating them and merging them when new strings are added to the template. This seems pretty easy to use. It notices things such as missing formatting specifiers (%s etc) in strings.

Once you've edited the file, you can save it as a .po file. This is basically identical to the .pot file, just has translations in it.

These files are turned into .mo files which are compiled versions. Poedit does this for you, but I've made a script that does it in the utils directory.

==Where?==
I've placed the translations in a root ''Translations'' directory (alongside MTA10 and MTA10_SERVER). The translations are shared between client and server, I'm not sure if this is a good or bad thing, but it could be changed. It might save work and disk space somewhat, though we probably want the translations to be placed in the server and client directories anyway.

==Making it work==
To make it work, you link against libintl.lib (in vendor/gettext/libs) and have the dll libintl3.dll along side the executables.

Currently I've only tested this in the CServerImpl.cpp file, adding this at the top:
<syntaxhighlight lang="lua">[c++]
#include <libintl.h>
#define _ gettext
</syntaxhighlight>
Then this in the constructor:
<syntaxhighlight lang="lua">[c++]
char* s = setlocale(LC_ALL, "");
bindtextdomain("messages", "translations/"); // specifies the directory to look in
textdomain( "messages");
</syntaxhighlight>

==Files==
We would ship the .mo files. Each language would have a directory in the Translations directory, e.g. en_US, fr_FR etc, inside which is a directory LC_MESSAGES, inside which is a messages.mo file. We can't really change anything except where this directory is and what the .mo file is called, the locale and the LC_MESSAGES directories have to be there. It seems.

==What?==
We ideally allow every part of MTA client and server to be translated. The server is less important, but we ought to do it if we can.

==User Interface==
We'd need to provide a user interface for changing language. We can use the system settings (somehow - gettext may do this for us?) to work out the right language. But often, users may be more comfortable with another language (or their translation might be awful).

This would make most sense to be in the 'Interface' tab of the client settings. Server-side, we'd provide a config setting.

==The hard work==
Once the system is set up, some people need to go through and mark up each string that we want to be translatable. This could be anyone really as coding isn't really required (except with some odd strings perhaps).

==The really hard work==
Getting people to translate it is obviously hard work. But I imagine we have a lot of keen community members who will do this, if we release the relevant files and isnstruct them on how to do it. As the tools we're using are fairly standard, we may find that people already know how to use them if they've translated other projects.

==What else?==
Perhaps we want to add a 'server language' setting that gets shown in the server browser. I'm not sure if we want to encourage such ghettoization, but it might be of benefit to our users.

==Notes==
Do we need strlen to not work on utf8 strings in 1.1? Could we just make it the same as utf8len (or whatever it's called)?

[[Category:Development]]

Translating

2022-09-27T14:12:12Z

Lopez:

Translating

2022-09-27T14:11:19Z

Lopez:

{{ Outdated }}

It's proposed that we have a way of translating MTA into different languages, and allowing our community to contribute their translations.

==Why?==
We've seen a couple of people try to fork MTA to make arabic and polish translations. We want to discourage forking for such trivial reasons if we can. Also, we'd encourage more players to play MTA if they can understand it.

==How==
The library ''gettext'' seems to be the standard way of doing this, at least in the Linux world.

Writing our own seems to be a bad idea - we don't know enough about languages to do this.

We should be able to use utf8 to encode the strings, meaning very little of our code should need to change. Most of our current support for unicode is done with utf8 so this seems easy. It remains to be seen how much needs to be changed to support this.

==The code==
Gettext works by wrapping strings in calls to the ''gettext'' function.
So:
<syntaxhighlight lang="lua">[c++]
Print ( "Press Q to shut down the server!\n" );
</syntaxhighlight>
Becomes:
<syntaxhighlight lang="lua">[c++]
Print ( gettext("Press Q to shut down the server!\n") );
</syntaxhighlight>
Though, we probably don't want to include new line characters, so it becomes:
<syntaxhighlight lang="lua">[c++]
Print ( "%s\n", gettext("Press Q to shut down the server!"));
</syntaxhighlight>
Plus, it can be convenient to have a shorthand, and it seems that defining _ as gettext is conventional, so you end up with:
<syntaxhighlight lang="lua">[c++]
Print ( "%s\n", _("Press Q to shut down the server!"));
</syntaxhighlight>

Maybe we should make a short hand version of Print that always does a new line?

==Generating the translation template==
From the code you can generate the template that lists the strings that need to be generated. gettext comes with a tool for this, and I've wrapped it up in a script that makes it more convenient. It's currently utils/build_gettext_catalog.py (though not yet committed).

This scans all the cpp and h files in the MTA10 and MTA10_SERVER directories and passes them into the xgettext executable which generates a ''pot'' file, which looks something like the following:
<syntaxhighlight lang="lua">
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2010-12-20 19:27+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"

#. Couldn't load our mod
msgid "Press Q to shut down the server!"
msgstr ""
</syntaxhighlight>

Notice that comments from the code are extracted and placed above the strings, so we can provide guidance for what each string's purpose is.

==Editing==
The template itself isn't edited, I think. You can create a copy of it and generate a new translation by filling in the msgstr strings. There are editors, such as the cross platform poedit that deals with these files and handles various useful things such as validating them and merging them when new strings are added to the template. This seems pretty easy to use. It notices things such as missing formatting specifiers (%s etc) in strings.

Once you've edited the file, you can save it as a .po file. This is basically identical to the .pot file, just has translations in it.

These files are turned into .mo files which are compiled versions. Poedit does this for you, but I've made a script that does it in the utils directory.

==Where?==
I've placed the translations in a root ''Translations'' directory (alongside MTA10 and MTA10_SERVER). The translations are shared between client and server, I'm not sure if this is a good or bad thing, but it could be changed. It might save work and disk space somewhat, though we probably want the translations to be placed in the server and client directories anyway.

==Making it work==
To make it work, you link against libintl.lib (in vendor/gettext/libs) and have the dll libintl3.dll along side the executables.

Currently I've only tested this in the CServerImpl.cpp file, adding this at the top:
<syntaxhighlight lang="lua">[c++]
#include <libintl.h>
#define _ gettext
</syntaxhighlight>
Then this in the constructor:
<syntaxhighlight lang="lua">[c++]
char* s = setlocale(LC_ALL, "");
bindtextdomain("messages", "translations/"); // specifies the directory to look in
textdomain( "messages");
</syntaxhighlight>

==Files==
We would ship the .mo files. Each language would have a directory in the Translations directory, e.g. en_US, fr_FR etc, inside which is a directory LC_MESSAGES, inside which is a messages.mo file. We can't really change anything except where this directory is and what the .mo file is called, the locale and the LC_MESSAGES directories have to be there. It seems.

==What?==
We ideally allow every part of MTA client and server to be translated. The server is less important, but we ought to do it if we can.

==User Interface==
We'd need to provide a user interface for changing language. We can use the system settings (somehow - gettext may do this for us?) to work out the right language. But often, users may be more comfortable with another language (or their translation might be awful).

This would make most sense to be in the 'Interface' tab of the client settings. Server-side, we'd provide a config setting.

==The hard work==
Once the system is set up, some people need to go through and mark up each string that we want to be translatable. This could be anyone really as coding isn't really required (except with some odd strings perhaps).

==The really hard work==
Getting people to translate it is obviously hard work. But I imagine we have a lot of keen community members who will do this, if we release the relevant files and isnstruct them on how to do it. As the tools we're using are fairly standard, we may find that people already know how to use them if they've translated other projects.

==What else?==
Perhaps we want to add a 'server language' setting that gets shown in the server browser. I'm not sure if we want to encourage such ghettoization, but it might be of benefit to our users.

==Notes==
Do we need strlen to not work on utf8 strings in 1.1? Could we just make it the same as utf8len (or whatever it's called)?

How you can help

2022-09-27T14:00:49Z

Lopez: /* Coding for MTA:SA */ fix link

__NOTOC__
Multi Theft Auto has loads of areas in which you can help us. In turn, we'll be more than happy to help you get started with any ideas you have, help test them and - if they're good enough - release them to the whole community. This page outlines the key areas you could do something in, of course, there are many things we've not thought of, so think outside the box!

==Coding for MTA:SA==
* Become a patch contributor by sending [https://github.com/multitheftauto/mtasa-blue/pulls pull requests] to MTA, containing requested features or bugfixes. ([https://github.com/multitheftauto/mtasa-blue/blob/master/CONTRIBUTING.md#contributors-guide Coding guidelines])
* Translate MTA:SA to your native language - https://translate.multitheftauto.com/

==Scripting==
* Become a contributor to MTA's official resources by sending [https://github.com/multitheftauto/mtasa-resources/pulls pull requests] to our resources repository
* Create and [https://community.mtasa.com/ publish] a gamemode or useful script
**[[Scripting Introduction]]
**[https://www.lua.org/pil/index.html "Programming in Lua" Manual]
* Make a general purpose resource that provides useful functions to other resources.

==Mapping==
* Create and [https://community.mtasa.com/ publish] a map for an existing gamemode, with the map editor.
**[[Resource:Editor|Map Editor Manual]]

==Web development==
* Create your own system for statistics - using the [[PHP SDK]] as a basis. Join the [https://discord.gg/RygaCSD MTA discord] (or [https://discord.gg/GNN6PRtTnu development discord]) for help.

==Documentation==
Before you make changes check out: [[Help:Editing Guidelines|Editing Guidelines]] and [[Help:MTA Wiki Specific Templates|Specific Templates]]
* Finish documentation for [[:Category:Incomplete|Incomplete functions]] - ask in #mta.scripting if you're not sure of something.
* Add examples to [[:Category:Needs Example|functions & events missing examples]] - please '''test''' them, and again, ask if you need help.
* Review and verify [[:Category:Needs Checking|pages that need checking]] - make sure highlighted issues are solved before removing pages from the category.
* Expand the pages that explain [[:Category:Scripting_Concepts|MTA core concepts]].
* Write [https://forum.mtasa.com/forum/123-tutorials/ tutorials] to help new people.
* Translate the wiki pages so people from other countries can get started in MTA too.
* Create documentation for undocumented functions and events [[Undocumented Items]]
* Keep 'changes in' [current work-in-progress: https://wiki.multitheftauto.com/wiki/Changes_in_1.6] for future releases updated.

==Quality Assurance==
* [https://github.com/multitheftauto/mtasa-blue/issues Report issues] with the mod, make sure to do a search on the already reported issues first.
* Test and confirm existing reported issues.
* Use the newest build of MTA to detect and report new bugs, by going to 'Settings', 'Advanced', 'Update build type' and choosing 'Nightly' or get it regularly [https://nightly.mtasa.com/ from here].
* Any bugs which are related to a scripting function / event and present in the main release (rather than nightlies), document that bug by adding a [https://wiki.multitheftauto.com/wiki/Help:MTA_Wiki_Specific_Templates warning] to the wiki page to save other scripters a lot of time.

==Specific tasks==
* Create a fuzzer to check for crashes in our scripting functions.

==Grant==
You can donate to MTA:SA [https://mtasa.com/donate/manage.php here]

[[ar:كيف_يمكنك_المساعدة]]
[[en:How you can help]]
[[ru:How you can help]]
[[pl:Jak możesz pomóc]]
[[uk:How you can help]]
[[es:Cómo puedes ayudar]]
[[hu:How you can help]]
[[tr:Nasıl yardımcı olabilirsiniz]]
[[pt-br:Como você pode ajudar]]

SetCoronaReflectionsEnabled

2022-09-25T11:19:56Z

Lopez:

IsCoronaReflectionEnabled

2022-09-25T11:19:35Z

Lopez:

GetCoronaReflectionsEnabled

2022-09-25T11:19:17Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|This function gets visibility of corona reflections.}}

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

===Returns===
One of the following integers will be returned:
* '''0''': corona reflections are disabled
* '''1''': corona reflections are enabled
* '''2''': corona reflections are force enabled, even if there is no rain

==See Also==
{{client world functions}}

SetCoronaReflectionEnabled

2022-09-25T11:19:03Z

Lopez:

IsCoronaReflectionEnabled

2022-09-25T11:13:31Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Gets visibility of corona reflection.}}
==Syntax==
<syntaxhighlight lang="lua">
bool isCoronaReflectionEnabled ( marker theMarker )
</syntaxhighlight>
{{OOP||[[Marker]]:isCoronaReflectionEnabled||setCoronaReflectionEnabled}}
===Required Arguments===
*'''theMarker:''' marker

===Returns===
* Returns ''false'' is [[setMarkerType|marker type]] is not ''corona''.
* Returns ''true'' if corona reflection is enabled, ''false'' otherwise.

==See Also==
{{client marker functions}}

SetCoronaReflectionEnabled

2022-09-25T11:13:14Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflection.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setCoronaReflectionEnabled ( marker theMarker, bool enabled )
</syntaxhighlight>
{{OOP||[[Marker]]:setCoronaReflectionEnabled||isCoronaReflectionEnabled}}
===Required Arguments===
*'''theMarker:''' the corona marker that you wish set visibility of corona reflection
*'''enabled:''' whenever corona reflection should be visible

===Returns===
Returns ''true'' if [[setMarkerType|marker type]] is ''corona'', ''false'' otherwise.

==See Also==
{{client marker functions}}

SetCoronaReflectionEnabled

2022-09-25T11:11:48Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflection.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setCoronaReflectionEnabled ( marker theMarker, bool enabled )
</syntaxhighlight>
{{OOP||[[Marker]]:setCoronaReflectionEnabled||isCoronaReflectionEnabled}}
===Required Arguments===
*'''theMarker:''' the corona marker that you wish set visibility of corona reflection
*'''enabled:''' whenever corona reflection should be visible

===Returns===
Returns ''true'' if marker type is ''corona'', ''false'' otherwise.

==See Also==
{{client marker functions}}

IsCoronaReflectionEnabled

2022-09-25T11:11:07Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Gets visibility of corona reflection.}}
==Syntax==
<syntaxhighlight lang="lua">
bool isCoronaReflectionEnabled ( marker theMarker )
</syntaxhighlight>
{{OOP||[[Marker]]:isCoronaReflectionEnabled||setCoronaReflectionEnabled}}
===Required Arguments===
*'''theMarker:''' marker

===Returns===
* Returns ''false'' is marker type is not ''corona''.
* Returns ''true'' if corona reflection is enabled, ''false'' otherwise.

==See Also==
{{client marker functions}}

SetCoronaReflectionEnabled

2022-09-25T11:09:05Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflection.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setCoronaReflectionEnabled ( marker theMarker, bool enabled )
</syntaxhighlight>

===Required Arguments===
*'''theMarker:''' the corona marker that you wish set visibility of corona reflection
*'''enabled:''' whenever corona reflection should be visible

===Returns===
Returns ''true'' if marker type is ''corona'', ''false'' otherwise.

==See Also==
{{client marker functions}}

SetCoronaReflectionEnabled

2022-09-25T11:08:51Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflection.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setCoronaReflectionEnabled ( marker theMarker, bool enabled )
</syntaxhighlight>

===Required Arguments===
*''theMarker:''' the corona marker that you wish set visibility of corona reflection
*'''enabled:''' whenever corona reflection should be visible

===Returns===
Returns ''true'' if marker type is ''corona'', ''false'' otherwise.

==See Also==
{{client marker functions}}

IsCoronaReflectionEnabled

2022-09-25T11:07:57Z

Lopez: Created page with "{{Client function}} __NOTOC__ {{Added feature/item|1.5.9|1.5.8|21251|Gets visibility of corona reflection.}} ==Syntax== <syntaxhighlight lang="lua"> bool isCoronaReflectionEnabled ( marker theMarker ) </syntaxhighlight> ===Required Arguments=== *'''theMarker:''' marker ===Returns=== * Returns ''false'' is marker type is not ''corona''. * Returns ''true'' if corona reflection is enabled, ''false'' otherwise. ==See Also== {{client marker functions}}"

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Gets visibility of corona reflection.}}

==Syntax==
<syntaxhighlight lang="lua">
bool isCoronaReflectionEnabled ( marker theMarker )
</syntaxhighlight>

===Required Arguments===
*'''theMarker:''' marker

===Returns===
* Returns ''false'' is marker type is not ''corona''.
* Returns ''true'' if corona reflection is enabled, ''false'' otherwise.

==See Also==
{{client marker functions}}

SetCoronaReflectionEnabled

2022-09-25T11:05:58Z

Lopez: Created page with "{{Client function}} __NOTOC__ {{Added feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflection.}} ==Syntax== <syntaxhighlight lang="lua"> bool setCoronaReflectionEnabled ( marker theMarker, bool enabled ) </syntaxhighlight> ===Required Arguments=== *'''bEnabled:''' whenever corona reflection should be visible ===Returns=== Returns ''true'' if marker type is ''corona'', ''false'' otherwise. ==See Also== {{client marker functions}}"

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflection.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setCoronaReflectionEnabled ( marker theMarker, bool enabled )
</syntaxhighlight>

===Required Arguments===
*'''bEnabled:''' whenever corona reflection should be visible

===Returns===
Returns ''true'' if marker type is ''corona'', ''false'' otherwise.

==See Also==
{{client marker functions}}

GetCoronaReflectionsEnabled

2022-09-25T11:02:08Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Gets visibility of corona reflections.}}

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

===Returns===
One of the following integers will be returned:
* '''0''': corona reflections are disabled
* '''1''': corona reflections are enabled
* '''2''': corona reflections are force enabled, even if there is no rain

==See Also==
{{client world functions}}

SetCoronaReflectionsEnabled

2022-09-25T11:01:56Z

Lopez:

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflections.}}

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

===Required Arguments===
*'''enabled:'''
** '''0''': disabled
** '''1''': enabled
** '''2''': force enabled, even if there is no rain

===Returns===
Returns ''true'' if passed arguments are correct, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- Force enable corona reflections even if there is no rain
setCoronaReflectionsEnabled(2)
</syntaxhighlight>

==See Also==
{{client world functions}}

Template:Client marker functions

2022-09-25T10:59:59Z

Lopez:

*[[createMarker]]
*[[getMarkerColor]]
*[[getMarkerCount]]
*[[getMarkerIcon]]
*[[getMarkerSize]]
*[[getMarkerTarget]]
*[[getMarkerType]]
*[[isCoronaReflectionEnabled]]
*[[isElementWithinMarker]]
*[[setCoronaReflectionEnabled]]
*[[setMarkerColor]]
*[[setMarkerIcon]]
*[[setMarkerSize]]
*[[setMarkerTarget]]
*[[setMarkerType]]

<noinclude>[[Category:Functions templates]]</noinclude>

Template:Client world functions

2022-09-25T10:58:24Z

Lopez:

* [[areTrafficLightsLocked]]
* [[createSWATRope]]
* [[getAircraftMaxHeight]]
* [[getAircraftMaxVelocity]]
* [[getBirdsEnabled]]
* [[getCloudsEnabled]]
* [[getCoronaReflectionsEnabled]]
* [[getFarClipDistance]]
* [[getFogDistance]]
* [[getGameSpeed]]
* [[getGarageBoundingBox]]
* [[getGaragePosition]]
* [[getGarageSize]]
* [[getGravity]]
* [[getGroundPosition]]
* [[getHeatHaze]]
* [[getInteriorFurnitureEnabled]]
* [[getInteriorSoundsEnabled]]
* [[getJetpackMaxHeight]]
* [[getMinuteDuration]]
* [[getMoonSize]]
* [[getNearClipDistance]]
* [[getOcclusionsEnabled]]
* [[getPedsLODDistance]]
* [[getPlayerBlurLevel]]
* [[getRainLevel]]
{{Added feature/item|1.5.9|1.5.8|20675|
* [[getRoofPosition]]
}}
* [[getScreenFromWorldPosition]]
* [[getSunColor]]
* [[getSunSize]]
* [[getTime]]
* [[getTrafficLightState]]
* [[getVehiclesLODDistance]]
* [[getWeather]]
* [[getWindVelocity]]
* [[getWorldFromScreenPosition]]
* [[getZoneName]]
* [[isAmbientSoundEnabled]]
* [[isGarageOpen]]
* [[isLineOfSightClear]]
* [[isWorldSoundEnabled]]
* [[isWorldSpecialPropertyEnabled]]
* [[processLineOfSight]]
* [[removeWorldModel]]
* [[resetAmbientSounds]]
* [[resetBlurLevel]]
* [[resetColorFilter]]
* [[resetFarClipDistance]]
* [[resetFogDistance]]
* [[resetHeatHaze]]
* [[resetMoonSize]]
* [[resetNearClipDistance]]
* [[resetPedsLODDistance]]
* [[resetRainLevel]]
* [[resetSkyGradient]]
* [[resetSunColor]]
* [[resetSunSize]]
* [[resetVehiclesLODDistance]]
* [[resetWindVelocity]]
* [[resetWorldSounds]]
* [[restoreAllWorldModels]]
* [[restoreWorldModel]]
* [[setAircraftMaxHeight]]
* [[setAircraftMaxVelocity]]
* [[setAmbientSoundEnabled]]
* [[setBirdsEnabled]]
* [[setCloudsEnabled]]
* [[setColorFilter]]
* [[setCoronaReflectionsEnabled]]
* [[setFarClipDistance]]
* [[setFogDistance]]
* [[setGameSpeed]]
* [[setGarageOpen]]
* [[setGravity]]
* [[setHeatHaze]]
* [[setInteriorFurnitureEnabled]]
* [[setInteriorSoundsEnabled]]
* [[setJetpackMaxHeight]]
* [[setMinuteDuration]]
* [[setMoonSize]]
* [[setNearClipDistance]]
* [[setOcclusionsEnabled]]
* [[setPedsLODDistance]]
* [[setPlayerBlurLevel]]
* [[setRainLevel]]
* [[setSkyGradient]]
* [[setSunColor]]
* [[setSunSize]]
* [[setTime]]
* [[setTrafficLightsLocked]]
* [[setTrafficLightState]]
* [[setVehiclesLODDistance]]
* [[setWeather]]
* [[setWeatherBlended]]
* [[setWindVelocity]]
* [[setWorldSoundEnabled]]
* [[setWorldSpecialPropertyEnabled]]
* [[testLineAgainstWater]]

<noinclude>[[Category:Functions templates]]</noinclude>

SetCoronaReflectionsEnabled

2022-09-25T10:56:23Z

Lopez:

{{Client function}}
__NOTOC__
{{New feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflections.}}

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

===Required Arguments===
*'''enabled:'''
** '''0''': disabled
** '''1''': enabled
** '''2''': force enabled, even if there is no rain

===Returns===
Returns ''true'' if passed arguments are correct, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- Force enable corona reflections even if there is no rain
setCoronaReflectionsEnabled(2)
</syntaxhighlight>

==See Also==
{{client world functions}}

GetCoronaReflectionsEnabled

2022-09-25T10:55:26Z

Lopez: Created page with "{{Client function}} __NOTOC__ {{New feature/item|1.5.9|1.5.8|21251|Gets visibility of corona reflections.}} ==Syntax== <syntaxhighlight lang="lua"> int getCoronaReflectionsEnabled ( ) </syntaxhighlight> ===Returns=== One of the following integers will be returned: * '''0''': corona reflections are disabled * '''1''': corona reflections are enabled * '''2''': corona reflections are force enabled, even if there is no rain ==See Also== {{client world functions}}"

{{Client function}}
__NOTOC__
{{New feature/item|1.5.9|1.5.8|21251|Gets visibility of corona reflections.}}

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

===Returns===
One of the following integers will be returned:
* '''0''': corona reflections are disabled
* '''1''': corona reflections are enabled
* '''2''': corona reflections are force enabled, even if there is no rain

==See Also==
{{client world functions}}

SetCoronaReflectionsEnabled

2022-09-25T10:52:34Z

Lopez: Created page with "{{Client function}} __NOTOC__ {{New feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflections.}} ==Syntax== <syntaxhighlight lang="lua"> bool setCoronaReflectionsEnabled ( int enabled ) </syntaxhighlight> ===Required Arguments=== *'''enabled:''' ** 0 - disabled ** 1 - enabled ** 2 - force enabled, even if there is no rain ===Returns=== Returns ''true'' if passed arguments are correct, ''false'' otherwise. ==Example== <syntaxhighlight lang="lua"> -- For..."

{{Client function}}
__NOTOC__
{{New feature/item|1.5.9|1.5.8|21251|Sets visibility of corona reflections.}}

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

===Required Arguments===
*'''enabled:'''
** 0 - disabled
** 1 - enabled
** 2 - force enabled, even if there is no rain

===Returns===
Returns ''true'' if passed arguments are correct, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- Force enable corona reflections even if there is no rain
setCoronaReflectionsEnabled(2)
</syntaxhighlight>

==See Also==
{{client world functions}}

Code snippet for extracting weapon stats

2022-09-15T22:05:51Z

Lopez:

Code snippet which might be used to extract weapon stats:

<syntaxhighlight lang="lua">
count = 22
statid = 3

addCommandHandler("dump", function ()
while (count < 33) do
hFile = fileOpen ( "dump.txt" )
fileSetPos(hFile, fileGetSize ( hFile ))
i = count
fileWrite(hFile, "// " .. i .. " - " .. getWeaponNameFromID( i ) .. " Stat: " .. statid )
fileWrite(hFile, "\r\n")
for k,v in ipairs(props) do
outputChatBox(v)
fileWrite(hFile, Dump(v))
fileWrite(hFile, "\r\n")
end
fileClose(hFile)
count = count + 1
end
end)

function Array()
if (statid == 3) then
return "OriginalHitmanData["
elseif ( statid == 2 ) then
return "OriginalGangsterData["
else
return "OriginalWeaponData["
end
end

function Dump(strInfo)
i = count
-- Special case for Vectors
if ( strInfo == "fire_offset") then
fx, fy, fz = getWeaponProperty(i, statid, strInfo)
return Array() .. i .. "]." .. strInfo .. " = CVector ( " .. floatify ( fx ) .. ", " .. floatify ( fy ) .. ", " .. floatify ( fz ) .. " );"
end
-- Avoids compile errors ( Cannot convert from x to y )
if ( strInfo == "skill_level" ) then
return Array() .. i .. "]." .. strInfo .. " = (eWeaponSkill) " .. getWeaponProperty(i, statid, strInfo) .. ";"
end
if ( strInfo == "weapon_slot" ) then
return Array() .. i .. "]." .. strInfo .. " = (eWeaponSlot) " .. getWeaponProperty(i, statid, strInfo) .. ";"
end
if ( strInfo == "fire_type" ) then
return Array() .. i .. "]." .. strInfo .. " = (eFireType) " .. getWeaponProperty(i, statid, strInfo) .. ";"
end
-- end
-- Avoids Conversion from Double to float warnings.
if ( strInfo == "weapon_range" or strInfo == "target_range" or strInfo == "accuracy" or strInfo == "move_speed" or strInfo == "anim_loop_start" or
strInfo == "anim_loop_stop" or strInfo == "anim_loop_bullet_fire" or strInfo == "anim2_loop_start" or strInfo == "anim2_loop_stop" or strInfo ==
"anim2_loop_bullet_fire" or strInfo == "anim_breakout_time" or strInfo == "firing_speed" or strInfo == "radius" or strInfo == "life_span" or strInfo ==
"spread") then return Array() .. i .. "]." .. strInfo .. " = " .. floatify ( getWeaponProperty(i, statid, strInfo) ) .. ";" end
-- Default
return Array() .. i .. "]." .. strInfo .. " = " .. getWeaponProperty(i, statid, strInfo) .. ";"
end

-- Avoids conversion from Double to float warnings.
function floatify ( fVal )
if ( fVal == math.floor( fVal ) or fVal == math.ceil( fVal ) ) then
return fVal .. ".0f"
end
return fVal .. "f"
end
</syntaxhighlight>

(mtasa-blue source code contains link to this page)

(moved from [https://github.com/multitheftauto/mtasa-blue/blob/c58c3678f263d810f61eb5aecba48e6c4b4dce0c/Client/game_sa/CWeaponStatManagerSA.cpp#L153-L219 multitheftauto/mtasa-blue/blob/c58c3678f263d810f61eb5aecba48e6c4b4dce0c/Client/game_sa/CWeaponStatManagerSA.cpp#L153-L219])

[[Category:Development]]