RedirectPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 10: Line 10:
===Required Arguments===
===Required Arguments===
*'''thePlayer:''' The player you want to redirect
*'''thePlayer:''' The player you want to redirect
*'''serverIP:''' The ip of the server you want to redirect the player to
*'''serverIP:''' The IP address (or domain name that resolves to the IP address) of the server you want to redirect the player to
*'''serverPort:''' The game port of the server you want to redirect the player to
*'''serverPort:''' The game port of the server you want to redirect the player to, this is usually 22003


===Optional Arguments===
===Optional Arguments===

Revision as of 14:46, 9 September 2013

This function redirects the player to a specified server.

Syntax

bool redirectPlayer ( player thePlayer, string serverIP, int serverPort, [ string serverPassword ] )

Required Arguments

  • thePlayer: The player you want to redirect
  • serverIP: The IP address (or domain name that resolves to the IP address) of the server you want to redirect the player to
  • serverPort: The game port of the server you want to redirect the player to, this is usually 22003

Optional Arguments

  • serverPassword: The password for the server if it's protected

Returns

Returns true if the player was redirected successfully, false if bad arguments were passed.

Example

This example adds a "joinserver" command using the syntax, "/joinserver serverIP serverPort [serverPassword]". 

function joinserverHandlerFunction (playerSource, commandName, serverIP, serverPort, serverPassword)
	if serverIP and serverPort then --if IP and Port were specified
		if serverPassword then --if also a password was specified
			redirectPlayer (playerSource, serverIP, tonumber(serverPort), serverPassword) --redirect the player
		else -- else if no password was specified
			redirectPlayer (playerSource, serverIP, tonumber(serverPort))  --redirect the player without using the serverPassword parameter
		end
	else -- if no IP or Port have been specified
		outputChatBox ("Error! Correct Syntax: /joinserver IP Port [Password]", playerSource) --output an Error message to the chatbox
	end
end

addCommandHandler ("joinserver", joinserverHandlerFunction)

This example adds a "rejoin" command like the inbuilt reconnect command. 

function rejoinMe(thePlayer, theCommand)
    redirectPlayer(thePlayer) -- This only works in 1.1.1-9.03429 and onwards
end
addCommandHandler("rejoin", rejoinMe) -- Attach rejoin command to our function

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/RedirectPlayer?oldid=37074"