Home Getting Started With Scripts Commands Examples
BracketDumpers BracketHandlers BracketValidators

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);
ParameterTypeDescriptionOptionalDefaultValue
Parameter
command
Type
string
Description
No Description Provided
Optional
false
DefaultValue
Parameter
silent
Type
boolean
Description
No Description Provided
Optional
true
DefaultValue
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);
ParameterTypeDescriptionOptionalDefaultValue
Parameter
command
Type
string
Description
No Description Provided
Optional
false
DefaultValue
Parameter
player
Type
Player
Description
No Description Provided
Optional
false
DefaultValue
Parameter
silent
Type
boolean
Description
No Description Provided
Optional
true
DefaultValue
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
ParameterTypeDescription
Parameter
location
Type
ResourceLocation
Description
No Description Provided

Return Type: int

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

Return Type: invalid

script.zs
// Server.getModdedStatus() as invalid
myServer.getModdedStatus();

Return Type: string

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

Return Type: int

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

Return Type: int

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

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
ParameterTypeDescription
Parameter
level
Type
ServerLevel
Description
No Description Provided

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
ParameterTypeDescription
Parameter
level
Type
ServerLevel
Description
No Description Provided
Parameter
pos
Type
BlockPos
Description
No Description Provided
Parameter
player
Type
Player
Description
No Description Provided

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();

Return Type: void

script.zs
Server.setDefaultGameType(gameType as GameType) as void
ParameterTypeDescription
Parameter
gameType
Type
GameType
Description
No Description Provided

Return Type: void

script.zs
Server.setDifficulty(difficulty as Difficulty, force as boolean) as void
ParameterTypeDescription
Parameter
difficulty
Type
Difficulty
Description
No Description Provided
Parameter
force
Type
boolean
Description
No Description Provided

Return Type: void

script.zs
Server.setDifficultyLocked(locked as boolean) as void
ParameterTypeDescription
Parameter
locked
Type
boolean
Description
No Description Provided

Return Type: void

script.zs
Server.setEnforceWhitelist(enforceWhitelist as boolean) as void
ParameterTypeDescription
Parameter
enforceWhitelist
Type
boolean
Description
No Description Provided

Return Type: void

script.zs
Server.setFlightAllowed(flightAllowed as boolean) as void
ParameterTypeDescription
Parameter
flightAllowed
Type
boolean
Description
No Description Provided

Return Type: void

script.zs
Server.setMotd(motd as string) as void
ParameterTypeDescription
Parameter
motd
Type
string
Description
No Description Provided

Return Type: void

script.zs
Server.setPvpAllowed(pvpAllowed as boolean) as void
ParameterTypeDescription
Parameter
pvpAllowed
Type
boolean
Description
No Description Provided

Properties

NameTypeHas GetterHas SetterDescription
Name
absoluteMaxWorldSize
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
allLevels
Type
stdlib.Iterable<ServerLevel>
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
areNpcsEnabled
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
averageTickTime
Type
float
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
defaultGameTime
Type
GameType
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
forcedGameType
Type
GameType
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isCommandBlockEnabled
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isDedicatedServer
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isEnforceWhitelist
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isFlightAllowed
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isHardcore
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isNetherEnabled
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isPvpAllowed
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isReady
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isRunning
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isShutdown
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isSingleplayer
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isSpawningAnimals
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isSpawningMonsters
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isStopped
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
levelKeys
Type
stdlib.List<ResourceLocation>
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
maxPlayer
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
moddeStatus
Type
invalid
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
motd
Type
string
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
operatorUserPermissionLevel
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
overworld
Type
ServerLevel
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
playerCount
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
playerNames
Type
string[]
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
serverModName
Type
string
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
serverVersion
Type
string
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
spawnProtectionRadius
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
tickCount
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided