Multi Theft Auto: Wiki - User contributions [en]

CURL Errors

2009-03-27T18:47:48Z

Kevuwk: New page: List of CURL Errors, updates can be found [http://curl.haxx.se/libcurl/c/libcurl-errors.html here] '''CURLE_OK (0)''' All fine. Proceed as usual. '''CURLE_UNSUPPORTED_PROTOCOL (1)''' ...

List of CURL Errors, updates can be found [http://curl.haxx.se/libcurl/c/libcurl-errors.html here]

'''CURLE_OK (0)'''

All fine. Proceed as usual.

'''CURLE_UNSUPPORTED_PROTOCOL (1)'''

The URL you passed to libcurl used a protocol that this libcurl does not support. The support might be a compile-time option that you didn't use, it can be a misspelled protocol string or just a protocol libcurl has no code for.

'''CURLE_FAILED_INIT (2)'''

Very early initialization code failed. This is likely to be an internal error or problem.

'''CURLE_URL_MALFORMAT (3)'''

The URL was not properly formatted.

'''CURLE_COULDNT_RESOLVE_PROXY (5)'''

Couldn't resolve proxy. The given proxy host could not be resolved.

'''CURLE_COULDNT_RESOLVE_HOST (6)'''

Couldn't resolve host. The given remote host was not resolved.

'''CURLE_COULDNT_CONNECT (7)'''

Failed to connect() to host or proxy.

'''CURLE_FTP_WEIRD_SERVER_REPLY (8)'''

After connecting to a FTP server, libcurl expects to get a certain reply back. This error code implies that it got a strange or bad reply. The given remote server is probably not an OK FTP server.

'''CURLE_REMOTE_ACCESS_DENIED (9)'''

We were denied access to the resource given in the URL. For FTP, this occurs while trying to change to the remote directory.
'''
CURLE_FTP_WEIRD_PASS_REPLY (11)'''

After having sent the FTP password to the server, libcurl expects a proper reply. This error code indicates that an unexpected code was returned.

'''CURLE_FTP_WEIRD_PASV_REPLY (13)'''

libcurl failed to get a sensible result back from the server as a response to either a PASV or a EPSV command. The server is flawed.

'''CURLE_FTP_WEIRD_227_FORMAT (14)'''

FTP servers return a 227-line as a response to a PASV command. If libcurl fails to parse that line, this return code is passed back.

'''CURLE_FTP_CANT_GET_HOST (15)'''

An internal failure to lookup the host used for the new connection.

'''CURLE_FTP_COULDNT_SET_TYPE (17)'''

Received an error when trying to set the transfer mode to binary or ASCII.

'''CURLE_PARTIAL_FILE (18)'''

A file transfer was shorter or larger than expected. This happens when the server first reports an expected transfer size, and then delivers data that doesn't match the previously given size.

'''CURLE_FTP_COULDNT_RETR_FILE (19)'''

This was either a weird reply to a 'RETR' command or a zero byte transfer complete.

'''CURLE_QUOTE_ERROR (21)'''

When sending custom "QUOTE" commands to the remote server, one of the commands returned an error code that was 400 or higher (for FTP) or otherwise indicated unsuccessful completion of the command.

'''CURLE_HTTP_RETURNED_ERROR (22)'''

This is returned if CURLOPT_FAILONERROR is set TRUE and the HTTP server returns an error code that is >= 400. (This error code was formerly known as CURLE_HTTP_NOT_FOUND.)

'''CURLE_WRITE_ERROR (23)'''

An error occurred when writing received data to a local file, or an error was returned to libcurl from a write callback.

'''CURLE_UPLOAD_FAILED (25)'''

Failed starting the upload. For FTP, the server typically denied the STOR command. The error buffer usually contains the server's explanation for this. (This error code was formerly known as CURLE_FTP_COULDNT_STOR_FILE.)

'''CURLE_READ_ERROR (26)'''

There was a problem reading a local file or an error returned by the read callback.

'''CURLE_OUT_OF_MEMORY (27)'''

A memory allocation request failed. This is serious badness and things are severely screwed up if this ever occurs.

'''CURLE_OPERATION_TIMEDOUT (28)'''

Operation timeout. The specified time-out period was reached according to the conditions.

'''CURLE_FTP_PORT_FAILED (30)'''

The FTP PORT command returned error. This mostly happens when you haven't specified a good enough address for libcurl to use. See CURLOPT_FTPPORT.

'''CURLE_FTP_COULDNT_USE_REST (31)'''

The FTP REST command returned error. This should never happen if the server is sane.

'''CURLE_RANGE_ERROR (33)'''

The server does not support or accept range requests.

'''CURLE_HTTP_POST_ERROR (34)'''

This is an odd error that mainly occurs due to internal confusion.

'''CURLE_SSL_CONNECT_ERROR (35)'''

A problem occurred somewhere in the SSL/TLS handshake. You really want the error buffer and read the message there as it pinpoints the problem slightly more. Could be certificates (file formats, paths, permissions), passwords, and others.

'''CURLE_FTP_BAD_DOWNLOAD_RESUME (36)'''

Attempting FTP resume beyond file size.

'''CURLE_FILE_COULDNT_READ_FILE (37)'''

A file given with FILE:// couldn't be opened. Most likely because the file path doesn't identify an existing file. Did you check file permissions?

'''CURLE_LDAP_CANNOT_BIND (38)'''

LDAP cannot bind. LDAP bind operation failed.

'''CURLE_LDAP_SEARCH_FAILED (39)'''

LDAP search failed.

'''CURLE_FUNCTION_NOT_FOUND (41)'''

Function not found. A required zlib function was not found.

'''CURLE_ABORTED_BY_CALLBACK (42)'''

Aborted by callback. A callback returned "abort" to libcurl.

'''CURLE_BAD_FUNCTION_ARGUMENT (43)'''

Internal error. A function was called with a bad parameter.

'''CURLE_INTERFACE_FAILED (45)'''

Interface error. A specified outgoing interface could not be used. Set which interface to use for outgoing connections' source IP address with CURLOPT_INTERFACE. (This error code was formerly known as CURLE_HTTP_PORT_FAILED.)
'''
CURLE_TOO_MANY_REDIRECTS (47)'''

Too many redirects. When following redirects, libcurl hit the maximum amount. Set your limit with CURLOPT_MAXREDIRS.

'''CURLE_UNKNOWN_TELNET_OPTION (48)'''

An option set with CURLOPT_TELNETOPTIONS was not recognized/known. Refer to the appropriate documentation.

'''CURLE_TELNET_OPTION_SYNTAX (49)'''

A telnet option string was Illegally formatted.

'''CURLE_PEER_FAILED_VERIFICATION (51)'''

The remote server's SSL certificate or SSH md5 fingerprint was deemed not OK.

'''CURLE_GOT_NOTHING (52)'''

Nothing was returned from the server, and under the circumstances, getting nothing is considered an error.

'''CURLE_SSL_ENGINE_NOTFOUND (53)'''

The specified crypto engine wasn't found.

'''CURLE_SSL_ENGINE_SETFAILED (54)'''

Failed setting the selected SSL crypto engine as default!

'''CURLE_SEND_ERROR (55)'''

Failed sending network data.

'''CURLE_RECV_ERROR (56)'''

Failure with receiving network data.

'''CURLE_SSL_CERTPROBLEM (58)'''

problem with the local client certificate.

'''CURLE_SSL_CIPHER (59)'''

Couldn't use specified cipher.

'''CURLE_SSL_CACERT (60)'''

Peer certificate cannot be authenticated with known CA certificates.

'''CURLE_BAD_CONTENT_ENCODING (61)'''

Unrecognized transfer encoding.

'''CURLE_LDAP_INVALID_URL (62)'''

Invalid LDAP URL.

'''CURLE_FILESIZE_EXCEEDED (63)'''

Maximum file size exceeded.

'''CURLE_USE_SSL_FAILED (64)'''

Requested FTP SSL level failed.

'''CURLE_SEND_FAIL_REWIND (65)'''

When doing a send operation curl had to rewind the data to retransmit, but the rewinding operation failed.

'''CURLE_SSL_ENGINE_INITFAILED (66)'''

Initiating the SSL Engine failed.

'''CURLE_LOGIN_DENIED (67)'''

The remote server denied curl to login (Added in 7.13.1)

'''CURLE_TFTP_NOTFOUND (68)'''

File not found on TFTP server.

'''CURLE_TFTP_PERM (69)'''

Permission problem on TFTP server.

'''CURLE_REMOTE_DISK_FULL (70)'''

Out of disk space on the server.

'''CURLE_TFTP_ILLEGAL (71)'''

Illegal TFTP operation.

'''CURLE_TFTP_UNKNOWNID (72)'''

Unknown TFTP transfer ID.

'''CURLE_REMOTE_FILE_EXISTS (73)'''

File already exists and will not be overwritten.

'''CURLE_TFTP_NOSUCHUSER (74)'''

This error should never be returned by a properly functioning TFTP server.

'''CURLE_CONV_FAILED (75)'''

Character conversion failed.

'''CURLE_CONV_REQD (76)'''

Caller must register conversion callbacks.

'''CURLE_SSL_CACERT_BADFILE (77)'''

Problem with reading the SSL CA cert (path? access rights?)

'''CURLE_REMOTE_FILE_NOT_FOUND (78)'''

The resource referenced in the URL does not exist.

'''CURLE_SSH (79)'''

An unspecified error occurred during the SSH session.

'''CURLE_SSL_SHUTDOWN_FAILED (80)'''

Failed to shut down the SSL connection.

'''CURLE_AGAIN (81)'''

Socket is not ready for send/recv wait till it's ready and try again. This return code is only returned from curl_easy_recv(3) and curl_easy_send(3) (Added in 7.18.2)

'''CURLE_SSL_CRL_BADFILE (82)'''

Failed to load CRL file (Added in 7.19.0)

'''CURLE_SSL_ISSUER_ERROR (83)'''

Issuer check failed (Added in 7.19.0)

GetVersion

2009-03-07T18:03:43Z

Kevuwk:

__NOTOC__
{{Server client function}}

This function gives you various version information about MTA and the operating system.

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

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

===Returns===
Returns a table with version information. Specifically these keys are present in the table:
*'''number:''' the MTA server or client version (depending where the function was called) in pure numerical form.
*'''mta:''' the MTA server or client version in textual form.
*'''name:''' the full MTA product name.
*'''netcode:''' the netcode version number.
*'''os:''' can be "Windows", "Linux", "FreeBSD" or "OpenBSD".

==Example==
This example will make a script compatible only with version 1.0:
<syntaxhighlight lang="lua">
function setHoboSkin ( playerSource )
local version = getVersion ( )
if version.number < 256 then -- MTA 1.0 version number is 0x0100
setPlayerSkin ( playerSource, 137 )
else
setElementModel ( playerSource, 137 )
end
end
addCommandHandler ( "hobo", setHoboSkin )
</syntaxhighlight>

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

GetVersion

2009-03-07T18:02:50Z

Kevuwk:

__NOTOC__
{{Server client function}}

This function gives you various version information about MTA and the operating system.

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

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

===Returns===
Returns a table with version information. Specifically these keys are present in the table:
*'''number:''' the MTA server or client version (depending where the function was called) in pure numerical form.
*'''mta:''' the MTA server or client version in textual form.
*'''name:''' the full MTA product name.
*'''netcode:''' the netcode version number.
*'''os:''' can be "Windows", "Linux", "FreeBSD" or "OpenBSD".

==Example==
This example will make a script compatible with only version 1.0:
<syntaxhighlight lang="lua">
function setHoboSkin ( playerSource )
local version = getVersion ( )
if version.number < 256 then -- MTA 1.0 version number is 0x0100
setPlayerSkin ( playerSource, 137 )
else
setElementModel ( playerSource, 137 )
end
end
addCommandHandler ( "hobo", setHoboSkin )
</syntaxhighlight>

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

RemoveEventHandler

2007-06-23T01:49:30Z

Kevuwk:

{{Needs_Checking|Why do we have to specify what element was the handler attached to? --[[User:Jbeta|jbeta]] 07:34, 3 June 2007 (CDT)
*Because multiple elements might use the same event and function --[[User:Kevuwk|Kevuwk]] 20:49, 22 June 2007 (CDT) }}
__NOTOC__
This functions removes a handler function from an [[event]], so that the function is not called anymore when the event is triggered. See [[event system]] for more information on how the event system works.

==Syntax==
<syntaxhighlight lang="lua">
bool removeEventHandler ( string eventName, element attachedTo, string functionName )
</syntaxhighlight>

===Required Arguments===
*'''eventName:''' The name of the [[event]] you want to detach the handler function from.
*'''attachedTo:''' The [[element]] the handler was attached to.
*'''functionName:''' The name of the handler function that was attached.

===Returns===
Returns ''true'' if the event handler was removed successfully. Returns ''false'' if the specified event handler could not be found or invalid parameters were passed.

==Example==
This example...

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

Client Scripting Functions

2007-02-26T22:21:45Z

Kevuwk:

This page lists all the '''client-side''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]

'''Please check all the client side functions work and mark them on this page - [[Temp_Log]], the list on that page should be upto date with newly added functions copied from the server with the same syntax.'''

==Audio functions==
{{Client_audio_functions}}

==Blip functions==
{{Client_blip_functions}}

==Element functions==
{{Client_element_functions}}

==Event functions==
{{Client_event_functions}}

==Explosion functions==
{{Client_explosion_functions}}

==GUI functions==
{{GUI_functions}}

==Player functions==
{{Client_player_functions}}

==Output functions==
{{Client_output_functions}}

==Utility functions==
{{Client_utility_functions}}

==World functions==
{{Client_world_functions}}

Server Scripting Functions

2007-01-02T15:32:07Z

Kevuwk: /* Element functions */

This page lists all the scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]

Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to [[Module functions]] for a list of non-native functions and modules that are available.

==Important Reminder: Works in Progress==
Check the [[Main Page]]'s 'works in progress' section. There are other things being developed that need feedback immediately!

==Unfinished Functions==
<div style="border:3px solid red;margin-bottom:3px;padding-left:10px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
*'''NEED SYNTAX, MTA TEAM:''' [[:Category:Need Syntax]]
</div>
*'''Incomplete Functions:''' [[:Category:Incomplete]]
** [[Complete list of scripting functions | Wiki source function list]] Wiki-created function list for quickview and double-checking
*'''Incomplete Events List:''' [[:Category:Incomplete Event]]
*'''Written material accuracy/completion check:''' [[:Category:Needs Checking]]

''If you wish to assist Ransom in adding new (red) functions to the incomplete list, see [[User:Ransom|Ransom's profile]] for the proper steps.''

''Please follow the style of the [[TextCreateTextItem|textCreateTextItem]] to document functions.''

==Account functions==
{{Account_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==All Seeing Eye functions==
{{ASE_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera functions}}

==Collision shape functions==
{{Collision shape functions}}

==Client functions==
{{Client functions}}

==Clothes and body functions==
{{Clothes and body functions}}

==Cursor functions==
{{Cursor_functions}}

==Element functions==
{{Element functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==Fire functions==
{{Fire_functions}}

==GUI functions==
{{GUI_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker functions}}

==Object functions==
{{Object functions}}

==Pickup functions==
{{Pickup functions}}

==Player functions==
{{Player functions}}

==Radar area functions==
{{Radar area functions}}

==Scoreboard functions==
{{Scoreboard functions}}

==Server functions==
{{Server functions}}

==Spawnpoint functions==
{{Spawnpoint functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team functions}}

==Text functions==
{{Text functions}}

==Utility functions==
{{Utility functions}}

==Vehicle functions==
{{Vehicle functions}}

==Weapon functions==
{{Weapon functions}}

==World functions==
{{World functions}}

==XML functions==
{{XML functions}}

==Deprecated Functions==
Access: [http://www.mtavc.com/once-upon_a_time-there_was-this_girl/index.php?title=Category:Deprecated <nowiki>[[Category:Depreciated]]</nowiki> ]<br>
''Note: dont change this, done purposely to keep this page from being included in the listing.''

Server Scripting Functions

2007-01-02T15:30:21Z

Kevuwk: /* Element functions */

This page lists all the scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]

Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to [[Module functions]] for a list of non-native functions and modules that are available.

==Important Reminder: Works in Progress==
Check the [[Main Page]]'s 'works in progress' section. There are other things being developed that need feedback immediately!

==Unfinished Functions==
<div style="border:3px solid red;margin-bottom:3px;padding-left:10px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
*'''NEED SYNTAX, MTA TEAM:''' [[:Category:Need Syntax]]
</div>
*'''Incomplete Functions:''' [[:Category:Incomplete]]
** [[Complete list of scripting functions | Wiki source function list]] Wiki-created function list for quickview and double-checking
*'''Incomplete Events List:''' [[:Category:Incomplete Event]]
*'''Written material accuracy/completion check:''' [[:Category:Needs Checking]]

''If you wish to assist Ransom in adding new (red) functions to the incomplete list, see [[User:Ransom|Ransom's profile]] for the proper steps.''

''Please follow the style of the [[TextCreateTextItem|textCreateTextItem]] to document functions.''

==Account functions==
{{Account_functions}}

==Admin functions==
{{Admin_functions}}

==Audio functions==
{{Audio_functions}}

==All Seeing Eye functions==
{{ASE_functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Camera functions}}

==Collision shape functions==
{{Collision shape functions}}

==Client functions==
{{Client functions}}

==Clothes and body functions==
{{Clothes and body functions}}

==Cursor functions==
{{Cursor_functions}}

{{Element functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==Fire functions==
{{Fire_functions}}

==GUI functions==
{{GUI_functions}}

==Input functions==
{{Input_functions}}

==Map functions==
{{Map_functions}}

==Marker functions==
{{Marker functions}}

==Object functions==
{{Object functions}}

==Pickup functions==
{{Pickup functions}}

==Player functions==
{{Player functions}}

==Radar area functions==
{{Radar area functions}}

==Scoreboard functions==
{{Scoreboard functions}}

==Server functions==
{{Server functions}}

==Spawnpoint functions==
{{Spawnpoint functions}}

==SQL functions==
{{SQL_functions}}

==Team functions==
{{Team functions}}

==Text functions==
{{Text functions}}

==Utility functions==
{{Utility functions}}

==Vehicle functions==
{{Vehicle functions}}

==Weapon functions==
{{Weapon functions}}

==World functions==
{{World functions}}

==XML functions==
{{XML functions}}

==Deprecated Functions==
Access: [http://www.mtavc.com/once-upon_a_time-there_was-this_girl/index.php?title=Category:Deprecated <nowiki>[[Category:Depreciated]]</nowiki> ]<br>
''Note: dont change this, done purposely to keep this page from being included in the listing.''

GetAttachedElements

2007-01-01T20:12:39Z

Kevuwk:

__NOTOC__
This function returns a table of all the elements attached to the specified element

==Syntax==
<syntaxhighlight lang="lua">
table getAttachedElements ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement''': The [[element]] which you require the information from.

===Returns===
Returns a table of all the elements attached to the specified element.

==Example==
<syntaxhighlight lang="lua">
-- Print a list of all the players attached to the specified element
Inf = getElementByID ( "infernus1" )
attachedElements = getAttachedElements ( Inf )
if ( attachedElements ) then -- if we got the table
attachedElementsList = "none"
-- Loop through the table
for ElementKey, ElementValue in attachedElements do
-- add their name to the list
if ( getElementType ( ElementValue ) == "player" ) then
if ( attachedElementsList == "none" ) then
attachedElementsList = getClientName ( ElementValue )
else
attachedElementsList = attachedElementsList .. ", " .. getClientName ( ElementValue )
end
end
end
outputConsole ( "Players attached: " .. attachedElementsList )
end
</syntaxhighlight>

==See Also==
{{Element functions}}

Template:Element functions

2007-01-01T20:03:33Z

Kevuwk:

''Element Functions''
*[[createElement]]
*[[destroyElement]]
*[[cloneElement]]
*[[getElementByID]]
*[[getElementByIndex]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementData]]
*[[getElementID]]
*[[getElementParent]]
*[[getElementsByType]]
*[[getElementType]]
*[[getRootElement]]
*[[isElementVisibleTo]]
*[[isElementWithinColShape]]
*[[getElementsWithinColShape]]
*[[getElementPosition]]
*[[getElementVelocity]]
*[[getElementInterior]]
*[[getElementDimension]]
*[[getElementZoneName]]
*[[setElementData]]
*[[setElementID]]
*[[setElementParent]]
*[[setElementVisibleTo]]
*[[clearElementVisibleTo]]
*[[setElementPosition]]
*[[setElementVelocity]]
*[[setElementInterior]]
*[[setElementDimension]]
*[[attachElementToElement]]
*[[detachElementFromElement]]
*[[isElementAttached]]
*[[getElementAttachedTo]]
*[[getAttachedElements]]

GetElementAttachedTo

2007-01-01T20:00:59Z

Kevuwk:

__NOTOC__
This function returns an element from the specified ID.

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

===Required Arguments===
*'''theElement:''' The element you require the information for.

===Returns===
Returns the element that the chosen element is attached to, or ''false'' if the element isn't attached to another element.

==Example==
This example assigns the element that the specified element is attached to into attached.
<syntaxhighlight lang="lua">
addEventHandler ( "onConsole", root, "onConsole" )
function onConsole ( text )
if ( getElementType ( source ) == "player" ) then
command = gettok ( text, 1, 32 )
if ( command == "getattached" ) then
attached = getElementAttachedTo ( source )
if ( attached ) then
outputConsole ( "element type: " .. getElementType ( attached ) ) -- possible output
else
outputConsole ( "not attached to an element" ) -- display error
end
end
end
end
</syntaxhighlight>

==See Also==
{{Element_functions}}

GetPlayerTotalAmmo

2006-11-22T23:32:21Z

Kevuwk:

__NOTOC__
This function returns an integer that contains the total ammo in a specified [[player]]'s current weapon.

==Syntax==
<syntaxhighlight lang="lua">
int getPlayerTotalAmmo ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The [[player]] whose ammo you want to check.

===Returns===
Returns an [[int]] containing the total amount of ammo for the specified player's weapon, or 0 if the player specified is invalid.

==Example==
This example outputs the total amount of ammo a player called ''Someguy'' has for his weapon.
<syntaxhighlight lang="lua">
-- Find the player called 'Someguy'
myPlayer = findPlayer ( "Someguy" )
-- If a player called 'Someguy' was found then
if ( myPlayer ~= false )
-- Retrieve the total amount of ammo for that player, and store it in a variable called 'ammo'
ammo = getPlayerTotalAmmo ( myPlayer )
-- Tell all the players how much ammo 'Someguy' has
outputChatBox ( "Someguy's current total ammo: ", ammo, "." )
end
</syntaxhighlight>

==See Also==
{{Player functions}}

GetPlayerAmmoInClip

2006-11-22T23:31:43Z

Kevuwk:

__NOTOC__
This function returns an integer that contains the current ammo in a specified [[player]]'s current weapon.

==Syntax==
<syntaxhighlight lang="lua">
int getPlayerAmmoInClip ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The [[player]] whose ammo you want to check.

===Returns===
Returns an [[int]] containing the ammount of ammo in the specified player's clip, or 0 if the player specified is invalid.

==Example==
This example outputs the ammount of ammo a player called ''Someguy'' has in his weapon's clip.
<syntaxhighlight lang="lua">
-- Find the player called 'Someguy'
myPlayer = findPlayer ( "Someguy" )
-- If a player called 'Someguy' was found then
if ( myPlayer ~= false )
-- Retrieve the ammount of ammo in the clip for that player, and store it in a variable called 'ammo'
ammo = getPlayerAmmoInClip ( myPlayer )
-- Tell all the players how much ammo 'Someguy' has
outputChatBox ( "Someguy's current ammo-in-clip: ", ammo, "." )
end
</syntaxhighlight>

==See Also==
{{Player functions}}

Template:Player functions

2006-11-22T23:30:42Z

Kevuwk:

* [[addPlayerClothes]]
* [[canPlayerUseFunction]]
* [[doesPlayerHaveJetPack]]
* [[getPlayerArmor]]
* [[getPlayerClothes]]
* [[getPlayerCount]]
* [[getPlayerAmmoInClip]]
* [[getPlayerTotalAmmo]]
* [[getPlayerCurrentWeaponID]]
* [[getPlayerFromNick]]
* [[getPlayerHealth]]
* [[getPlayerLevel]]
* [[getPlayerMoney]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerOccupiedVehicleSeat]]
* [[getPlayerPing]]
* [[getPlayerRotation]]
* [[getPlayerSkin]]
* [[getPlayerSourceIP]]
* [[getPlayerStat]]
* [[getPlayerTarget]]
* [[getPlayerTeam]]
* [[getRandomPlayer]]
* [[getWantedLevel]]
* [[givePlayerJetPack]]
* [[givePlayerMoney]]
* [[isPlayerDead]]
* [[isPlayerDucked]]
* [[isPlayerInVehicle]]
* [[isPlayerMuted]]
* [[isPlayerOnGround]]
* [[isPlayerUnderWater]]
* [[isPlayerScoreboardForced]]
* [[isPlayerMapForced]]
* [[getAlivePlayers]]
* [[getDeadPlayers]]
* [[getPlayerTask]]
* [[getPlayerSimplestTask]]
* [[isPlayerDoingTask]]
* [[getPlayerNametagText]]
* [[getPlayerNametagColor]]
* [[killPlayer]]
* [[removePlayerClothes]]
* [[removePlayerFromVehicle]]
* [[removePlayerJetPack]]
* [[setPlayerArmor]]
* [[setPlayerHealth]]
* [[setPlayerMoney]]
* [[setPlayerRotation]]
* [[setPlayerSkin]]
* [[setPlayerStat]]
* [[setWantedLevel]]
* [[showPlayerHudComponent]]
* [[spawnPlayer]]
* [[spawnPlayerAtSpawnpoint]]
* [[takePlayerMoney]]
* [[warpPlayerIntoVehicle]]
* [[forcePlayerScoreboard]]
* [[forcePlayerMap]]
* [[setPlayerNametagText]]
* [[setPlayerNametagColor]]

SetVehicleSirensOn

2006-11-19T18:16:57Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function changes the state of the sirens on the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleSirenOn ( vehicle theVehicle , bool sirensOn )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle that will have the sirens set
*'''sirensOn:''' The state to set the sirens to

===Returns===
Returns ''true'' if the sirens are set for the specified vehicle, ''false'' if the sirens can't be set for the specified vehicle, if the vehicle doesn't have sirens or if invalid arguments are specified.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

GetVehicleSirensOn

2006-11-19T18:13:04Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function returns whether the sirens are turned on for the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleSirensOn ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle that will be checked

===Returns===
Returns ''true'' if the sirens are turned on for the specified vehicle, ''false'' if the sirens are turned off for the specified vehicle, if the vehicle doesn't have sirens or if invalid arguments are specified.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

GetTeamFriendlyFire

2006-11-19T18:08:29Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function returns the friendly fire value for the specified team.

==Syntax==
<syntaxhighlight lang="lua">
bool getTeamFriendlyFire ( team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The team that will be checked

===Returns===
Returns ''true'' if friendly fire is on for the specified team, ''false'' if friendly fire is turned off for the specified team or if invalid arguments are specified.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

SetTeamFriendlyFire

2006-11-19T18:08:07Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function sets the friendly fire value for the specified team.

==Syntax==
<syntaxhighlight lang="lua">
bool setTeamFriendlyFire ( team theTeam , bool friendlyFire )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The team that will have friendly fire set
*'''friendlyFire:''' The friendly fire value

===Returns===
Returns ''true'' if the friendly fire value is set for the specified team, ''false'' if the friendly fire value can't be set for the specified team or if invalid arguments are specified.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

GetTeamFriendlyFire

2006-11-19T18:04:26Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function returns the friendly fire value for the specified team.

==Syntax==
<syntaxhighlight lang="lua">
bool getTeamFriendlyFire ( team theTeam )
</syntaxhighlight>

===Required Arguments===
*'''theTeam:''' The client that will be checked

===Returns===
Returns ''true'' if friendly fire is on for the specified team, ''false'' if friendly fire is turned off for the specified team or if invalid arguments are specified.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

SetClientName

2006-11-19T17:55:11Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function sets the name of the specified client.

==Syntax==
<syntaxhighlight lang="lua">
bool setClientName ( client theClient , string name )
</syntaxhighlight>

===Required Arguments===
*'''theClient:''' The client that will have it's name set
*'''name:''' The name to set for the client

===Returns===
Returns ''true'' if the client's name was changed succesfully, ''false'' if invalid arguments are specified.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

BanPlayer

2006-11-19T17:49:21Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function will ban the specified player from the server.

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

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

===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' The player that is responsible the event
*'''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 does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

BanPlayer

2006-11-19T17:46:42Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function will ban the specified player from the server.

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

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

===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' The player that is responsible the event
*'''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 does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

KickPlayer

2006-11-19T17:45:02Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This function will kick the specified player from the server.

==Syntax==
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer , [ player responsiblePlayer , string reason ] )
</syntaxhighlight>

===Required Arguments===
*'''kickPlayer:''' The player that will be kicked from the server

===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' The player that is responsible the event
*'''reason:''' The reason the player will be kicked from the server

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

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

KickPlayer

2006-11-19T17:43:29Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer , [ player responsiblePlayer , string reason ] )
</syntaxhighlight>

===Required Arguments===
*'''kickPlayer:''' The player that will be kicked from the server

===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' The player that is responsible the event
*'''reason:''' The reason the player will be kicked from the server

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

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

KickPlayer

2006-11-19T17:38:50Z

Kevuwk:

[[Category:Incomplete]]

__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer , player responsiblePlayer , string reason )
</syntaxhighlight>

===Required Arguments===
*'''argumentName:''' description

===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description

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

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}

Template:Player functions

2006-11-19T17:08:50Z

Kevuwk:

* [[addPlayerClothes]]
* [[canPlayerUseFunction]]
* [[doesPlayerHaveJetPack]]
* [[getPlayerArmor]]
* [[getPlayerClothes]]
* [[getPlayerCount]]
* [[getPlayerCurrentWeaponAmmoInClip]]
* [[getPlayerCurrentWeaponTotalAmmo]]
* [[getPlayerCurrentWeaponID]]
* [[getPlayerFromNick]]
* [[getPlayerHealth]]
* [[getPlayerLevel]]
* [[getPlayerMoney]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerOccupiedVehicleSeat]]
* [[getPlayerPing]]
* [[getPlayerRotation]]
* [[getPlayerSkin]]
* [[getPlayerSourceIP]]
* [[getPlayerStat]]
* [[getPlayerTarget]]
* [[getPlayerTeam]]
* [[getRandomPlayer]]
* [[getWantedLevel]]
* [[givePlayerJetPack]]
* [[givePlayerMoney]]
* [[isPlayerDead]]
* [[isPlayerDucked]]
* [[isPlayerInVehicle]]
* [[isPlayerMuted]]
* [[isPlayerOnGround]]
* [[isPlayerUnderWater]]
* [[isPlayerScoreboardForced]]
* [[isPlayerMapForced]]
* [[getAlivePlayers]]
* [[getDeadPlayers]]
* [[getPlayerTask]]
* [[getPlayerSimplestTask]]
* [[isPlayerDoingTask]]
* [[killPlayer]]
* [[removePlayerClothes]]
* [[removePlayerFromVehicle]]
* [[removePlayerJetPack]]
* [[setPlayerArmor]]
* [[setPlayerHealth]]
* [[setPlayerMoney]]
* [[setPlayerRotation]]
* [[setPlayerSkin]]
* [[setPlayerStat]]
* [[setWantedLevel]]
* [[showPlayerHudComponent]]
* [[spawnPlayer]]
* [[spawnPlayerAtSpawnpoint]]
* [[takePlayerMoney]]
* [[warpPlayerIntoVehicle]]
* [[forcePlayerScoreboard]]
* [[forcePlayerMap]]