GetPlayerIP: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
{{Server function}}
{{Server function}}
__NOTOC__
This function returns a [[string]] containing the IP address of the [[player]].
This function returns a string containing the IP address of the client.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getPlayerIP ( client theClient )
string getPlayerIP ( player thePlayer )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[player]]:getIP|ip|}}
===Required Arguments===
===Required Arguments===
* '''theClient:''' The client [[element]] (player or admin) you want to get the IP of.
* '''thePlayer:''' The [[player]] element you want to get the IP of.


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


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


==See Also==
==See Also==
{{Server_function}}
{{Player functions}}
 
[[de:getPlayerIP]]
[[ru:getPlayerIP]]

Latest revision as of 22:13, 30 September 2014

This function returns a string containing the IP address of the player.

Syntax

string getPlayerIP ( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:getIP(...)
Variable: .ip


Required Arguments

  • thePlayer: The player element you want to get the IP of.

Returns

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

Example

This example prints a player's IP to the chat.

function printIp ( thePlayer )
	outputChatBox ( "IP: " .. getPlayerIP ( thePlayer ), thePlayer )
end
addCommandHandler ( "ip", printIp )

See Also

Shared