Manual Review Required

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

---

This function returns the current password required to join the server.

Syntax

string getServerPassword ( )

Returns

• string: value

Returns the current server password as a string if it has a password, if not it returns nil .

Code Examples

shared

This example prints the serverpassword to the player

function viewPassword ( thePlayer, command )
  -- Put the password in a var
  local password = getServerPassword ()

  -- Check if the server has a password
  -- If the server has an password, echo it
  if password then
    outputChatBox ( "The server password is " .. password, thePlayer )

  -- Else print that there isnt any password
  else
    outputChatBox ( "The server doesn't have any password set", thePlayer )
  end
end

-- Add console command 'viewpassword'
addCommandHandler ( "viewpassword", viewPassword )

See Also

Server Functions

• getMaxPlayers
• getServerConfigSetting
• getServerHttpPort
• getServerIpFromMasterServer
• getServerName
• getServerPassword
• getServerPort
• isGlitchEnabled
• setGlitchEnabled
• setMaxPlayers
• setServerConfigSetting
• setServerPassword
• shutdown

Server Events

• onBan
• onChatMessage
• onDebugMessage
• onExplosion
• onSettingChange
• onShutdown
• onUnban

Server Elements

• console

Reference

• Scripting Functions