Home Commands Examples Getting Started With Scripts Global Keywords

Server

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

script.zs
import crafttweaker.api.game.Server;

Implemented Interfaces

Server implements the following interfaces. That means all methods defined in these interfaces are also available in Server

Methods

Return Type: boolean

script.zs
// Server.areNpcsEnabled() as boolean
myServer.areNpcsEnabled();

Runs a command, if silent is true, the output is hidden.

Returns The success value of the command, or 0 if an exception occurred.

Note: Some commands’ success value is 0

Return Type: int

script.zs
// Server.executeCommand(command as string, silent as boolean) as int
myServer.executeCommand("time set day", true);
ParameterTypeOptionalDefault Value
Parameter
command
Type
string
Optional
false
Default Value
Parameter
silent
Type
boolean
Optional
true
Default Value
false

let a player send a command, if silent is true, the output is hidden.

Returns The success value of the command, or 0 if an exception occurred.

Note: Some commands’ success value is 0

Return Type: int

script.zs
// Server.executeCommand(command as string, player as Player, silent as boolean) as int
myServer.executeCommand("time set day", player, true);
ParameterTypeOptionalDefault Value
Parameter
command
Type
string
Optional
false
Default Value
Parameter
player
Type
Player
Optional
false
Default Value
Parameter
silent
Type
boolean
Optional
true
Default Value
false

Return Type: int

script.zs
// Server.getAbsoluteMaxWorldSize() as int
myServer.getAbsoluteMaxWorldSize();

Return Type: stdlib.Iterable<ServerLevel>

script.zs
// Server.getAllLevels() as stdlib.Iterable<ServerLevel>
myServer.getAllLevels();

Return Type: float

script.zs
// Server.getAverageTickTime() as float
myServer.getAverageTickTime();

Return Type: GameType

script.zs
// Server.getDefaultGameType() as GameType
myServer.getDefaultGameType();

Return Type: GameType?

script.zs
// Server.getForcedGameType() as GameType?
myServer.getForcedGameType();

Return Type: ServerLevel?

script.zs
Server.getLevel(location as ResourceLocation) as ServerLevel?
ParameterType
Parameter
location
Type
ResourceLocation

Return Type: int

script.zs
// Server.getMaxPlayers() as int
myServer.getMaxPlayers();

Return Type: string?

script.zs
// Server.getModdedStatus() as string?
myServer.getModdedStatus();

Return Type: string

script.zs
// Server.getMotd() as string
myServer.getMotd();

Return Type: int

script.zs
// Server.getOperatorUserPermissionLevel() as int
myServer.getOperatorUserPermissionLevel();

Gets the custom data of the overworld.

The overworld is always loaded, so this can be used to store and access data no matter what level a player may be in.

Returns: The overworld’s custom data.
Return Type: CraftTweakerSavedData

script.zs
// Server.getOverworldData() as CraftTweakerSavedData
myServer.getOverworldData();

Return Type: int

script.zs
// Server.getPlayerCount() as int
myServer.getPlayerCount();

Return Type: PlayerList

script.zs
// Server.getPlayerList() as PlayerList
myServer.getPlayerList();

Return Type: string[]

script.zs
// Server.getPlayerNames() as string[]
myServer.getPlayerNames();

Return Type: string

script.zs
// Server.getServerModName() as string
myServer.getServerModName();

Return Type: string

script.zs
// Server.getServerVersion() as string
myServer.getServerVersion();

Return Type: int

script.zs
// Server.getSpawnProtectionRadius() as int
myServer.getSpawnProtectionRadius();

Return Type: int

script.zs
Server.getSpawnRadius(level as ServerLevel?) as int
ParameterType
Parameter
level
Type
ServerLevel?

Return Type: int

script.zs
// Server.getTickCount() as int
myServer.getTickCount();

Return Type: boolean

script.zs
// Server.isCommandBlockEnabled() as boolean
myServer.isCommandBlockEnabled();

Return Type: boolean

script.zs
// Server.isDedicatedServer() as boolean
myServer.isDedicatedServer();

Return Type: boolean

script.zs
// Server.isEnforceWhitelist() as boolean
myServer.isEnforceWhitelist();

Return Type: boolean

script.zs
// Server.isFlightAllowed() as boolean
myServer.isFlightAllowed();

Return Type: boolean

script.zs
// Server.isHardcore() as boolean
myServer.isHardcore();

Return Type: boolean

script.zs
// Server.isNetherEnabled() as boolean
myServer.isNetherEnabled();

Return Type: boolean

script.zs
// Server.isPvpAllowed() as boolean
myServer.isPvpAllowed();

Return Type: boolean

script.zs
// Server.isReady() as boolean
myServer.isReady();

Return Type: boolean

script.zs
// Server.isRunning() as boolean
myServer.isRunning();

Return Type: boolean

script.zs
// Server.isShutdown() as boolean
myServer.isShutdown();

Return Type: boolean

script.zs
// Server.isSingleplayer() as boolean
myServer.isSingleplayer();

Return Type: boolean

script.zs
// Server.isSpawningAnimals() as boolean
myServer.isSpawningAnimals();

Return Type: boolean

script.zs
// Server.isSpawningMonsters() as boolean
myServer.isSpawningMonsters();

Return Type: boolean

script.zs
// Server.isStopped() as boolean
myServer.isStopped();

Return Type: boolean

script.zs
Server.isUnderSpawnProtection(level as ServerLevel, pos as BlockPos, player as Player) as boolean
ParameterType
Parameter
level
Type
ServerLevel
Parameter
pos
Type
BlockPos
Parameter
player
Type
Player

Return Type: stdlib.List<ResourceLocation>

script.zs
// Server.levelKeys() as stdlib.List<ResourceLocation>
myServer.levelKeys();

Return Type: ServerLevel

script.zs
// Server.overworld() as ServerLevel
myServer.overworld();
script.zs
Server.setDefaultGameType(gameType as GameType)
ParameterType
Parameter
gameType
Type
GameType
script.zs
Server.setDifficulty(difficulty as Difficulty, force as boolean)
ParameterType
Parameter
difficulty
Type
Difficulty
Parameter
force
Type
boolean
script.zs
Server.setDifficultyLocked(locked as boolean)
ParameterType
Parameter
locked
Type
boolean
script.zs
Server.setEnforceWhitelist(enforceWhitelist as boolean)
ParameterType
Parameter
enforceWhitelist
Type
boolean
script.zs
Server.setFlightAllowed(flightAllowed as boolean)
ParameterType
Parameter
flightAllowed
Type
boolean
script.zs
Server.setMotd(motd as string)
ParameterType
Parameter
motd
Type
string
script.zs
Server.setPvpAllowed(pvpAllowed as boolean)
ParameterType
Parameter
pvpAllowed
Type
boolean

Properties

NameTypeHas GetterHas SetterDescription
Name
absoluteMaxWorldSize
Type
int
Has Getter
true
Has Setter
false
Description
Name
allLevels
Type
stdlib.Iterable<ServerLevel>
Has Getter
true
Has Setter
false
Description
Name
areNpcsEnabled
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
averageTickTime
Type
float
Has Getter
true
Has Setter
false
Description
Name
defaultGameTime
Type
GameType
Has Getter
true
Has Setter
false
Description
Name
forcedGameType
Type
GameType?
Has Getter
true
Has Setter
false
Description
Name
isCommandBlockEnabled
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isDedicatedServer
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isEnforceWhitelist
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isFlightAllowed
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isHardcore
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isNetherEnabled
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isPvpAllowed
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isReady
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isRunning
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isShutdown
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isSingleplayer
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isSpawningAnimals
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isSpawningMonsters
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
isStopped
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
levelKeys
Type
stdlib.List<ResourceLocation>
Has Getter
true
Has Setter
false
Description
Name
maxPlayer
Type
int
Has Getter
true
Has Setter
false
Description
Name
moddeStatus
Type
string?
Has Getter
true
Has Setter
false
Description
Name
motd
Type
string
Has Getter
true
Has Setter
false
Description
Name
operatorUserPermissionLevel
Type
int
Has Getter
true
Has Setter
false
Description
Name
overworld
Type
ServerLevel
Has Getter
true
Has Setter
false
Description
Name
overworldData
Type
CraftTweakerSavedData
Has Getter
true
Has Setter
false
Description
Gets the custom data of the overworld.

The overworld is always loaded, so this can be used to store and access data no matter what level a player may be in.
Name
playerCount
Type
int
Has Getter
true
Has Setter
false
Description
Name
playerList
Type
PlayerList
Has Getter
true
Has Setter
false
Description
Name
playerNames
Type
string[]
Has Getter
true
Has Setter
false
Description
Name
serverModName
Type
string
Has Getter
true
Has Setter
false
Description
Name
serverVersion
Type
string
Has Getter
true
Has Setter
false
Description
Name
spawnProtectionRadius
Type
int
Has Getter
true
Has Setter
false
Description
Name
tickCount
Type
int
Has Getter
true
Has Setter
false
Description