ModPE API

Namespace: Server

Server

Static methods for the Server API

Methods

staticServer.getAddress(){string}

server.jsdoc, line 8

Return the server IP address.

Returns:
Type Description
string
  • the IP address
Example
// ?
clientMessage(Server.getAddress()); // prints '84.45.129.7'

staticServer.getAllPlayerNames(){Array.<string>}

server.jsdoc, line 22

Return the names of all players on the server.

Returns:
Type Description
Array.<string>
  • the player names
Example
// announce all players online
var players = Server.getAllPlayerNames();
for (var i = 0; i < players.length; i++) {
  clientMessage(players[i] + " is online!");
}

staticServer.getAllPlayers(){Array.<long>}

server.jsdoc, line 39

Return the entity IDs of all players on the server.

Returns:
Type Description
Array.<long>
  • the player IDs
Example
// announce all players online
var players = Server.getAllPlayers();
for (var i = 0; i < players.length; i++) {
  clientMessage(Player.getName(players[i]) + " is online!");
}

staticServer.getPort(){int}

server.jsdoc, line 56

Return the port number of the current remote connection.

Returns:
Type Description
int
  • the port number
Example
// ?
clientMessage("The current server port is: " + Server.getPort());

staticServer.joinServer(address, port)

server.jsdoc, line 70

Connect to a remote server.

Name Type Description
address string

the server's IP address
port int

the port number
Example
// ?
Server.joinServer("84.45.129.7", 19132);

staticServer.sendChat(text)

server.jsdoc, line 85

Send a chat message.

Name Type Description
text string

the message text
Example
// ?
Server.sendChat("Herobrine is fake!!");