Multi Theft Auto: Wiki - User contributions [en]

GetValidPedModels

2018-02-13T11:48:24Z

MaK$iM: /* Example */

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

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

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

==Example==
This example will get if the specified skin is a valid skin or not.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function isValidSkin( thePlayer, command, specifiedSkin ) -- Define the function
if ( specifiedSkin ) then -- If skin specified
local allSkins = getValidPedModels ( ) -- Get valid skin IDs
local result = false -- Define result, it is currently false
for key, skin in ipairs( allSkins ) do -- Check all skins
if skin == tonumber( specifiedSkin ) then -- If skin equals specified one, it is valid
result = skin -- So set it as result
break --stop looping through a table after we found the skin
end
end
if ( result ) then -- If we got results
outputChatBox( result .. " is a valid skin ID.", thePlayer, 0, 255, 0 ) -- It is valid, output it
else -- If we didn't get results
outputChatBox( specifiedSkin .. " is not a valid skin ID.", thePlayer, 0, 255, 0 ) -- No result, it is not valid
end
else -- If no skin specified
outputChatBox( "Please specify a skin ID to check!", thePlayer, 255, 0, 0 ) -- Tell it to the player
end
end
addCommandHandler("checkskin",isValidSkin) -- bind 'checkskin' command to 'isValidSkin' function
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

[[pl:GetValidPedModels]]

GetPedCameraRotation

2018-02-13T10:48:52Z

MaK$iM: /* Example */

__NOTOC__
{{client function}}
{{Note|The camera rotation angle returned by this function is 360º - α (where α is the actual camera rotation angle). See example to know how to deal with this.}}
This function gets the current camera rotation of a [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
float getPedCameraRotation( ped thePed )
</syntaxhighlight>
{{OOP||[[ped]]:getCameraRotation|cameraRotation|setPedCameraRotation}}

===Required Arguments===
*'''thePed:''' the [[ped]] to retrieve the camera rotation of.

===Returns===
Returns the camera rotation of the [[ped]] in degrees if successful. Returns ''false'' if an invalid element was passed.

==Example==
This example creates a '''/getrotation''' command which outputs the expected camera rotation of the player which types it.
<syntaxhighlight lang="lua">
addCommandHandler( "getrotation",
function ()
local rot = 360 - getPedCameraRotation(localPlayer) -- Also fix the camera rotation
outputChatBox("Your camera rotation is " .. rot .. "º", 0, 225, 0)
end
)
</syntaxhighlight>

==See Also==
{{Client ped functions}}

SetVehiclesLODDistance

2017-07-17T12:19:40Z

MaK$iM:

{{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===
*'''trainsAndPlanesDistance:''' distance used for trains and planes, this value is clamped to 0 – 500

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

==See Also==
* [[engineGetModelLODDistance]]
* [[engineSetModelLODDistance]]
{{World functions}}

SetVehiclesLODDistance

2017-07-17T12:16:17Z

MaK$iM: Example

{{Client function}}{{Needs Example}}__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===
*'''trainsAndPlanesDistance:''' distance used for trains and planes, this value is clamped to 0 – 500

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

==See Also==
* [[engineGetModelLODDistance]]
* [[engineSetModelLODDistance]]
{{World functions}}

GetVehiclesLODDistance

2017-07-16T11:48:53Z

MaK$iM:

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

==Syntax==
<syntaxhighlight lang="lua">
float, float getVehiclesLODDistance ( )
</syntaxhighlight>

== Returns ==
* '''float:''' general distance used for most vehicles
* '''float:''' distance used for trains and planes

==Example==
This example shows the lod distance of vehicles
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart",resourceRoot,function()
local vehicles,planes_trains = getVehiclesLODDistance()
outputChatBox("general distance of most vehicles: "..math.floor(vehicles),0,255,0)
outputChatBox("distance of planes and trains: "..math.floor(planes_trains),0,255,0)
end)
</syntaxhighlight>

==See Also==
* [[engineGetModelLODDistance]]
* [[engineSetModelLODDistance]]
{{World functions}}

GetVehiclesLODDistance

2017-07-16T11:47:54Z

MaK$iM:

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

==Syntax==
<syntaxhighlight lang="lua">
float, float getVehiclesLODDistance ( )
</syntaxhighlight>

== Returns ==
* '''float:''' general distance used for most vehicles
* '''float:''' distance used for trains and planes

==Example==
This example shows the lod distance of vehicles
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart",resourceRoot,function()
local vehicles,planes_trains = getVehiclesLODDistance()
outputChatBox("general distance of most vehicles: "..math.floor(vehicles),0,255,0)
outputChatBox("distance of planes and trains: "..math.floor(planes_trains),0,255,0)
end)
</syntaxhighlight>

==See Also==
* [[engineGetModelLODDistance]]
* [[engineSetModelLODDistance]]
{{World functions}}

GetVehiclesLODDistance

2017-07-16T11:30:56Z

MaK$iM:

GetVehiclesLODDistance

2017-07-16T11:30:04Z

MaK$iM:

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

==Syntax==
<syntaxhighlight lang="lua">
float, float getVehiclesLODDistance ( )
</syntaxhighlight>

== Returns ==
* '''float:''' general distance used for most vehicles
* '''float:''' distance used for trains and planes

==Example==
This example shows the LOD distance of vehicles, helicopters and trains when the client resource started
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart",resourceRoot,function()
local vehicle,planes_trains = getVehiclesLODDistance()
outputChatBox("LOD Distance of Vehicles: "..math.floor(vehicle),0,255,0)
outputChatBox("LOD Distance of Planes and Trains: "..math.floor(planes_trains),0,255,0)
end)
</syntaxhighlight>

==See Also==
* [[engineGetModelLODDistance]]
* [[engineSetModelLODDistance]]
{{World functions}}

GuiGridListGetSelectedItems

2017-07-14T11:05:05Z

MaK$iM:

{{Client function}}
__NOTOC__
This function returns the items selected in the specified [[Element/GUI/Gridlist|grid list]].

==Syntax==
<syntaxhighlight lang="lua">
table guiGridListGetSelectedItems ( element gridList )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The [[Element/GUI/Gridlist|grid list]] which selected items you want to retrieve.

===Returns===
Returns a table over the selected items in the [[Element/GUI/Gridlist|grid list]] in this format:
<syntaxhighlight lang="lua">
table = {
[1] = {
["column"], -- has the first selected item's column ID
["row"] -- has the first selected item's row ID
},
[2] = {
["column"],-- has the second selected item's column ID
["row"] -- has the second selected item's row ID
},
...
}

</syntaxhighlight>
if everything was successful or ''false'' if invalid arguments were passed.

==Example==
<syntaxhighlight lang="lua">
--Vladislav_Nenakhov
--Create window
playerWindow = guiCreateWindow(526, 230, 291, 284, "", false)
guiWindowSetSizable(playerWindow, false)

gridlistPlayers = guiCreateGridList(9, 23, 272, 201, false, playerWindow)
guiGridListAddColumn(gridlistPlayers, "Players", 0.9)
for _, players in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow(gridlistPlayers)
guiGridListSetItemText(gridlistPlayers, row, 1, getPlayerName(players), false, false)
end
buttonSelectedPlayer = guiCreateButton(9, 227, 272, 20, "Selected", false, playerWindow)

-- Gui click
addEventHandler("onClientGUIClick", getRootElement(), function()
if source == buttonSelectedPlayer then
if #guiGridListGetSelectedItems(gridlistPlayers) > 0 then
outputChatBox("Yes")
else
outputChatBox("No")
end
end
end)
</syntaxhighlight>

==See Also==
{{GUI functions}}

GetVehicleGravity

2017-07-12T11:41:48Z

MaK$iM: /* Example */

__NOTOC__
{{Client function}}

Retrieves the current gravity vector of a vehicle. This is the direction in which the vehicle falls, also the cameras of any passengers will be rotated to match it.

==Syntax==
<syntaxhighlight lang="lua">float float float getVehicleGravity ( vehicle theVehicle )</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the vehicle to retrieve the gravity vector of.

===Returns===
Returns the x, y and z components of the gravity vector if successful, ''false'' otherwise.

==Example==
This command will get gravity of your vehicle and output to chat using the /grav command
<syntaxhighlight lang="lua">
addCommandHandler("grav",function()
local vehicle = getPedOccupiedVehicle(localPlayer)
if (vehicle) then
local x,y,z = getVehicleGravity(vehicle)
outputChatBox("Your vehicle's gravity is: "..x.." "..y.." "..z,0,255,0)
end
end)
</syntaxhighlight>

==See Also==
{{Client vehicle functions}}

GetVehicleGravity

2017-07-12T11:39:43Z

MaK$iM:

__NOTOC__
{{Client function}}

Retrieves the current gravity vector of a vehicle. This is the direction in which the vehicle falls, also the cameras of any passengers will be rotated to match it.

==Syntax==
<syntaxhighlight lang="lua">float float float getVehicleGravity ( vehicle theVehicle )</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the vehicle to retrieve the gravity vector of.

===Returns===
Returns the x, y and z components of the gravity vector if successful, ''false'' otherwise.

==Example==
This command will get gravity of your vehicle using the /grav command
<syntaxhighlight lang="lua">
addCommandHandler("grav",function()
local vehicle = getPedOccupiedVehicle(localPlayer)
if (vehicle) then
local x,y,z = getVehicleGravity(vehicle)
outputChatBox("Your vehicle's gravity is: "..x.." "..y.." "..z,0,255,0)
end
end)
</syntaxhighlight>
==See Also==
{{Client vehicle functions}}

GetVehicleGravity

2017-07-12T11:39:28Z

MaK$iM:

__NOTOC__
{{Client function}}

Retrieves the current gravity vector of a vehicle. This is the direction in which the vehicle falls, also the cameras of any passengers will be rotated to match it.

==Syntax==
<syntaxhighlight lang="lua">float float float getVehicleGravity ( vehicle theVehicle )</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the vehicle to retrieve the gravity vector of.

===Returns===
Returns the x, y and z components of the gravity vector if successful, ''false'' otherwise.

==Example
This command will get gravity of your vehicle using the /grav command
<syntaxhighlight lang="lua">
addCommandHandler("grav",function()
local vehicle = getPedOccupiedVehicle(localPlayer)
if (vehicle) then
local x,y,z = getVehicleGravity(vehicle)
outputChatBox("Your vehicle's gravity is: "..x.." "..y.." "..z,0,255,0)
end
end)
</syntaxhighlight>
==See Also==
{{Client vehicle functions}}

SetVehicleGravity

2017-07-12T11:29:07Z

MaK$iM:

__NOTOC__
{{Client function}}

Sets the gravity vector of a vehicle. The vehicle will fall in this direction, and the camera of any occupants will also be rotated to match it. Can be used for e.g. driving on walls or upside down on ceilings.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleGravity ( vehicle theVehicle, float x, float y, float z )</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the vehicle of which to change the gravity.
*'''x, y, z:''' the components of the new gravity vector. If this vector has length 1, the strength of the gravity will be same as the global gravity for other entities. If it is 2, it will be twice as strong, etc.

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

===Example===
This example will set 0 gravity to the vehicle if a local player enters it
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter",getRootElement(),function(thePlayer)
if (thePlayer == localPlayer) then -- if thePlayer is localPlayer
local gravity = setVehicleGravity(source,0,0,0) -- Set the gravity
if (gravity) then -- If the gravity was set succesfully
local gravity_pos = Vector3(getVehicleGravity(source)) -- get the gravity vector
outputChatBox("Gravity was set to "..gravity_pos.x.." "..gravity_pos.y.." "..gravity_pos.z,0,255,0) -- output to chat
end
end
end)
</syntaxhighlight>
==See Also==
{{Client vehicle functions}}

SetVehicleGravity

2017-07-12T11:28:26Z

MaK$iM:

__NOTOC__
{{Client function}}
{{Needs Example}}

Sets the gravity vector of a vehicle. The vehicle will fall in this direction, and the camera of any occupants will also be rotated to match it. Can be used for e.g. driving on walls or upside down on ceilings.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleGravity ( vehicle theVehicle, float x, float y, float z )</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' the vehicle of which to change the gravity.
*'''x, y, z:''' the components of the new gravity vector. If this vector has length 1, the strength of the gravity will be same as the global gravity for other entities. If it is 2, it will be twice as strong, etc.

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

===Example===
This example will set 0 gravity to the vehicle if a local player enters it
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleEnter",getRootElement(),function(thePlayer)
if (thePlayer == localPlayer) then -- if thePlayer is localPlayer
local gravity = setVehicleGravity(source,0,0,0) -- Set the gravity
if (gravity) then -- If the gravity was set succesfully
local gravity_pos = Vector3(getVehicleGravity(source)) -- get the gravity vector
outputChatBox("Gravity was set to "..gravity_pos.x.." "..gravity_pos.y.." "..gravity_pos.z,0,255,0) -- output to chat
end
end
end)
</syntaxhighlight>
==See Also==
{{Client vehicle functions}}

GuiMemoGetCaretIndex

2017-07-12T09:40:54Z

MaK$iM:

{{Client function}}
__NOTOC__
{{New feature/item|3.0135|1.3.5|6054|
This function returns the caret (the text cursor) position within the memo box.
}}

==Syntax==
<syntaxhighlight lang="lua">
int guiMemoGetCaretIndex ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The memo box you want to get the caret position from

===Returns===
Returns the caret index on success, ''false'' otherwise.

==Example==
This example outputs the caret position of the memo to the chat
<syntaxhighlight lang="lua">
local memo = guiCreateMemo(0.4,0.1,0.3,0.3,"",true)

addEventHandler("onClientGUIChanged",memo,function()
outputChatBox("Caret index is: "..guiMemoGetCaretIndex(memo)) -- output index to chat
end)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoGetCaretIndex

2017-07-12T09:40:32Z

MaK$iM: /* Example */

{{Client function}}
{{Needs Example}}
__NOTOC__
{{New feature/item|3.0135|1.3.5|6054|
This function returns the caret (the text cursor) position within the memo box.
}}

==Syntax==
<syntaxhighlight lang="lua">
int guiMemoGetCaretIndex ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The memo box you want to get the caret position from

===Returns===
Returns the caret index on success, ''false'' otherwise.

==Example==
This example outputs the caret position of the memo to the chat
<syntaxhighlight lang="lua">
local memo = guiCreateMemo(0.4,0.1,0.3,0.3,"",true)

addEventHandler("onClientGUIChanged",memo,function()
outputChatBox("Caret index is: "..guiMemoGetCaretIndex(memo)) -- output index to chat
end)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GetMinuteDuration

2017-07-12T09:32:52Z

MaK$iM:

__NOTOC__
{{Server client function}}
Tells you how long an ingame minute takes in real-world milliseconds. The default GTA value is 1000.

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

===Required Arguments===
''None''

===Returns===
Returns the number of real-world milliseconds that go in an ingame minute.

===Example===
This example prints the server's minute duration
<syntaxhighlight lang="lua">
addCommandHandler("duration",function()
outputChatBox("minute duration is :"..getMinuteDuration())
end)
</syntaxhighlight>

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

GetMinuteDuration

2017-07-12T09:32:35Z

MaK$iM:

__NOTOC__
{{Server client function}}
{{Needs Example}}
Tells you how long an ingame minute takes in real-world milliseconds. The default GTA value is 1000.

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

===Required Arguments===
''None''

===Returns===
Returns the number of real-world milliseconds that go in an ingame minute.

===Example===
This example prints the server's minute duration
<syntaxhighlight lang="lua">
addCommandHandler("duration",function()
outputChatBox("minute duration is :"..getMinuteDuration())
end)
</syntaxhighlight>

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

IsAmbientSoundEnabled

2017-07-12T09:13:42Z

MaK$iM:

__NOTOC__
{{Client function}}
This function allows you to check if some background sound effects are enabled.

==Syntax==
<syntaxhighlight lang="lua">
bool isAmbientSoundEnabled( string theType )
</syntaxhighlight>

===Required Arguments===
*'''theType:''' The type of ambient sound to test. Can be either "gunfire" or "general".

===Returns===
Returns ''true'' if the ambient sound is enabled, ''false'' if it is disabled or invalid values were passed.

===Example===
This command checks if the type of ambient sound is enabled or not.
/check <type>
<syntaxhighlight lang="lua">
addCommandHandler("check",function(_,_type)
if isAmbientSoundEnabled(_type) then
outputChatBox(_type.." is enabled!",0,255,0)
else
outputChatBox(_type.." is disabled!",255,0,0)
end
end)
</syntaxhighlight>

==See Also==
{{Client world functions}}

IsAmbientSoundEnabled

2017-07-12T09:13:18Z

MaK$iM:

__NOTOC__
{{Client function}}
{{Needs Example}}
This function allows you to check if some background sound effects are enabled.

==Syntax==
<syntaxhighlight lang="lua">
bool isAmbientSoundEnabled( string theType )
</syntaxhighlight>

===Required Arguments===
*'''theType:''' The type of ambient sound to test. Can be either "gunfire" or "general".

===Returns===
Returns ''true'' if the ambient sound is enabled, ''false'' if it is disabled or invalid values were passed.

===Example===
This command checks if the type of ambient sound is enabled or not.
/check <type>
<syntaxhighlight lang="lua">
addCommandHandler("check",function(_,_type)
if isAmbientSoundEnabled(_type) then
outputChatBox(_type.." is enabled!",0,255,0)
else
outputChatBox(_type.." is disabled!",255,0,0)
end
end)
</syntaxhighlight>

==See Also==
{{Client world functions}}

GetDevelopmentMode

2017-07-11T23:37:50Z

MaK$iM:

__NOTOC__
{{Server client function}}

This function is used to get the development mode of the client. For more information see [[setDevelopmentMode]]

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

===Returns===
Returns ''true'' if the development mode is on, ''false'' if off.

==Example==
<section name="Client" class="client" show="true">
This command enables / disables the development mode
<syntaxhighlight lang="lua">
addCommandHandler("dev",function()
local boolean = not getDevelopmentMode() -- true/false
setDevelopmentMode(boolean)
outputChatBox("DevelopmentMode: "..tostring(boolean))
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.4-9.11305|1.1.1-9.03355|}}

==See Also==
{{Client_utility_functions}}

[[pl:GetDevelopmentMode]]

GetDevelopmentMode

2017-07-11T22:50:47Z

MaK$iM: /* Example */

__NOTOC__
{{Server client function}}
{{Needs Example}}
This function is used to get the development mode of the client. For more information see [[setDevelopmentMode]]

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

===Returns===
Returns ''true'' if the development mode is on, ''false'' if off.

==Example==
<section name="Client" class="client" show="true">
This command enables / disables the development mode
<syntaxhighlight lang="lua">
addCommandHandler("dev",function()
local boolean = not getDevelopmentMode() -- true/false
setDevelopmentMode(boolean)
outputChatBox("DevelopmentMode: "..tostring(boolean))
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.4-9.11305|1.1.1-9.03355|}}

==See Also==
{{Client_utility_functions}}

[[pl:GetDevelopmentMode]]

GetDevelopmentMode

2017-07-11T22:50:30Z

MaK$iM: /* Returns */

__NOTOC__
{{Server client function}}
{{Needs Example}}
This function is used to get the development mode of the client. For more information see [[setDevelopmentMode]]

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

===Returns===
Returns ''true'' if the development mode is on, ''false'' if off.

==Example==
<section name="Client" class="client" show="true">
This ommand enables / disables the development mode
<syntaxhighlight lang="lua">
addCommandHandler("dev",function()
local boolean = not getDevelopmentMode() -- true/false
setDevelopmentMode(boolean)
outputChatBox("DevelopmentMode: "..tostring(boolean))
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.4-9.11305|1.1.1-9.03355|}}

==See Also==
{{Client_utility_functions}}

[[pl:GetDevelopmentMode]]

GetInteriorSoundsEnabled

2017-07-11T21:46:14Z

MaK$iM: /* Example */

__NOTOC__
{{Client function}}

This function checks to see if the music played by default in clubs is disabled or not.

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

==Returns==
Returns true if music is playing, returns false if music is not playing.

==Example==
Command check_sounds checks if the interior sounds enabled or not
<syntaxhighlight lang="lua">
addCommandHandler("check_sounds",
function()
if getInteriorSoundsEnabled() then
outputChatBox("Interior sounds are enabled!!!",0,255,0)
else
outputChatBox("Interior sounds are disabled!!!",255,0,0)
end
end)
</syntaxhighlight>

==See Also==
{{Client world functions}}

GetInteriorSoundsEnabled

2017-07-11T21:46:01Z

MaK$iM: /* Example */

__NOTOC__
{{Client function}}

This function checks to see if the music played by default in clubs is disabled or not.

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

==Returns==
Returns true if music is playing, returns false if music is not playing.

==Example==
Command check_sound checks if the interior sounds enabled or not
<syntaxhighlight lang="lua">
addCommandHandler("check_sounds",
function()
if getInteriorSoundsEnabled() then
outputChatBox("Interior sounds are enabled!!!",0,255,0)
else
outputChatBox("Interior sounds are disabled!!!",255,0,0)
end
end)
</syntaxhighlight>

==See Also==
{{Client world functions}}

GetInteriorSoundsEnabled

2017-07-11T21:35:48Z

MaK$iM: /* Example */

__NOTOC__
{{Client function}}
{{Needs Example}}

This function checks to see if the music played by default in clubs is disabled or not.

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

==Returns==
Returns true if music is playing, returns false if music is not playing.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("check_sounds",
function()
if getInteriorSoundsEnabled() then
outputChatBox("Interior sounds are enabled!!!",0,255,0)
else
outputChatBox("Interior sounds are disabled!!!",255,0,0)
end
end)
</syntaxhighlight>

==See Also==
{{Client world functions}}

GetInteriorSoundsEnabled

2017-07-11T20:28:51Z

MaK$iM: /* Example */

GetInteriorSoundsEnabled

2017-07-11T20:27:42Z

MaK$iM: /* Returns */

GuiEditGetCaretIndex

2017-07-11T18:00:09Z

MaK$iM: /* Example */

{{Client function}}
{{Needs Example}}
__NOTOC__
{{New feature/item|3.0135|1.3.5|6054|
This function returns the caret (the text cursor) position within the editbox.
}}

==Syntax==
<syntaxhighlight lang="lua">
int guiEditGetCaretIndex ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The edit box you want to get the caret position from

===Returns===
Returns the caret index on success, ''false'' otherwise.

==Example==
This example outputs the caret position of the edit field to the chat
<syntaxhighlight lang="lua">
local edit = guiCreateEdit(0.4,0.4,0.3,0.1,"",true)

addEventHandler("onClientGUIChanged",edit,function()
outputChatBox("Caret index is: "..guiEditGetCaretIndex(edit)) -- output index to chat
end)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiScrollBarSetScrollPosition

2017-07-11T13:21:03Z

MaK$iM: /* Example */

{{client function}}
{{Needs Example}}
This function is used to set the scroll amount of a scrollbar as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
bool guiScrollBarSetScrollPosition ( gui-scrollBar theScrollBar, float amount )
</syntaxhighlight>

===Required Arguments===
*'''theScrollBar''': The scrollbar you want to change the progress of
*'''amount''': a float ranging from 0 - 100 representing the amount you wish to set the scroll bar.

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

==Example==
In this example, you can set the scrolling position using the command /pos <amount>
<syntaxhighlight lang="lua">
local window = guiCreateWindow(0.3,0.3,0.3,0.3,"Scroll-Position",true)
local scroll_bar = guiCreateScrollBar(5,25,30,245,false,false,window)

function scroll_bar_setPos(_,position)
if (tonumber(position)) then -- If we have typed a position
guiScrollBarSetScrollPosition(scroll_bar,position) --Set the position in the scroll bar
end
end
addCommandHandler("pos",scroll_bar_setPos)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Catogory:Needs_Example]]

GuiScrollBarSetScrollPosition

2017-07-11T09:32:48Z

MaK$iM: /* Example */

{{client function}}
{{Needs Example}}
This function is used to set the scroll amount of a scrollbar as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
bool guiScrollBarSetScrollPosition ( gui-scrollBar theScrollBar, float amount )
</syntaxhighlight>

===Required Arguments===
*'''theScrollBar''': The scrollbar you want to change the progress of
*'''amount''': a float ranging from 0 - 100 representing the amount you wish to set the scroll bar.

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

==Example==

<syntaxhighlight lang="lua">
local window = guiCreateWindow(0.3,0.3,0.3,0.3,"Scroll-Position",true)
local scroll_bar = guiCreateScrollBar(5,25,30,245,false,false,window)

function scroll_bar_setPos(_,position)
if (tonumber(position)) then -- If we have typed a position
guiScrollBarSetScrollPosition(scroll_bar,position) --Set the position in the scroll bar
end
end
addCommandHandler("pos",scroll_bar_setPos)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Catogory:Needs_Example]]

GuiScrollBarSetScrollPosition

2017-07-11T08:46:23Z

MaK$iM: /* Example */

{{client function}}
{{Needs Example}}
This function is used to set the scroll amount of a scrollbar as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
bool guiScrollBarSetScrollPosition ( gui-scrollBar theScrollBar, float amount )
</syntaxhighlight>

===Required Arguments===
*'''theScrollBar''': The scrollbar you want to change the progress of
*'''amount''': a float ranging from 0 - 100 representing the amount you wish to set the scroll bar.

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

==Example==

<syntaxhighlight lang="lua">
local window = guiCreateWindow(0.3,0.3,0.3,0.3,"Scroll-Position",true)
local scroll_bar = guiCreateScrollBar(5,25,30,245,false,false,window)

function scroll_bar_setPos(_,position)
local position = tonumber(position)
if (position) then -- If we have typed a position
guiScrollBarSetScrollPosition(scroll_bar,position) --Set the position in the scroll bar
end
end
addCommandHandler("pos",scroll_bar_setPos)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Catogory:Needs_Example]]

GuiScrollBarSetScrollPosition

2017-07-11T08:45:54Z

MaK$iM: /* Example */

{{client function}}
{{Needs Example}}
This function is used to set the scroll amount of a scrollbar as a percentage.

==Syntax==
<syntaxhighlight lang="lua">
bool guiScrollBarSetScrollPosition ( gui-scrollBar theScrollBar, float amount )
</syntaxhighlight>

===Required Arguments===
*'''theScrollBar''': The scrollbar you want to change the progress of
*'''amount''': a float ranging from 0 - 100 representing the amount you wish to set the scroll bar.

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

==Example==
This page lacks an example
<syntaxhighlight lang="lua">
local window = guiCreateWindow(0.3,0.3,0.3,0.3,"Scroll-Position",true)
local scroll_bar = guiCreateScrollBar(5,25,30,245,false,false,window)

function scroll_bar_setPos(_,position)
local position = tonumber(position)
if (position) then -- If we have typed a position
guiScrollBarSetScrollPosition(scroll_bar,position) --Set the position in the scroll bar
end
end
addCommandHandler("pos",scroll_bar_setPos)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Catogory:Needs_Example]]