Multi Theft Auto: Wiki - User contributions [en]

CountPlayersInRange

2014-12-11T04:05:00Z

Ares Mta:

__NOTOC__
{{Useful Function}}
This function allows you to set '''moving''' element speed in kph or mph units.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])
</syntaxhighlight>

===Required Arguments===
* '''theElement''': Element you want to set speed of

===Optional Arguments===
{{OptionalArg}}
* '''unit''': Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.
* '''speed''': Speed in selected unit

==Code==
{{RequiredFunctions|getElementSpeed}}
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function setElementSpeed(element, unit, speed)
if (unit == nil) then unit = 0 end
if (speed == nil) then speed = 0 end
speed = tonumber(speed)
local acSpeed = getElementSpeed(element, unit)
if (acSpeed~=false) then -- if true - element is valid, no need to check again
local diff = speed/acSpeed
if diff ~= diff then return end -- if the number is a 'NaN' return end.
local x,y,z = getElementVelocity(element)
setElementVelocity(element,x*diff,y*diff,z*diff)
return true
end

return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server-side example" class="server" show="true">
This example adds command that set player vehicle speed to provided one (in predefined unit kph). Note: It doesn't care if player is driver or passenger.
<syntaxhighlight lang="lua">
addCommandHandler("setmyspeed",
function (player, cmd, arg1)
local veh = getPedOccupiedVehicle(player)
if (veh) then
setElementSpeed(veh, "kph", tonumber(arg1))
else
outputChatBox("You have to sit in vehicle", player)
end
end
)
</syntaxhighlight>
</section>

By '''varez'''.

==See Also==
{{Useful_Functions}}

CountPlayersInRange

2014-12-11T04:04:15Z

Ares Mta: Fixed the "NaN" debug

__NOTOC__
{{Useful Function}}
This function allows you to set '''moving''' element speed in kph or mph units.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])
</syntaxhighlight>

===Required Arguments===
* '''theElement''': Element you want to set speed of

===Optional Arguments===
{{OptionalArg}}
* '''unit''': Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.
* '''speed''': Speed in selected unit

==Code==
{{RequiredFunctions|getElementSpeed}}
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function setElementSpeed(element, unit, speed) -- only work if element is moving!
if (unit == nil) then unit = 0 end
if (speed == nil) then speed = 0 end
speed = tonumber(speed)
local acSpeed = getElementSpeed(element, unit)
if (acSpeed~=false) then -- if true - element is valid, no need to check again
local diff = speed/acSpeed
if diff ~= diff then return end -- if the number is a 'NaN' return end.
local x,y,z = getElementVelocity(element)
setElementVelocity(element,x*diff,y*diff,z*diff)
return true
end

return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server-side example" class="server" show="true">
This example adds command that set player vehicle speed to provided one (in predefined unit kph). Note: It doesn't care if player is driver or passenger.
<syntaxhighlight lang="lua">
addCommandHandler("setmyspeed",
function (player, cmd, arg1)
local veh = getPedOccupiedVehicle(player)
if (veh) then
setElementSpeed(veh, "kph", tonumber(arg1))
else
outputChatBox("You have to sit in vehicle", player)
end
end
)
</syntaxhighlight>
</section>

By '''varez'''.

==See Also==
{{Useful_Functions}}

FetchRemote

2014-10-30T00:23:53Z

Ares Mta:

__NOTOC__
{{Server client function}}
This function allows you to post and receive data from HTTP servers. The calls are asynchronous so you do not get an immediate result from the call, instead a callback function you specify is called when the download completes.

In the case when the call fails, a string containing "ERROR" followed by an integer containing the error reason will be passed to the callback function. The reason for failure will be similar to errors found with websites - file not found, server not found and timeouts.

If you are using fetchRemote to connect to a PHP script, you can use ''file_get_contents("php://input")'' to read the '''postData''' sent from this function.
{{Note|Client side function only works with the server the player is connected to or it will return the error #1006}}
==Syntax==
<syntaxhighlight lang="lua">
bool fetchRemote ( string URL[, int connectionAttempts = 10 ], callback callbackFunction, [ string postData = "", bool postIsBinary = false, [ arguments... ] ] )
</syntaxhighlight>

===Required Arguments===
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''callbackFunction:''' This is the function that should receive the data returned from the remote server. The callback argument list should be:
**'''''responseData''''' - A string containing the remote response or "ERROR" if there was a problem
**'''''errno''''' - A number containing the error number or zero if there was no error. A list of possible error values are:
{{Error_codes_for_callRemote_and_fetchRemote}}
<div style="padding-left:19px;">
*'''''arguments...''''' - The arguments that were passed into fetchRemote
</div>

===Optional Arguments===
*'''connectionAttempts:''' Number of times to retry if the remote host does not respond. ''In the case of a non-responding remote server, each connection attempt will timeout after 6 seconds. Therefore, the default setting of 10 connection attempts means it will be 60 seconds before your script gets a callback about the error. Reducing this value to 2 for example, will decrease that period to 12 seconds''
*'''postData:''' A string specifying any data you want to send to the remote HTTP server.
*'''postIsBinary :''' A boolean specifying if the data is text, or binary.
*'''arguments:''' Any arguments you may want to pass to the callback.

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

==Example==
This example shows you how you can fetch an image from a web page, and transfer it to a particular client:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">

function startImageDownload( playerToReceive )
fetchRemote ( "http://www.example.com/image.jpg", myCallback, "", false, playerToReceive )
end

function myCallback( responseData, errno, playerToReceive )
if errno == 0 then
triggerClientEvent( playerToReceive, "onClientGotImage", resourceRoot, responseData )
end
end
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent( "onClientGotImage", true )
addEventHandler( "onClientGotImage", resourceRoot,
function( pixels )
if myTexture then
destroyElement( myTexture )
end
myTexture = dxCreateTexture( pixels )
end
)

addEventHandler("onClientRender", root,
function()
if myTexture then
local w,h = dxGetMaterialSize( myTexture )
dxDrawImage( 200, 100, w, h, myTexture )
end
end
)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3.0-9.03739|1.3.2|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04605|Added connectionAttempts argument}}
{{ChangelogItem|1.3.2|Added client side}}

==See Also==
{{Resource_functions}}

EngineSetModelLODDistance

2014-09-25T19:24:12Z

Ares Mta:

{{Client function}}
__NOTOC__
This function sets a custom LOD distance for any object / model ID. This is the distance at which objects of that model ID are switched to their LOD model, or (if there is no LOD model) become invisible.

'''Notes:'''
The actual draw distance used is modified by the draw distance slider in the settings 'Video' tab of the MTA client.

*When the 'Video' tab draw distance slider is 0%, the engineSetModelLODDistance setting approximately matches the draw distance used.
:''e.g. engineSetModelLODDistance(1337,100) will mean model 1337 will be visible up to a distance of '''100''' units.''

*When the 'Video' tab draw distance slider is 100%, the engineSetModelLODDistance setting is approximately doubled before use.
:''e.g. engineSetModelLODDistance(1337,100) will mean model 1337 will be visible up to a distance of '''200''' units.''

However, there is a general draw distance limit of 300 units. So engineSetModelLODDistance(1337,400) will mean model 1337 will be visible up to a distance of 300 units no matter what the 'Video' tab says.

Therefore, unless it's really important, engineSetModelLODDistance should not be set to anything greater than 170.<br>
170 will still give the maximum draw distance (of 300 units) on clients that have a 'Video' tab draw distance setting of 100%, and it will help reduce lag for players who chose a lower draw distance in their settings.

{{New feature/item|3.0120|1.2||
For low LOD elements, engineSetModelLODDistance still has a limit of 300 units, but the actual draw distance used is 5 times the setting value. Also, low LOD elements ignore the 'Video' tab draw distance slider. So a setting of 200 will mean a low LOD element will always have a draw distance of '''1000''' units.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineSetModelLODDistance ( int model, float distance )
</syntaxhighlight>

===Required Arguments===
*'''model:''' The model / object ID number you want to change the LOD distance of.
*'''distance:''' New LOD distance value in San Andreas units.

===Returns===
Returns ''true'' if the function executed succesfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
for i, v in ipairs(getElementsByType("object"))do
local model = getElementModel(v)
engineSetModelLODDistance(model, 1000)
end
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}