Multi Theft Auto: Wiki - User contributions [en]

SecondsToTimeDesc

2015-02-27T18:14:34Z

FuSioN: /* Code */ (Fixed the function)

{{Useful Function}}
__NOTOC__
This function converts plain seconds-integer into a user-friendly time description.

==Syntax==
<syntaxhighlight lang="lua">string secondsToTimeDesc ( int seconds )</syntaxhighlight>

===Required Arguments===
* '''seconds''': The integer of seconds to convert into a user-friendly description.

===Returns===
Returns a user-friendly-description, or an empty string if the seconds were invalid/negative.

==Code==
<syntaxhighlight lang="lua">
function secondsToTimeDesc( seconds )
if seconds then
local results = {}
local sec = ( seconds %60 )
local min = math.floor ( ( seconds % 3600 ) /60 )
local hou = math.floor ( ( seconds % 86400 ) /3600 )
local day = math.floor ( seconds /86400 )

if day > 0 then table.insert( results, day .. ( day == 1 and " day" or " days" ) ) end
if hou > 0 then table.insert( results, hou .. ( hou == 1 and " hour" or " hours" ) ) end
if min > 0 then table.insert( results, min .. ( min == 1 and " minute" or " minutes" ) ) end
if sec > 0 then table.insert( results, sec .. ( sec == 1 and " second" or " seconds" ) ) end

return string.reverse ( table.concat ( results, ", " ):reverse():gsub(" ,", " dna ", 1 ) )
end
return ""
end
</syntaxhighlight>
'''Original Author: MrTasty | Remade by FusioN_'''

==Example==
<section name="Server-Side Script" class="server" show="true">
in this example we will add the command '''/stt seconds''' that will show in the chat a user-friendly time description for the command parameter ''seconds''.
<syntaxhighlight lang="lua">
function stt ( thePlayer, command, seconds ) -- create the function
if ( seconds and tonumber(seconds) ) then -- if the player entered a number (which will be the seconds)
outputChatBox ( secondsToTimeDesc ( tonumber ( seconds ) ), thePlayer, 0, 255, 0 )
else -- otherwise, alert him
outputChatBox ( "Use: /stt [seconds] !", thePlayer, 255, 0, 0 )
end
end
addCommandHandler ( "stt", stt, false, false )
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

OnClientSoundBeat

2015-02-16T13:24:07Z

FuSioN:

{{Client event}}
{{Needs Example}}
__NOTOC__
{{New feature|3.0131|1.3.1|
This event is triggered when a '''sound''' beats.
}}
{{Note|This event does not work correctly pre 1.3.1-9-04627
}}
{{Note|This event is triggered ahead of a sound beat the number passed is the play time at which the beat occurs
}}
==Parameters==
<syntaxhighlight lang="lua">
double theTime
</syntaxhighlight>

*'''theTime''': the position in the song of the beat

==Source==
The [[event system#Event source|source]] of this event is the [[Element/Sound|sound's element]].

==Example==
<syntaxhighlight lang="lua">
-- Not done yet
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04162}}

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

GetPlayerMapBoundingBox

2015-02-16T01:41:21Z

FuSioN:

__NOTOC__
{{Client function}}
{{Needs Example}}
This function gets the GUI bounding box of the radar map texture.

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

===Returns===
* If the player's map is showing, it returns four integers: ''minX'', ''minY'', ''maxX'', ''maxY''. These are '''absolute''' position coordinates of where the player's map is drawn on the screen
** ''minX,minY'' represent the world coordinate ''-3000,-3000''
** ''maxX,maxY'' represent the world coordinate ''3000,3000''.
** Negative values may be returned if these coordinates are off screen.
* If the map was not showing, a ''false'' boolean value is returned.

==Example==
<syntaxhighlight lang="lua">
--Needs an example
</syntaxhighlight>

==See Also==
{{Client player functions}}

SetVehicleComponentVisible

2015-02-13T22:33:32Z

FuSioN: /* Example */

__NOTOC__
{{Client function}}

{{New feature/item|3.0131|1.3.1|4715|
This function sets component visibility for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentVisible ( vehicle theVehicle, string theComponent, bool visible )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component visibility of.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
*'''visible:''' a ''bool'' which determines if the component should be visible

===Returns===
Returns a ''bool'' indicating the visible state of the component.

==Example==
'''Example 1:''' This example hide all components when you enter a vehicle.
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
function()
local getComponent = getVehicleComponents(source) -- get a table with all the components of the vehicle
for k in pairs (getComponent) do
setVehicleComponentVisible(source, k, false) -- hides the component
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

SetVehicleComponentVisible

2015-02-13T22:33:09Z

FuSioN:

__NOTOC__
{{Client function}}

{{New feature/item|3.0131|1.3.1|4715|
This function sets component visibility for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentVisible ( vehicle theVehicle, string theComponent, bool visible )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component visibility of.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
*'''visible:''' a ''bool'' which determines if the component should be visible

===Returns===
Returns a ''bool'' indicating the visible state of the component.

==Example==
'''Example 1:''' This example hide all components when you enter a vehicle.
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
function()
local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
for k in pairs (getComponent) do
setVehicleComponentVisible(source, k, false) -- hides the component
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetScreenFromWorldPosition

2015-02-13T22:28:35Z

FuSioN: Added example

__NOTOC__
{{Client function}}
This function gets the screen position of a point in the world. This is useful for attaching 2D gui elements to parts of the world (e.g. players) or detecting if a point is on the screen (though it does not check if it is actually visible, you should use [[processLineOfSight]] for that).

==Syntax==
<syntaxhighlight lang="lua">
float float getScreenFromWorldPosition ( float x, float y, float z, [ float edgeTolerance=0, bool relative=true ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float value indicating the x position in the world.
*'''y:''' A float value indicating the y position in the world.
*'''z:''' A float value indicating the z position in the world.

===Optional Arguments===
{{OptionalArg}}
{{New feature/item|3|1.0||
*'''edgeTolerance:''' A [[float]] value indicating the distance the position can be off screen before the function returns false.
*'''relative:''' A [[boolean]] value that indicates if edgeTolerance is in pixels [false], or relative to the screen size [true].
}}

===Returns===
Returns two ''x'', ''y'' [[float]]s indicating the screen position and [[float]] distance between screen and given position if successful, ''false'' otherwise.

===Example===
<section class="client" name="Client-side Script" show="true">
This example add a '3d' text at coordinates 0, 0, 0 (center of map).
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ( )
if ( getDistanceBetweenPoints3D ( 0, 0, 3, getElementPosition ( localPlayer ) ) ) < 50 then
local coords = { getScreenFromWorldPosition ( 0, 0, 3 ) }
if coords[1] and coords[2] then
dxDrawText ( "Hello !", coords[1], coords[2], coords[1], coords[2], tocolor(255,255,255), 1, "default-bold" )
end
end
end )
</syntaxhighlight>
</section>

==See Also==
{{Client_world_functions}}

SecondsToTimeDesc

2015-02-13T22:12:57Z

FuSioN: Function remade and example added

{{Useful Function}}
__NOTOC__
This function converts plain seconds-integer into a user-friendly time description.

==Syntax==
<syntaxhighlight lang="lua">string secondsToTimeDesc ( int seconds )</syntaxhighlight>

===Required Arguments===
* '''seconds''': The integer of seconds to convert into a user-friendly description.

===Returns===
Returns a user-friendly-description, or an empty string if the seconds were invalid/negative.

==Code==
<section name="Client- and/or serverside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function secondsToTimeDesc ( seconds )
if seconds then
local results = {}
local hours = ( math.floor( seconds / 3600 ) == 24 and 0 or math.floor( seconds / 3600 ) )
local days = math.floor ( ( seconds /86400) - hours )
local mins = math.floor( ( seconds - ( ( math.floor( seconds / 3600 ) )*3600 ) ) / 60)
local secs = math.floor( seconds % 60 )

local daysF = days > 0 and table.insert ( results, days .. ( days == 1 and " day" or " days" ) )
local hoursF = hours > 0 and table.insert ( results, hours .. ( hours == 1 and " hour" or " hours" ) )
local minsF = mins > 0 and table.insert ( results, mins .. ( mins == 1 and " minute" or " minutes" ) )
local secsF = secs > 0 and table.insert ( results, secs .. ( secs == 1 and " second" or " seconds" ) )
return table.concat ( results, ", " ):reverse():gsub((", "):reverse(), (" and "):reverse(), 1):reverse()
end
return ""
end
</syntaxhighlight>
</section>
'''Original Author: MrTasty | Remade by FusioN_'''

==Example==
<section name="Server-Side Script" class="server" show="true">
in this example we will add the command '''/stt seconds''' that will show in the chat a user-friendly time description for the command parameter ''seconds''.
<syntaxhighlight lang="lua">
function stt ( thePlayer, command, seconds ) -- create the function
if ( seconds and tonumber(seconds) ) then -- if the player entered a number (which will be the seconds)
outputChatBox ( secondsToTimeDesc ( tonumber ( seconds ) ), thePlayer, 0, 255, 0 )
else -- otherwise, alert him
outputChatBox ( "Use: /stt [seconds] !", thePlayer, 255, 0, 0 )
end
end
addCommandHandler ( "stt", stt, false, false )
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

GetVehicleComponents

2015-01-31T13:29:05Z

FuSioN:

__NOTOC__
{{Client function}}
{{New feature/item|3.0131|1.3.1|4748|
This function gets a table of the components currently on a [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleComponents ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get the components of.

===Returns===
Returns a ''table'' containing the name of the component as the key and visibility flag of that component as the value

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler ( "gvc",
function ( )
local theVehicle = getPedOccupiedVehicle ( localPlayer )
if ( theVehicle ) then
for k in pairs ( getVehicleComponents ( theVehicle ) ) do
outputChatBox ( k )
end
end
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example draw all components names on the player screen.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function()
if isPedInVehicle ( localPlayer ) and getPedOccupiedVehicle ( localPlayer ) then
local veh = getPedOccupiedVehicle ( localPlayer )
for v in pairs ( getVehicleComponents(veh) ) do
local x,y,z = getVehicleComponentPosition ( veh, v, "world" )
local wx,wy,wz = getScreenFromWorldPosition ( x, y, z )
if wx and wy then
dxDrawText ( v, wx -1, wy -1, 0 -1, 0 -1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, wx +1, wy -1, 0 +1, 0 -1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, wx -1, wy +1, 0 -1, 0 +1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, wx +1, wy +1, 0 +1, 0 +1, tocolor(0,0,0), 1, "default-bold" )
dxDrawText ( v, wx, wy, 0, 0, tocolor(0,255,255), 1, "default-bold" )
end
end
end
end)
</syntaxhighlight>
by '''FusioN'''.
</section>

==See Also==
{{Client_vehicle_functions}}

IsSoundFinished

2015-01-14T17:37:23Z

FuSioN: /* Example */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if sound finish.

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

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

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

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isSoundFinished(theSound)
return ( getSoundPosition(theSound) == getSoundLength(theSound) )
end
</syntaxhighlight>
</section>
'''Function created by WASSIm.'''

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

==See Also==
{{Useful_Functions}}

IsSoundFinished

2015-01-14T17:37:09Z

FuSioN: /* Code */

SetVehicleComponentVisible

2015-01-14T17:36:40Z

FuSioN: /* Example */

__NOTOC__
{{Client function}}

{{New feature/item|3.0131|1.3.1|4715|
This function sets component visibility for [[vehicle]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleComponentVisible ( vehicle theVehicle, string theComponent, bool visible )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to set component visibility of.
*'''theComponent:''' A vehicle component (this is the frame name from the model file of the component you wish to modify)
*'''visible:''' a ''bool'' which determines if the component should be visible

===Returns===
Returns a ''bool'' indicating the visible state of the component.

==Example==
'''Example 1:''' This example gets all the component and then hides them when you get into a vehicle.
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter", getRootElement(),
function()
local getComponent = getVehicleComponents(source) -- returns table with all the components of the vehicle
for k in pairs (getComponent) do
setVehicleComponentVisible(source, k, false) -- hides the component
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

IsSoundFinished

2014-12-17T01:10:58Z

FuSioN:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function check if sound finish.

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

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

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

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function isSoundFinished(theSound)
return ( getSoundPosition(theSound) == getSoundLength(theSound) )
end
</syntaxhighlight>
</section>
'''Function created by WASSIm. Edited by FuSioN'''

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

'''Author:''' WASSIm.

==See Also==
{{Useful_Functions}}