Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function redirects the player to a specified server.

Note

A resource using this function needs ACL rights in order to work (function.redirectPlayer)

OOP Syntax Help! I don't understand this!

• Method:player:redirect(...)

Syntax

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

Required Arguments

• thePlayer: The player you want to redirect

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• serverIP (default: ""): The IP address (or domain name that resolves to the IP address) of the server you want to redirect the player to. Use an empty string to reconnect to the same server.
• serverPort (default: 0): The game port of the server you want to redirect the player to, this is usually 22003. Set to zero to use the same port as the current server.
• serverPassword (default: ""): The password for the server if it's protected

Returns

• bool: value

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

Code Examples

Example 1 Example 2 Example 3

shared

This example auto-redirects all connecting players to another given servers' IP:port.

local ip_port = "123.123.1.2:1234"  -- enter IP and port in format: 192.168.1.1:22003
local password = "password_placeholder" -- If the server is passworded insert password here (if no password, it wont use the value)

function onConnectRedirect()
  redirectPlayer(source, gettok(ip_port,1,":"), tonumber(gettok(ip_port,2,":")), password)
end
addEventHandler ("onPlayerJoin", root, onConnectRedirect)

shared

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)

shared

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

function rejoinMe(thePlayer, theCommand)
    redirectPlayer(thePlayer)
end
addCommandHandler("rejoin", rejoinMe) -- Attach rejoin command to our function

See Also

Player Functions

• countPlayersInTeam
• forcePlayerMap
• getAlivePlayers
• getControlState
• getDeadPlayers
• getLocalPlayer
• getPlayerAnnounceValue
• getPlayerBlurLevel
• getPlayerCount
• getPlayerFromName
• getPlayerHudComponentProperty
• getPlayerIdleTime
• getPlayerIP
• getPlayerMapBoundingBox
• getPlayerMapOpacity
• getPlayerMoney
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerScriptDebugLevel
• getPlayerSerial
• getPlayersInTeam
• getPlayerTeam
• getPlayerVersion
• getPlayerWantedLevel
• getRandomPlayer
• givePlayerMoney
• isPlayerCrosshairVisible
• isPlayerHudComponentVisible
• isPlayerMapForced
• isPlayerMapVisible
• isPlayerMuted
• isPlayerNametagShowing
• isVoiceEnabled
• redirectPlayer
• resendPlayerACInfo
• resendPlayerModInfo
• resetPlayerHudComponentProperty
• setControlState
• setPlayerAnnounceValue
• setPlayerBlurLevel
• setPlayerHudComponentProperty
• setPlayerHudComponentVisible
• setPlayerMoney
• setPlayerMuted
• setPlayerName
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• setPlayerScriptDebugLevel
• setPlayerTeam
• setPlayerVoiceBroadcastTo
• setPlayerVoiceIgnoreFrom
• setPlayerWantedLevel
• spawnPlayer
• takePlayerMoney
• takePlayerScreenShot

Player Events

• onClientPlayerChangeNick
• onClientPlayerChoke
• onClientPlayerDamage
• onClientPlayerHeliKilled
• onClientPlayerHitByWaterCannon
• onClientPlayerJoin
• onClientPlayerPickupHit
• onClientPlayerPickupLeave
• onClientPlayerQuit
• onClientPlayerRadioSwitch
• onClientPlayerSpawn
• onClientPlayerStealthKill
• onClientPlayerStuntFinish
• onClientPlayerStuntStart
• onClientPlayerTarget
• onClientPlayerVehicleEnter
• onClientPlayerVehicleExit
• onClientPlayerVoicePause
• onClientPlayerVoiceResumed
• onClientPlayerVoiceStart
• onClientPlayerVoiceStop
• onClientPlayerWasted
• onClientPlayerWeaponFire
• onClientPlayerWeaponSwitch
• onPlayerACInfo
• onPlayerBan
• onPlayerChangeNick
• onPlayerChangesProtectedData
• onPlayerChangesWorldSpecialProperty
• onPlayerChat
• onPlayerClick
• onPlayerCommand
• onPlayerConnect
• onPlayerContact
• onPlayerDamage
• onPlayerDetonateSatchels
• onPlayerDiscordJoin
• onPlayerJoin
• onPlayerLogin
• onPlayerLogout
• onPlayerMarkerHit
• onPlayerMarkerLeave
• onPlayerModInfo
• onPlayerMute
• onPlayerNetworkStatus
• onPlayerPickupHit
• onPlayerPickupLeave
• onPlayerPickupUse
• onPlayerPrivateMessage
• onPlayerProjectileCreation
• onPlayerQuit
• onPlayerScreenShot
• onPlayerSpawn
• onPlayerStealthKill
• onPlayerTarget
• onPlayerTeamChange
• onPlayerTeleport
• onPlayerTriggerEventThreshold
• onPlayerTriggerInvalidEvent
• onPlayerUnmute
• onPlayerVehicleEnter
• onPlayerVehicleExit
• onPlayerVoiceStart
• onPlayerVoiceStop
• onPlayerWasted
• onPlayerWeaponFire
• onPlayerWeaponReload
• onPlayerWeaponSwitch

Reference

• Scripting Functions