GetPlayerIP: Difference between revisions

Revision as of 14:19, 27 March 2009

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

string getPlayerIP ( player thePlayer )

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

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

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

@@ Line 1: / Line 1: @@
 {{Server function}}
 __NOTOC__
-This function returns a string containing the IP address of the client.
+This function returns a [[string]] containing the IP address of the [[player]].
 ==Syntax==
 <syntaxhighlight lang="lua">
-string getPlayerIP ( client theClient )
+string getPlayerIP ( player thePlayer )
 </syntaxhighlight>
 ===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 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==
 This example prints a player's IP to the chat.
 <syntaxhighlight lang="lua">
-function printIp(thePlayer)
+function printIp ( thePlayer )
-	outputChatBox("IP: "..getPlayerIP(thePlayer), thePlayer)
+	outputChatBox ( "IP: " .. getPlayerIP ( thePlayer ), thePlayer )
 end
+addCommandHandler ( "ip", printIp )
-addCommandHandler("ip", printIp)
 </syntaxhighlight>
 ==See Also==
 {{Player functions}}