Multi Theft Auto: Wiki - User contributions [en]

Ban

2009-02-10T23:13:03Z

Twig: fixed fix of typo fix

A [[ban]] is a pointer that represents a banned player arbitrarily. The following functions allow interaction with a [[ban]]:
{{New feature|3|1.0|
*[[addBan]]
*[[getBans]]
*[[getBanAdmin]]
*[[getBanIP]]
*[[getBanReason]]
*[[getBanSerial]]
*[[getBanTime]]
*[[getBanUsername]]
*[[removeBan]]
}}
*[[banPlayer]]

[[Category:Scripting Concepts]]

TextDisplayIsObserver

2009-02-10T23:07:41Z

Twig:

__NOTOC__
{{Server function}}
This function checks if a player can see the specified [[textdisplay]].

==Syntax==
<syntaxhighlight lang="lua">bool textDisplayIsObserver ( textdisplay display, player player )</syntaxhighlight>

===Required Arguments===

* '''display''': The [[textdisplay]].
* '''player''': The [[player]].

===Returns===
Return true if [[textdisplay]] is showing, or false if not.
==Example==
<syntaxhighlight lang="lua">
-- Example
</syntaxhighlight>

==See Also==
{{Text functions}}

TextDisplayIsObserver

2009-02-10T23:07:27Z

Twig:

__NOTOC__
{{Server function}}
This functions checks if a player can see the specified [[textdisplay]].

==Syntax==
<syntaxhighlight lang="lua">bool textDisplayIsObserver ( textdisplay display, player player )</syntaxhighlight>

===Required Arguments===

* '''display''': The [[textdisplay]].
* '''player''': The [[player]].

===Returns===
Return true if [[textdisplay]] is showing, or false if not.
==Example==
<syntaxhighlight lang="lua">
-- Example
</syntaxhighlight>

==See Also==
{{Text functions}}

SetPedHeadless

2009-01-01T09:50:48Z

Twig: amended arguement description so that it makes sense

__NOTOC__
{{Client function}}
With this function, you can set if a ped has a head or not.
==Syntax==
<syntaxhighlight lang="lua">bool setPedHeadless ( ped thePed, bool headState )</syntaxhighlight>

===Required Arguments===
*'''thePed''': The [[ped]] to check.
*'''headState''': head state, use true if you want the ped be headless, use false to give back the head.

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

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

Template:Client collision shape functions

2008-12-28T18:15:43Z

Twig: amended polygon function

*[[createColCircle]]

*[[createColCuboid]]

*[[createColSphere]]

*[[createColRectangle]]

*[[createColTube]]

*[[createColPolygon]]

StopSound

2008-12-28T13:08:30Z

Twig: /* Example */

__NOTOC__
{{Client function}}
Stops the sound playback for specified [[sound]] element.

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

===Required Arguments===
*'''theSound:''' The [[sound]] element you want to stop playing.

===Returns===
Returns ''true'' if the sound was successfully stopped, ''false'' otherwise.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function startMySound()
sound = playSound( "sound.mp3", true )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), startMySound )

function stopMySound()
stopSound( sound )
end
addCommandHandler ( "stopsound", stopMySound ) --using the command 'stopsound' will stop the sound
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

StopSound

2008-12-28T13:07:49Z

Twig: /* Example */

__NOTOC__
{{Client function}}
Stops the sound playback for specified [[sound]] element.

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

===Required Arguments===
*'''theSound:''' The [[sound]] element you want to stop playing.

===Returns===
Returns ''true'' if the sound was successfully stopped, ''false'' otherwise.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function startMySound()
sound = playSound("sound.mp3", true)
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), startMySound)

function stopMySound()
stopSound( sound )
end
addCommandHandler ( "stopsound", stopMySound) --using the command 'stopsound' will stop the sound
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

PlaySound3D

2008-12-28T13:01:19Z

Twig: condensed example comment and amended the co-ords to 2 decimal places.

__NOTOC__
{{Client function}}
Creates a [[sound]] element in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created.

==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundName, float x, float y, float z, [ bool looped ] )</syntaxhighlight>

===Required Arguments===
*'''soundName:''' Name of the sound file you want to play. (Sound file has to be predefined in the client side [[meta.xml]] file with <file /> tags.)
*'''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}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.

===Returns===
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
-- This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), onResourceStart)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

PlaySound3D

2008-12-28T12:57:38Z

Twig:

__NOTOC__
{{Client function}}
Creates a [[sound]] element in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created.

==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundName, float x, float y, float z, [ bool looped ] )</syntaxhighlight>

===Required Arguments===
*'''soundName:''' Name of the sound file you want to play. (Sound file has to be predefined in the client side [[meta.xml]] file with <file /> tags.)
*'''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}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.

===Returns===
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14022827148, -125.21725463867, 1001, true) --play sounds/song.mp3 on loop for when a player enters a pizza shop so that when they get near the counter the volume is louder. (incase he gets bored of waiting for his pizza :p the pizza shop is in sf near pier 69)
end
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), onResourceStart)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

PlaySound

2008-12-28T12:54:06Z

Twig:

__NOTOC__
{{Client function}}
Creates a [[sound]] element and plays it immediately after creation for the local player.
==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundName, [ bool looped ] )</syntaxhighlight>

===Required Arguments===
*'''soundName:''' Name of the sound file you want to play. (Sound file has to be predefined in the client side [[meta.xml]] file with <file /> tags.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.

===Returns===
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

Element/Sound

2008-12-27T16:23:48Z

Twig: corrected wording, amended formatting to make clear the seperation between client audio functions and element functions.

The sound element represents a custom sound sent to the client via the use of the file parameter inside the meta file and created either by [[playSound]] or [[playSound3D]].

A sound element is created using [[playSound3D]] or [[playSound]] and can be manipulated with the following element functions:.

* [[setElementPosition]]

Sound elements can also be manipulated using the other [[Template:Client audio functions|Client audio functions]].

The element type of this class is '''"sound"'''.

==Related scripting functions==
===Client===
{{Client audio functions}}

SetSoundVolume

2008-12-26T19:56:43Z

Twig: /* Syntax */

__NOTOC__
{{Client function}}
Sets custom sound volume.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element sound, float volume )</syntaxhighlight>

===Required Arguments===
*'''sound:''' Name of the sound you want to change the volume of.
*'''volume:''' A float representing the desired volume.

===Returns===
Returns ''true'' if the sound volume was successfully changed, ''false'' otherwise.

==Example==
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>
</section>

==See Also==
{{audio functions}}

Help:Main Page

2008-11-15T11:46:10Z

Twig: removed support request, wrong place for this

Can you please add a link to the Italian main page(<nowiki>[[it:Pagina principale]]</nowiki>)? Thanks.<br/><span style="font-family:Courier New, Courier, monospace">[[User:Shadd|Shadd]]</span><sub>([[User_talk:Shadd|Сто?]])</sub> 11:49, 25 January 2008 (CST)
:Done :) Keep up the good work! [[User:EAi|eAi]] 20:06, 25 January 2008 (CST)

The Dutch one too please (<nowiki>[[nl:Main Page]]</nowiki>)? :P
:Done :) [[User:EAi|eAi]] 11:24, 26 January 2008 (CST)

<br/>
http://development.mtasa.com/index.php?title=Vehicle_Upgrades
There is no link in 'Vehicle Upgrades' in the 'ID list'. I already knew that there is this page, but unfortunately we can't modify this page... :( <br/> [[User:Atti|Atti]] 03:29, 27 January 2008 (CST)

Please add a Link to the German Translation. (DE/Hauptseite)

Same [[Introduction to Scripting the GUI|page]] is linked twice in the 'Getting started' section ('Introduction to Scripting the GUI' and 'Scripted GUI'). [[User:Awwu|Awwu]] 05:03, 25 May 2008 (CDT)

== Request ==

I have a request for the italian wiki: it's possible to do that the functions in the code tag that are in the italian pages link to the italian pages of the functions, and not to the english one? Can you create, if in need, a namespace for the italian(and other langueges of course)wiki?
Example:
<syntaxhighlight lang="lua">
addEventHandler("onGamemodeMapStart", g_root, loadMap)
</syntaxhighlight>
If you click on the function name you'll get the addEventHandler page, I want that if I click on it in the italian wiki i can go to IT/addEventHandler instead of addEventHandler. Thanks. --<span style="font-family:Courier New, Courier, monospace">[[User:Shadd|Shadd]]</span><sub>([[User_talk:Shadd|In caso di emergenza rompere le scatole]])</sub> 06:51, 5 June 2008 (CDT)

== Double link ==

Links to [[Introduction to Scripting the GUI]] and [[Scripted GUI]] redirect to one page. -- [[User:Divine|Divine]] 04:27, 15 June 2008 (CDT)

BanPlayer

2008-10-26T12:14:01Z

Twig: added further comment and moved addCommandHandler to make it's relation to banPlayerCommand more obvious

__NOTOC__
{{Server function}}
This function will ban the specified player from the server by IP.

==Syntax==
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement , string reason ] )
</syntaxhighlight>

===Required Arguments===
*'''bannedPlayer:''' The player that will be banned from the server

===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root: <syntaxhighlight lang="lua">getRootElement()</syntaxhighlight>
*'''reason:''' The reason the player will be banned from the server

===Returns===
Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified.

==Example==
This example lets a player ban anyone if he has ACL rights.
<syntaxhighlight lang="lua">
--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )

-- Give the player a nice error if he doesn't have rights
if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
--Get player element from the name
local bannedPlayer = getPlayerFromNick ( bannedName )

--Ban the player
banPlayer ( bannedPlayer, theClient, reason )
outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

else
outputChatBox ( "ban: You don't have enough permissions", theClient )
end

end
addCommandHandler ( "ban", banPlayerCommand )

-- Example function with the root element. Here you would pass a player element to the function.
function banCheater(theCheater)
banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end
</syntaxhighlight>

==See Also==
{{Admin_functions}}

BanPlayer

2008-10-26T12:11:06Z

Twig: spelling

__NOTOC__
{{Server function}}
This function will ban the specified player from the server by IP.

==Syntax==
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement , string reason ] )
</syntaxhighlight>

===Required Arguments===
*'''bannedPlayer:''' The player that will be banned from the server

===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root: <syntaxhighlight lang="lua">getRootElement()</syntaxhighlight>
*'''reason:''' The reason the player will be banned from the server

===Returns===
Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified.

==Example==
This example lets a player ban anyone if he has ACL rights.
<syntaxhighlight lang="lua">
--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )

-- Give the player a nice error if he doesn't have rights
if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
--Get player element from the name
local bannedPlayer = getPlayerFromNick ( bannedName )

--Ban the player
banPlayer ( bannedPlayer, theClient, reason )
outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

else
outputChatBox ( "ban: You don't have enough permissions", theClient )
end

end

-- Example with the root element.
function banCheater(theCheater)
banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end
addCommandHandler ( "ban", banPlayerCommand )
</syntaxhighlight>

==See Also==
{{Admin_functions}}

User:Twig

2008-10-18T10:46:38Z

Twig: /* Twig */

{| class="wikitable sortable" border="1" cellpadding="2" style="text-align:center"
!width="100"|Name
!width="50"|ID
!width="50"|X
!width="50"|Y
!width="50"|Z
!width="200"|Desc
!width="200"|SP
|-
|24/7 1 || 17 || -25.884499,-35.0952,-3.3979 || -185.868988,-188.7431,-167.9059 || 1003.549988,1002.5469,1008.7656 || Big - L-shaped - NO EXIT ||
|-
|24/7 2 || 10 || 6.091180,-13.1705,10.8973 || -29.271898,-32.5796,-73.7699 || 1003.549988,1002.5494,1008.8979 || Big - Oblong - NO EXIT ||
|-
|24/7 3 || 18 || -30.946699,-39.2296,-12.9542 || -89.609596,-92.6993,-73.7699 || 1003.549988,1002.5469,1008.9487 || Med - Square || Creek, LV
|-
|24/7 4 || 16 || -25.132599,-39.1961,-14.0429 || -139.066986,-142.2416,-122.4566 || 1003.549988,1002.5469,1008.3311 || Med - Square - NO EXIT ||
|-
|24/7 5 || 4 || -27.312300,-36.9258,-25.8106 || -29.277599,-32.1881,-1.8185 || 1003.549988,1002.5573,1009.0845 || Sml - Long || Mulholland
|-
|24/7 6 || 6 || -26.691599,-37.4347,-16.2656 || -55.714897,-58.9940,-48.4956 || 1003.549988,1002.5469,1008.7020 || Sml - Square || Whetstone
|-
|Francis Intn'l Airport - Ticket sales || 14 || -1827.147338 || 7.207418 || 1061.143554 || Francis Int. Airport (Front Exterior & Ticket Sales) || Starting Cutscene
|-
|Francis Intn'l Airport - Baggage claim || 14 || -1855.568725 || 41.263156 || 1061.143554 || Francis Int. Airport (Baggage Claim) || Starting Cutscene
|-
|Shamal cabin || 1 || 2.384830 || 33.103397 || 1199.849976 || Shamal plane interior where you fight with Mafia || Mission "Free Fall"
|-
|Andromada cargo hold || 9 || 315.856170 || 1024.496459 || 1949.797363 || Interior of the Andromeda Plane used in Area51 Break in || Mission "Stowaway"
|-
|Ammunation 1 || 1 || 286.148987 || -40.644398 || 1001.569946 || || Ocean Flats, SF
|-
|Ammunation 2 || 4 || 286.800995 || -82.547600 || 1001.539978 || || Palomino Creek, LV
|-
|Ammunation 3 || 6 || 296.919983 || -108.071999 || 1001.569946 || || Angel Pine, SF
|-
|Ammunation 4 || 7 || 314.820984 || -141.431992 || 999.661987 || 2 Stories, with Booth and Range ||
|-
|Ammunation 5 || 6 || 316.524994 || -167.706985 || 999.661987 || || El Quebrados, LV
|-
|Booth || 7 || 302.292877 || -143.139099 || 1004.062500 || Ammunation Booth from Ammunation 4 ||
|-
|Range || 7 || 280.795104 || -135.203353 || 1004.062500 || Ammunation Range from Ammunation 4 ||
|-
|House 1 || 3 || 235.508994 || 1189.169897 || 1080.339966 || Large/2 story/3 bedrooms/clone of House 9 ||
|-
|House 2 || 2 || 225.756989 || 1240.000000 || 1082.149902 || Medium/1 story/1 bedroom ||
|-
|House 3 || 1 || 223.043991 || 1289.259888 || 1082.199951 || Small/1 story/1 bedroom ||
|-
|House 4 || 7 || 225.630997 || 1022.479980 || 1084.069946 || VERY Large/2 story/4 bedrooms ||
|-
|House 5 || 15 || 295.138977 || 1474.469971 || 1080.519897 || Small/1 story/2 bedrooms ||
|-
|House 6 || 15 || 328.493988 || 1480.589966 || 1084.449951 || Small/1 story/2 bedrooms ||
|-
|House 7 || 15 || 385.803986 || 1471.769897 || 1080.209961 || Small/1 story/1 bedroom/NO BATHROOM! ||
|-
|Atrium || 18 || 1726.18 || -1641.00 || 20.23 || Located in LS, near LSPD || Mission "Just Business"
|-
|Big Smoke's Crack Palace || 2 || 2567.52 || -1294.59 || 1063.25 || Crack Laboratory || Mission "End of the Line", after that opened for visit
|-
|Bloodbowl Stadium || 15 || -1394.20 || 987.62 || 1023.96 || || Arena Mission "Bloodbowl"
|-
|Burning Desire House || 5 || 2338.32 || -1180.61 || 1027.98 || House from the mission, partly no textures even if solid. || Mission "Burning Desire"
|-
|Colonel Furhberger's || 8 || 2807.63 || -1170.15 || 1025.57 || House you rob during a mission || Mission "Home Invasion"
|-
|Dillimore Gas Station || 0 || 664.19 || -570.73 || 16.34 || Only South & West Wall + Floor solid || Mission "Tanker Commander"
|-
|Francis International Airport || 14 || -1830.81 || 16.83 || 1061.14 || Front Exterior & Ticket Sale, visible floors are solid || Cutscene in "Opening Mission"
|-
|Jefferson Motel || 15 || 2220.26 || -1148.01 || 1025.80 || Large Motel with lot of rooms || Mission "Reuniting the Families", Jefferson, Los Santos
|-
|Kickstart Stadium || 14 || -1410.72 || 1591.16 || 1052.53 || || Arena Mission "Kickstart"
|-
|Liberty City || 1 || -750.80 || 491.00 || 1371.70 || Interior with parts of Liberty City, only Saint Marks Bistro and nearer surrounding solid || Mission "Saint Marks Bistro"
|-
|Los Santos Airport, Baggage Reclaim || 14 || -1870.80 || 59.81 || 1056.25 || only roof is solid, maybe some of floor too || Cutscene in "Opening Mission"
|-
|Pleasures Dome/Jizzy's || 3 || -2637.69 || 1404.24 || 906.46 || Club in San Fierro || Cutscene & in Mission "Ice Cold Killa"
|-
|RC Battlefield || 10 || -1079.99 || 1061.58 || 1343.04 || || Mission "New Model Army"
|-
|Ryders House || 2 || 2451.77 || -1699.80 || 1013.51 || House of Ryder, some objects not solid || Cutscenes
|-
|San Fierro Garage Interior || 1 || -2042.42 || 178.59 || 28.84 || Interior of your Garage in Doherty. Locked Camera Position || Cutscenes
|-
|Sweets House || 1 || 2535.83 || -1674.32 || 1015.50 || House of your brother Sweet, some floors/walls & objects not solid || Cutscenes
|-
|Welcome Pump, The || 1 || 681.66 || -453.32 || -25.61 || Truck Stop Dinner where you meet Catalina. Entrance Area not solid || Cutscene in "First Date"
|-
|Woozies Apartment || 1 || -2158.72 || 641.29 || 1052.38 || Appartment where you meet Woozie few times during Missions in San Fierro. Does also include Woozie's betting shop || Cutscenes
|-
|8 Track Stadium || 7 || -1395.958 || -208.197 || 1051.170 || Figure-8 race track || Stadium
|-
|Dirt Bike Stadium || 4 || -1424.9319 || -664.5869 || 1059.8585 || Dirt Bike Stadium || Stadium
|-
|Golden Bed Motel Room || 9 || 2251.85 || -1138.16 || 1050.63 || Safe House Group 3 || ?
|-
|Hashbury House || 10 || 2260.76 || -1210.45 || 1049.02 || Safe House Group 4 || Hashburry, San Fierro
|-
|Johnsons House, The || 3 || 2496.65 || -1696.55 || 1014.74 || House of CJ's family where his mum has been murdered || Ganton, Los Santos
|-
|Madd Doggs Mansion || 5 || 1299.14 || -794.77 || 1084.00 || The large mansion you get at the end of Las Venturas Storyline Section. Also part of mission "Madd Doggs Rhymes" || Mulholland, Los Santos
|-
|Red Bed Motel Room || 10 || 2262.83 || -1137.71 || 1050.63 || Safe House Group 4 || ?
|-
|Verdant Bluffs Safehouse || 9 || 2365.42 || -1131.85 || 1050.88 || || Verdant Bluffs, Las Venturas
|-
|Zeros RC Shop || 6 || -2240.00 || 131.00 || 1035.40 || The Shop you can buy and start missions from || Garcia, San Fierro
|-
|SF Police Department || 10 || 246.40 || 110.84 || 1003.22 || || Not used
|-
|Unused Safe House || 12 || 2324.33 || -1144.79 || 1050.71 || Large modern unused Safehouse || Not used
|-
|Tattoos || 16 || -203.0764 || -24.1658 || 1002.2734 || Tattoo shop || Idlewood,LS
|-
|Burger Shot || 10 || 363.4129 || -74.5786 || 1001.5078 || Burger king || Vinewood, LS
|-
|Well Stacked Pizza || 5 || 372.3520 || -131.6510 || 1001.4922 || Well Stacked Pizza || Los Santos?
|-
|Cluckin' Bell || 9 || 365.7158 || -9.8873 || 1001.8516 || Cluckin' Bell || San Fierro, Downtown
|-
|Caligulas || 1 || 2233.8032 || 1712.2303 || 1011.7632 || Casino || Las Venturas
|-
|4 Dragons || 10 || 2016.2699 || 1017.7790 || 996.8750 || Casino || Las Venturas
|-
|Loco Low || 2 || 616.7820 || -74.8151 || 997.6350 || Modding shop || Los Santos
|-
|Wheel Arch Angels || 3 || 615.2851 || -124.2390 || 997.6350 || Modding shop || San Fierro
|-
|Transfender || 1 || 617.5380 || -1.9900 || 1000.6829 || Modding shop || Los Santos, San Fierro, Las Venturas
|}

GetFPSLimit

2008-10-15T12:48:08Z

Twig: removed example needed tag

{{Server function}}
__NOTOC__
This function retrieves the maximum [http://en.wikipedia.org/wiki/Frame_rate FPS (Frames per second)] that players on the server can run their game at.

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

===Returns===
Returns an integer between '''25''' and '''100''' of the maximum FPS that players can run their game at.

==Example==
This example displays a message in the chatbox showing the current fps limit.
<syntaxhighlight lang="lua">
function fpsLim()
outputChatBox ( "The FPS limit is: " .. tostring( getFPSLimit () ) ) --function returns an int so we must convert it to a string
end

-- Add console command "fpslimit" which calls the function fpsLim
addCommandHandler ( "fpslimit", fpsLim )
</syntaxhighlight>

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

GetFPSLimit

2008-10-15T12:47:18Z

Twig: Example added

Get

2008-10-15T09:26:26Z

Twig:

{{Server function}}
__NOTOC__
This function gets a setting's value, or a group of settings' values, from the [[settings system|settings registry]].

==Syntax==
<syntaxhighlight lang="lua">
var get ( string settingName )
</syntaxhighlight>

==Optional Arguments==
'''settingName:''' The name of the setting you want to set. See [[settings system#Setting names|setting names]] for information on settings names.

===Returns===
Returns the value of the setting if a single setting was specified and found, or a ''table'' (in associative-array form) containing:
*the list of global setting name/value pairs if "." is passed as a setting name,
*the list of resource settings if a resource name followed by a "." is passed,
*the list of the script's resource settings if an empty string is passed.
It returns ''false'' if the specified setting or settings group doesn't exist, or if the settings group you are trying to retrieve doesn't have any public or protected settings.

==Example==
Example returns a value from the settings registry with the name "respawnTime".
<syntaxhighlight lang="lua">
function getMySetting()
if get ( "respawnTime" ) then
return get ( "respawnTime" )
end
return false
end
</syntaxhighlight>

==See Also==
{{Settings registry functions}}

2008-02-03T16:54:22Z

Twig: /* Required Arguments */

__NOTOC__
{{Client function}}
This function creates a static image.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateStaticImage ( float x, float y, float width, float height, string filename, bool relative, element parent, [resource sourceResource = getThisResource()] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' X position of the image on the player's screen. This is affected by the ''relative'' argument.
*'''y:''' Y position of the image on the player's screen. This is affected by the ''relative'' argument.
*'''width:''' Width of the image. This is affected by the ''relative'' argument.
*'''height:''' Height of the image. This is affected by the ''relative'' argument.
*'''filename:''' The location of the image file that is being loaded. This should be the same as an image file specified in meta.xml file.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height values must be between 0 and 1, representing measures relative to the parent.
*'''parent:''' This is the parent that the image is attached to and therefore the child of. The ''relative'' argument must be true to use this. Sizes and positioning will be made relative to the parent. If ''nil'' parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Optional Arguments===
{{OptionalArg}}
*'''sourceResource:''' The resource to load the image from. Defaults to the resource that the script is running from.

===Returns===
Returns [[element]] if image was created successfully, ''false'' otherwise.

==Example==
This example will display an image (imagename.png) on the client's (player's) screen.
<section name="Client-side script (example.lua)" class="client" show="true">
<syntaxhighlight lang="lua">
[lua]
function showClientImage()
guiCreateStaticImage( 20, 200, 100, 100, "imagename.png", false )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), showClientImage )
</syntaxhighlight>
</section>

<section name="meta.xml" class="server" show="true">
In this example meta.xml is used to tell the server which files it will be using.
<syntaxhighlight lang="lua">
<info author="Yourname" version="1.0" />
<script src="example.lua" type="client" />
<file src="imagename.png" />
</syntaxhighlight>
</section>

==See Also==
{{GUI_functions}}
[[Category:Incomplete]]

GuiCreateStaticImage

2008-02-03T16:51:47Z

Twig: /* Required Arguments */

Talk:ExecuteSQLQuery

2008-01-28T12:27:24Z

Twig: New page: --~~~~ This function seems not to work in any way as it should. Things that should work in SQLite such as "SELECT name FROM sqlite_master" which should return all table names from a datab...

--[[User:Twig|Twig]] 06:27, 28 January 2008 (CST)

This function seems not to work in any way as it should. Things that should work in SQLite such as "SELECT name FROM sqlite_master" which should return all table names from a database return nothing at all. Could a developer please check up on this as it restricts the flexibility of SQLite.

SetVehiclePanelState

2008-01-26T17:25:12Z

Twig: /* Example */

__NOTOC__
{{Server client function}}

This function allows you to change the state of one of the six panels vehicle's can have. When executed on the server-side resources, the damage will be synched for all players, whereas the change is only client-side if the function is used in a client resource.

==Syntax==
<syntaxhighlight lang="lua">bool setVehiclePanelState ( vehicle theVehicle, int panelID, int state )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] you would like to modify the panel of.
*'''panelID:''' 0-6

*'''Cars (0-3):'''
**'''6:''' Rear Bumper
**'''5:''' Front Bumper
**'''4:''' Windscreen
**'''3:''' Unknown
**'''2:''' Unknown
**'''1:''' Unknown
**'''0:''' Unknown

*'''Planes (0-3):'''
**'''6:''' Unknown
**'''5:''' Unknown
**'''4:''' Ailerons
**'''3:''' Elevators
**'''2:''' Rudder
**'''1:''' Unknown
**'''0:''' Engine Smoke

''NOTE:'' Settings are not applicable for all vehicles of these types, for instance panel 0 effects a Dodo, but does nothing to a hydra.

*'''state:''' 0-3 (seems ineffective out of this range, check though)

==Returns==
Returns ''true'' if the panel state has been updated, ''false'' otherwise

==Example==
<section name="Example 1: Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- create a new vehicle
local newcar = createVehicle ( 520, 1024, 1024, 1024 )
-- break the front bumper off
setVehiclePanelState ( newcar, 5, 3 )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

User:Twig

2008-01-25T23:29:13Z

Twig: New page: == Twig == Member and leader of VCES and SAES currently working on an RPG style script for our server. Previous member of QA with experience in C++, PHP, Javascript, xHTML, VB, MySQL and...

== Twig ==

Member and leader of VCES and SAES currently working on an RPG style script for our server. Previous member of QA with experience in C++, PHP, Javascript, xHTML, VB, MySQL and lots of other stuff that comes in useful.

Currently studying in my final year for a BSc degree in Acoustics in the UK.

User talk:Twig

2008-01-25T23:29:04Z

Twig: /* Twig */

SetVehiclePanelState

2008-01-25T22:56:39Z

Twig: /* Required Arguments */

__NOTOC__
{{Server client function}}

This function allows you to change the state of one of the six panels vehicle's can have. When executed on the server-side resources, the damage will be synched for all players, whereas the change is only client-side if the function is used in a client resource.

==Syntax==
<syntaxhighlight lang="lua">bool setVehiclePanelState ( vehicle theVehicle, int panelID, int state )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] you would like to modify the panel of.
*'''panelID:''' 0-6

*'''Cars (0-3):'''
**'''6:''' Rear Bumper
**'''5:''' Front Bumper
**'''4:''' Windscreen
**'''3:''' Unknown
**'''2:''' Unknown
**'''1:''' Unknown
**'''0:''' Unknown

*'''Planes (0-3):'''
**'''6:''' Unknown
**'''5:''' Unknown
**'''4:''' Ailerons
**'''3:''' Elevators
**'''2:''' Rudder
**'''1:''' Unknown
**'''0:''' Engine Smoke

''NOTE:'' Settings are not applicable for all vehicles of these types, for instance panel 0 effects a Dodo, but does nothing to a hydra.

*'''state:''' 0-3 (seems ineffective out of this range, check though)

==Returns==
Returns ''true'' if the panel state has been updated, ''false'' otherwise

==Example==
<section name="Example 1: Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- create a new vehicle
local newcar = createVehicle ( 520, 1024, 1024, 1024 )
-- break the front bumper off
setVehiclePanelState ( newcar, 5, 4 )
</syntaxhighlight>
</section>
==See Also==
{{Vehicle functions}}

SetVehiclePanelState

2008-01-25T22:51:45Z

Twig:

__NOTOC__
{{Server client function}}

This function allows you to change the state of one of the six panels vehicle's can have. When executed on the server-side resources, the damage will be synched for all players, whereas the change is only client-side if the function is used in a client resource.

==Syntax==
<syntaxhighlight lang="lua">bool setVehiclePanelState ( vehicle theVehicle, int panelID, int state )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] you would like to modify the panel of.
*'''panelID:''' 0-6

*'''Cars (0-3):'''
**'''6:''' Rear Bumper
**'''5:''' Front Bumper
**'''4:''' Windscreen
**'''3:''' Unknown
**'''2:''' Unknown
**'''1:''' Unknown
**'''0:''' Unknown

*'''Planes (0-3):'''
**'''6:''' Unknown
**'''5:''' Unknown
**'''4:''' Ailerons
**'''3:''' Elevators
**'''2:''' Rudder
**'''1:''' Unknown
**'''0:''' Engine Smoke

''NOTE:'' Settings are not applicable for all vehicles of these types, for instance panel 0 effects a Dodo, but does nothing to a hydra.

*'''state:''' 0-255 (check what range is effective, it may be much smaller e.g. 0-3)

==Returns==
Returns ''true'' if the panel state has been updated, ''false'' otherwise

==Example==
<section name="Example 1: Server" class="server" show="true">
<syntaxhighlight lang="lua">
-- create a new vehicle
local newcar = createVehicle ( 520, 1024, 1024, 1024 )
-- break the front bumper off
setVehiclePanelState ( newcar, 5, 4 )
</syntaxhighlight>
</section>
==See Also==
{{Vehicle functions}}

SetVehiclePanelState

2008-01-25T22:47:23Z

Twig:

2008-01-25T22:24:07Z

Twig:

SetVehiclePanelState

2008-01-25T22:23:48Z

Twig: