Multi Theft Auto: Wiki - User contributions [en]

Template:Vehicle functions

2008-10-04T09:55:39Z

DracoBlue: /* added respawnVehicle */

*[[blowVehicle]]
*[[createVehicle]]
*[[fixVehicle]]
*[[spawnVehicle]]
*[[respawnVehicle]]

*[[getVehicleColor]]
*[[getVehicleID]]
*[[getVehicleIDFromName]]
*[[getVehicleNameFromID]]
*[[getVehicleMaxPassengers]]
*[[getVehicleName]]
*[[getVehicleOccupant]]
*[[getVehicleController]]
*[[getVehicleRotation]]
*[[getVehicleType]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehiclesOfType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleWheelStates]]
*[[getVehicleLightState]]
*[[getVehicleOverrideLights]]
*[[getVehiclePanelState]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehiclePaintjob]]
*[[getVehicleSirensOn]]
*[[getVehicleLandingGearDown]]

*[[isVehicleFrozen]]
*[[isVehicleLocked]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleOnGround]]

*[[resetVehicleIdleTime]]
*[[resetVehicleExplosionTime]]

*[[setVehicleColor]]
*[[setVehicleFrozen]]
*[[setVehicleLocked]]
*[[setVehicleModel]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleRotation]]
*[[setVehicleTurnVelocity]]
*[[addVehicleUpgrade]]
*[[removeVehicleUpgrade]]
*[[setVehicleDoorState]]
*[[setVehicleWheelStates]]
*[[setVehicleLightState]]
*[[toggleVehicleRespawn]]
*[[setVehicleOverrideLights]]
*[[attachTrailerToVehicle]]
*[[detachTrailerFromVehicle]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleSirensOn]]
*[[setVehicleGunsEnabled]]
*[[setVehicleLandingGearDown]]
*[[setVehicleDamageProof]]
*[[setVehicleRespawnPosition]]
*[[setVehicleRespawnDelay]]
*[[setVehicleIdleRespawnDelay]]

User:DracoBlue

2007-07-17T17:24:10Z

DracoBlue:

User:DracoBlue/DGTAsa

2007-06-01T21:44:42Z

DracoBlue: /* Documented the source to make it working with LuaDoc */

==Implementation==
<syntaxhighlight lang="lua">function inheritsFrom( baseClass )

local new_class = {}
local class_mt = { __index = new_class }

function new_class:create()
local newinst = {}
setmetatable( newinst, class_mt )
return newinst
end

if nil ~= baseClass then
setmetatable( new_class, { __index = baseClass } )
end

-- Implementation of additional OO properties starts here --

-- Return the class object of the instance
function new_class:class()
return new_class
end

-- Return the super class object of the instance
function new_class:superClass()
return baseClass
end

-- Return true if the caller is an instance of theClass
function new_class:isa( theClass )
local b_isa = false

local cur_class = new_class

while ( nil ~= cur_class ) and ( false == b_isa ) do
if cur_class == theClass then
b_isa = true
else
cur_class = cur_class:superClass()
end
end

return b_isa
end

return new_class
end

module("GTAsa")

---
-- The GTAElement
-- @class table
-- @name GTAElement
GTAElement=inheritsFrom(nil)
GTAElement.ID=nil
function GTAElement:className() return "GTAElement" end

---
-- Get Element's `key`-Data
-- @param key string Key of data
-- @return Content
function GTAElement:getData(key)
return getElementData(self.ID,key)
end

---
-- Set Element's `key`-Data
-- @param key string Key of data
-- @param value Value to set.
function GTAElement:setData(key,value)
setElementData(self.ID,key,value)
end

---
-- Get current Position of the Element
-- @return x, y, z
function GTAElement:Position()
return getElementPosition(self.ID)
end

---
-- The GTAPlayer
-- @name GTAPlayer
GTAPlayer=inheritsFrom(GTAElement)
function GTAPlayer:className() return "GTAPlayer" end

---
-- Give a specific amount of ammo of a weapon to the player
-- @param w_id int WeaponID
-- @param ammo int Amount of Ammo
function GTAPlayer:giveWeapon(w_id,ammo)
giveWeapon(self.ID,w_id,ammo)
end

---
-- Get current ping of the player
-- @return int value
function GTAPlayer:Ping()
return getPlayerPing(self.ID)
end

---
-- Get current name of the player
-- @return string name
function GTAPlayer:Name()
return getClientName(self.ID)
end

---
-- Get current rotation of the player
-- @return float value
function GTAPlayer:Rotation()
return getPlayerRotation(self.ID)
end

---
-- Get current amount of health points of player
-- @return int Health of the player
function GTAPlayer:Health()
return getPlayerHealth(self.ID)
end

---
-- Set players current health points
-- @param val int New amount of health a player has
-- @return If it was possible
function GTAPlayer:setHealth(val)
return setPlayerHealth(self.ID,val)
end

---
-- Let a player die by the hand of an attacker
-- @param attacker ID of the attacker
-- @param weapon The weapon the attacker used
-- @param bodypart The bodypart, which was hit
-- @return bool True if it was possible
function GTAPlayer:die(attacker,weapon,bodypart)
return killPlayer(self.ID,attacker,weapon,bodypart)
end

---
-- Check wether player is dead or not
-- @return bool True if the player is dead
function GTAPlayer:isDead()
return isPlayerDead(self.ID)
end

---
-- Check wether player is alive or not
-- @return bool True if the player is alive
function GTAPlayer:isAlive()
return not isPlayerDead(self.ID)
end

---
-- Check wether player is ducked or not
-- @return bool True if the player is ducked
function GTAPlayer:isDucked()
return isPlayerDucked(self.ID)
end</syntaxhighlight>
== Usage ==
<syntaxhighlight lang="lua">
p = GTAPlayer:create()
p.ID=source;
p:setHealth(p:Health()-10)</syntaxhighlight>

GetVehicleIDFromName

2007-05-31T19:01:02Z

DracoBlue: /* Example, added Tabs to the If */

__NOTOC__
This function retrieves the ID of a vehicle as an integer value from its name.

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleIDFromName ( string name )
</syntaxhighlight>

===Required Arguments===
*'''name:''' A [[string]] containing the name of the vehicle.

===Returns===
Returns an [[int]] if the name exists, ''false'' otherwise.

==Example==
This will allow the player to create a vehicle by name and it's ID will be displayed in the chatbox when the vehicle is spawned.
<syntaxhighlight lang="lua">
addCommandHandler ( "spawnvehicle", "createvehiclecommand" )
function createvehiclecommand ( player, commandName, carname )
--This function is triggered by the text "spawnvehicle" in the console.
--The player must also specify the added varible carname to specify
--what car they wish to spawn.
carid = getVehicleIDFromName ( carname )
--Get the ID of the car the player asked for and store it to the
--varible 'carid'
local x, y, z = getElementPosition ( player )
--Get the position of the player to spawn the car near this location
if carid == false then
outputChatBox ( "That is not a valid car name" )
else
createVehicle ( carid, x + 5, y, z )
--Spawn the car using it's ID. Spawn it at x + 5 from the player so it doesn't crush him
outputChatBox ( "A vehicle with an ID of "..carid.." was created!" )
end
--If the entered car name returns no car ID, the string will be empty and false will be returned.
--If the string does have any value, we create the car and announce the car ID in the chatbox,
--because a car did exist under the given car name.
end
</syntaxhighlight>

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

User:DracoBlue/DGTAsa

2007-05-10T08:53:19Z

DracoBlue: /* */

User:DracoBlue

2007-05-01T12:01:55Z

DracoBlue:

== Personal ==
Most stuff can be found on my private site [http://dracoblue.net dracoblue.net].
* [http://dracoblue.net/dev dev-diary]
* [http://gtat.org GTA:Tournament] (League based on SAMP, soon MTA!)
* ''(german)'' [http://www.newsflut.de newsflut.de]
* ''(german)'' [http://wp.dracoblue.net private blog]
* [http://luanet.net/lua Lua API Documentation]

== MTA:Scripting ==
''I'll be away again for about a week (until 17th of May), because I am traveling to games/development presentation if flagshipstudios, I got sponsored by EA to fly to San Francisco. As soon as I am back I'll post first information about the Lua:MissionSystem I'll use in GTA:T for MTA and the free TestLibrary I wrote for practice.''

XmlNodeSetAttribute

2007-04-13T09:42:58Z

DracoBlue: /* Added 'See Also' related functions - added lua-tag to explaining code */

[[Category:Incomplete]]

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

==Syntax==
<syntaxhighlight lang="lua">
bool xmlNodeSetAttribute ( xmlnode xmlnode, string name, var value )
</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}}
{{XML_functions}}

XmlNodeGetValue

2007-04-13T09:42:24Z

DracoBlue: /* *Added lua tags */

[[Category:Incomplete]]

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

==Syntax==
<syntaxhighlight lang="lua">
string xmlNodeGetValue ( xmlnode xmlnode )
</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}}
{{XML_functions}}

XmlNodeGetAttribute

2007-04-13T09:42:00Z

DracoBlue: /* *Added lua tags */

[[Category:Incomplete]]

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

==Syntax==
<syntaxhighlight lang="lua">
string xmlNodeGetAttribute ( xmlnode xmlnode, string name )
</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}}
{{XML_functions}}

XmlNodeSetValue

2007-04-13T09:41:06Z

DracoBlue: /* Added 'See Also' related functions - added lua-tag to explaining code */

[[Category:Incomplete]]

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

==Syntax==
<syntaxhighlight lang="lua">
bool xmlNodeSetValue ( xmlnode xmlnode, var value )
</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}}
{{XML_functions}}

XmlUnloadFile

2007-04-13T09:40:33Z

DracoBlue: /* Added 'See Also' related functions - added lua-tag to explaining code */

[[Category:Incomplete]]

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

==Syntax==
<syntaxhighlight lang="lua">
bool xmlUnloadFile ( xmlnode xmlnode )
</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}}
{{XML_functions}}

XmlNodeGetValue

2007-04-13T09:39:59Z

DracoBlue: /* Added 'See Also' related functions - added lua-tag to explaining code */

[[Category:Incomplete]]

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

==Syntax==
<syntaxhighlight lang="lua">
string xmlNodeGetValue ( xmlnode xmlnode )
</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="xml">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}
{{XML_functions}}

XmlNodeGetAttribute

2007-04-13T09:39:05Z

DracoBlue: /* Added 'See Also' related functions*/

[[Category:Incomplete]]

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

==Syntax==
<syntaxhighlight lang="xml">
string xmlNodeGetAttribute ( xmlnode xmlnode, string name )
</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="xml">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}
{{XML_functions}}

GetClientIP

2006-12-13T22:17:09Z

DracoBlue: /* typo fixed */

__NOTOC__
This function returns a string containing the IP of the client.

==Syntax==
<syntaxhighlight lang="lua">
string getClientIP ( client theClient )
</syntaxhighlight>

===Required Arguments===
* '''theClient:''' The client [[element]] (player or admin) you want to get the IP of.

===Returns===
Returns a string containing the requested client's IP, or ''false'' if the client passed to the function is invalid.

==Example==
This example prints a player's IP to the chat.
<syntaxhighlight lang="lua">
addCommandHandler ( "ip", "printIP" )
function printIP ( thePlayer, key )
outputChatBox ( getClientName ( thePlayer ) .. "'s IP is: " .. getClientIP ( thePlayer ) )
end
</syntaxhighlight>

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

OnPlayerChat

2006-12-04T17:11:55Z

DracoBlue: /* Variables */

[[Category:Incomplete Event]]
__NOTOC__
This event is triggered when a player chats inside the chat box.

==Syntax==
<syntaxhighlight lang="lua">
void onPlayerChat( player tmpplayer, string message )
</syntaxhighlight>

==Variables==
*'''player''': A player element refering to the player who is chatting the message
*'''message''': A string representing the message typed into the chat

===Canceling===
If this event is [[Events#Canceling|canceled]], the game's chatsystem won't deliver the posts. Use [[outputChatBox]] to send the messages then.

==Example==
This example adds the /me command into the script. For example, if a player called Bob types "me likes pie" in console, it will display "* Bob likes pie" in the chatbox.
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerChat ", getRootElement(), "onPlayerChat" ) -- add an event handler for onPlayerChat
function onPlayerChat ( player, message )
if ( strtok ( message , 1, 32 ) == "!createhydra" ) then
x, y, z = getElementPosition ( player )
createVehicle ( 520, x + 5, y, z )
outputChatBox("You got a hydra",player)
end
end
</syntaxhighlight>

==See Also==
{{Event_functions}}
* [[Gettok]]
* [[Split]]

OnPlayerChat

2006-12-04T17:11:30Z

DracoBlue: /* Added description and all necessary stuff, fixed the example. Will check if the Event-Canceling works as it is supposed to, and will remove the InComplete-Tag then */

[[Category:Incomplete Event]]
__NOTOC__
This event is triggered when a player chats inside the chat box.

==Syntax==
<syntaxhighlight lang="lua">
void onPlayerChat( player tmpplayer, string message )
</syntaxhighlight>

==Variables==
*'''player''': A player element refering to the player who used the pickup
*'''message''': A string representing the message typed into the chat

===Canceling===
If this event is [[Events#Canceling|canceled]], the game's chatsystem won't deliver the posts. Use [[outputChatBox]] to send the messages then.

==Example==
This example adds the /me command into the script. For example, if a player called Bob types "me likes pie" in console, it will display "* Bob likes pie" in the chatbox.
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerChat ", getRootElement(), "onPlayerChat" ) -- add an event handler for onPlayerChat
function onPlayerChat ( player, message )
if ( strtok ( message , 1, 32 ) == "!createhydra" ) then
x, y, z = getElementPosition ( player )
createVehicle ( 520, x + 5, y, z )
outputChatBox("You got a hydra",player)
end
end
</syntaxhighlight>

==See Also==
{{Event_functions}}
* [[Gettok]]
* [[Split]]

Client side scripts

2006-12-04T16:53:40Z

DracoBlue: /* More? */

Client side scripts are scripts that run inside the deathmatch mod client side. This means that have access to more information about the game world, but slightly less information about the rest of the players in the game.

==Why are we implementing client scripts now?==
We had planned to do client scripts in a future release, but its become apparent that it may be the fastest way to make a new editor for deathmatch. The alternatives we've got for the editor are:
* Hack the race editor to work with DM: This is possible, but would take a lot of work. The editor currently doesn't even compile with the dm code base and it doesn't support many things that are in dm. The old race editor is a mess code-wise and as a consequence really needs a rewrite to add anything new to it.
* Write a new editor using wxwidgets. This would be ideal, but its clear that this is actually a larger task than we envisioned. We may do this in the future, but we don't have the time right now if we want a release within the next month or so.
* Implement an editor in server side scripts. This could work, but the server is not really aware enough of the client to make it a smooth enough experience. This would be the fastest to do, much of this has already been done.
* Implement client scripts. This is what we intend to do. The advantages are that its something we intended to do in the future anyway, it hopefully won't take too long and we can "open source" the editor script and allow QA to help us write it. This allows us to focus on just writing functionality client and server side, while letting 3rd parties write our scripts for us!

==How will it work?==
It is intended that client side scripts will follow the same pattern as server side scripts. We will provide as many as the same functions client side as exist server side, and we'll provide a simple way of interfacing between the two halves of a script, using the same event system as we already have. Client and server scripts will either have to be in two separate .lua files or within the .map file in a <script> tag.

For example:
<syntaxhighlight lang="xml">
<map>
<script src="race_clientside.lua" runat="client" />
<script src="race_serverside.lua" />
</map>
</syntaxhighlight>

If you wanted to trigger a client side event from the server, you would first have to register the client side event using addEvent. Then, you can attach a handler to the event as you would in a server side script. Then in the server side script, you'll be able to call triggerClientEvent ( player, "eventName", element, args ... ) which will trigger the event client side. The same will be able to be done in reverse.

For example:
'''Client side:'''
<syntaxhighlight lang="lua">
addEvent("ShowObjectBrowser", "id")
addEventHandler("ShowObjectBrowser", getRootElement(), "showObjectBrowser")
function showObjectBrowser(id)
-- code here
end
</syntaxhighlight>
'''Server side:'''
<syntaxhighlight lang="lua">
triggerClientEvent ( source, "ShowObjectBrowser", getRootElement(), 1034 )
</syntaxhighlight>

==More?==
First draft, pester me (eAi) to answer anything I've missed or isn't clear.
*Perfect. I don't know if it was mentioned before, but it would be really good to have extended camera movement (not like normal in game). So that you can move up, down, forward and so on with keys and move the place where camera looks at with mouse. --[[User:DracoBlue|DracoBlue]] 10:53, 4 December 2006 (CST)

SetPlayerStat

2006-12-03T21:32:43Z

DracoBlue: /* Required Arguments */

{{Needs_Checking|Need a section to define what maxs the bar out and what values attain new shooting levels}}

__NOTOC__
This function allows you to set the float value of a specific statistic for a [[player]].

==Syntax==
<syntaxhighlight lang="lua">bool setPlayerStat ( element player, stat, float value )</syntaxhighlight>

===Required Arguments===
*'''player''': the [[player]] whose statistic you want to modify.
*'''stat''': A whole number determining the stat ID.
{{Stats}}
*'''value''': A float number the stat will be set to. (0..999)

===Returns===
Returns ''true'' if the statistic was changed succesfully. Returns ''false'' if an invalid player is specified, or the stat-id/value is out of acceptable range.

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

SetPlayerStat

2006-12-03T21:32:14Z

DracoBlue:

{{Needs_Checking|Need a section to define what maxs the bar out and what values attain new shooting levels}}

__NOTOC__
This function allows you to set the float value of a specific statistic for a [[player]].

==Syntax==
<syntaxhighlight lang="lua">bool setPlayerStat ( element player, stat, float value )</syntaxhighlight>

===Required Arguments===
*'''player''': the [[player]] whose statistic you want to modify.
*'''stat''': A whole number determining the stat ID. (0..999)
{{Stats}}
*'''value''': A float number the stat will be set to.

===Returns===
Returns ''true'' if the statistic was changed succesfully. Returns ''false'' if an invalid player is specified, or the stat-id/value is out of acceptable range.

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

SetPlayerRotation

2006-12-03T21:20:29Z

DracoBlue: /* Syntax */

[[Category:Incomplete]]

__NOTOC__
Thid function allows you to set the current rotation of the specified player.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerRotation ( player theplayer, float rotation )
</syntaxhighlight>

===Required Arguments===
*'''theplayer:''' An [[player]] referring to a player.
*'''rotation:''' A [[float]] specifying the desired rotation.

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

==Example==
This example does...
<syntaxhighlight lang="lua">
-- rotate the player, so that he looks to the south
setPlayerRotation ( player, 180 )
</syntaxhighlight>

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

[[Category:Incomplete]]

SetPlayerRotation

2006-12-03T21:19:19Z

DracoBlue: /* Added small example to show that it works with degrees and not radiant*/

[[Category:Incomplete]]

__NOTOC__
Thid function allows you to set the current rotation of the specified player.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerRotation ( element player, float rotation )
</syntaxhighlight>

===Required Arguments===
*'''player:''' An [[element]] referring to a player.
*'''rotation:''' A [[float]] specifying the desired rotation.

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

==Example==
This example does...
<syntaxhighlight lang="lua">
-- rotate the player, so that he looks to the south
setPlayerRotation ( player, 180 )
</syntaxhighlight>

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

[[Category:Incomplete]]

Template:Player functions

2006-12-03T14:53:19Z

DracoBlue: /* Removed the ip thing, because you must use getClientIP :-) */

* [[addPlayerClothes]]
* [[canPlayerUseFunction]]
* [[doesPlayerHaveJetPack]]
* [[getPlayerArmor]]
* [[getPlayerClothes]]
* [[getPlayerCount]]
* [[getPlayerAmmoInClip]]
* [[getPlayerTotalAmmo]]
* [[getPlayerCurrentWeaponID]]
* [[getPlayerFromNick]]
* [[getPlayerHealth]]
* [[getPlayerLevel]]
* [[getPlayerMoney]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerOccupiedVehicleSeat]]
* [[getPlayerPing]]
* [[getPlayerRotation]]
* [[getPlayerSkin]]
* [[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]]

GetPlayerPing

2006-12-03T13:30:12Z

DracoBlue: /* Syntax, to make it equal to style at getplayerwantedlevel */

__NOTOC__
This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or the reverse.

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

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

==Example==
<syntaxhighlight lang="lua">intPing = getPlayerPing ( findPlayer ( "Someguy" ) )
outputChatBox ( "Someguy's ping is " .. intPing .. "." )</syntaxhighlight>

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