Importing the class

Link to 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.

ZenScript
Copy
import crafttweaker.api.game.Server;

Implemented Interfaces

Link to implemented-interfaces

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

Name: areNpcsEnabled

Return Type: boolean

ZenScript
Copy
// Server.areNpcsEnabled() as boolean

myServer.areNpcsEnabled();

Name: executeCommand

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

ZenScript
Copy
// Server.executeCommand(command as string, silent as boolean)

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

Name: executeCommand

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

ZenScript
Copy
// Server.executeCommand(command as string, player as Player, silent as boolean)

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

Link to getAbsoluteMaxWorldSize

Name: getAbsoluteMaxWorldSize

Return Type: int

ZenScript
Copy
// Server.getAbsoluteMaxWorldSize() as int

myServer.getAbsoluteMaxWorldSize();

Name: getAllLevels

Return Type: stdlib.Iterable<ServerLevel>

ZenScript
Copy
// Server.getAllLevels() as stdlib.Iterable<ServerLevel>

myServer.getAllLevels();

Link to getCurrentSmoothedTickTime

Name: getCurrentSmoothedTickTime

Return Type: float

ZenScript
Copy
// Server.getCurrentSmoothedTickTime() as float

myServer.getCurrentSmoothedTickTime();

Link to getDefaultGameType

Name: getDefaultGameType

Return Type: GameType

ZenScript
Copy
// Server.getDefaultGameType() as GameType

myServer.getDefaultGameType();

Link to getForcedGameType

Name: getForcedGameType

Return Type: GameType?

ZenScript
Copy
// Server.getForcedGameType() as GameType?

myServer.getForcedGameType();

Name: getLevel

Return Type: ServerLevel?

ZenScript
Copy
Server.getLevel(location as ResourceLocation) as ServerLevel?
ParameterType
Parameter
location
Type
ResourceLocation

Name: getMaxPlayers

Return Type: int

ZenScript
Copy
// Server.getMaxPlayers() as int

myServer.getMaxPlayers();

Name: getModdedStatus

Return Type: string?

ZenScript
Copy
// Server.getModdedStatus() as string?

myServer.getModdedStatus();

Name: getMotd

Return Type: string

ZenScript
Copy
// Server.getMotd() as string

myServer.getMotd();

Link to getOperatorUserPermissionLevel

Name: getOperatorUserPermissionLevel

Return Type: int

ZenScript
Copy
// Server.getOperatorUserPermissionLevel() as int

myServer.getOperatorUserPermissionLevel();

Link to getOverworldData

Name: getOverworldData

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

ZenScript
Copy
// Server.getOverworldData() as CraftTweakerSavedData

myServer.getOverworldData();

Name: getPlayerCount

Return Type: int

ZenScript
Copy
// Server.getPlayerCount() as int

myServer.getPlayerCount();

Name: getPlayerList

Return Type: PlayerList

ZenScript
Copy
// Server.getPlayerList() as PlayerList

myServer.getPlayerList();

Name: getPlayerNames

Return Type: string[]

ZenScript
Copy
// Server.getPlayerNames() as string[]

myServer.getPlayerNames();

Link to getServerModName

Name: getServerModName

Return Type: string

ZenScript
Copy
// Server.getServerModName() as string

myServer.getServerModName();

Link to getServerVersion

Name: getServerVersion

Return Type: string

ZenScript
Copy
// Server.getServerVersion() as string

myServer.getServerVersion();

Link to getSpawnProtectionRadius

Name: getSpawnProtectionRadius

Return Type: int

ZenScript
Copy
// Server.getSpawnProtectionRadius() as int

myServer.getSpawnProtectionRadius();

Name: getSpawnRadius

Return Type: int

ZenScript
Copy
Server.getSpawnRadius(level as ServerLevel?) as int
ParameterType
Parameter
level
Type
ServerLevel?

Name: getTickCount

Return Type: int

ZenScript
Copy
// Server.getTickCount() as int

myServer.getTickCount();

Link to isCommandBlockEnabled

Name: isCommandBlockEnabled

Return Type: boolean

ZenScript
Copy
// Server.isCommandBlockEnabled() as boolean

myServer.isCommandBlockEnabled();

Link to isDedicatedServer

Name: isDedicatedServer

Return Type: boolean

ZenScript
Copy
// Server.isDedicatedServer() as boolean

myServer.isDedicatedServer();

Link to isEnforceWhitelist

Name: isEnforceWhitelist

Return Type: boolean

ZenScript
Copy
// Server.isEnforceWhitelist() as boolean

myServer.isEnforceWhitelist();

Name: isFlightAllowed

Return Type: boolean

ZenScript
Copy
// Server.isFlightAllowed() as boolean

myServer.isFlightAllowed();

Name: isHardcore

Return Type: boolean

ZenScript
Copy
// Server.isHardcore() as boolean

myServer.isHardcore();

Name: isNetherEnabled

Return Type: boolean

ZenScript
Copy
// Server.isNetherEnabled() as boolean

myServer.isNetherEnabled();

Name: isPvpAllowed

Return Type: boolean

ZenScript
Copy
// Server.isPvpAllowed() as boolean

myServer.isPvpAllowed();

Name: isReady

Return Type: boolean

ZenScript
Copy
// Server.isReady() as boolean

myServer.isReady();

Name: isRunning

Return Type: boolean

ZenScript
Copy
// Server.isRunning() as boolean

myServer.isRunning();

Name: isShutdown

Return Type: boolean

ZenScript
Copy
// Server.isShutdown() as boolean

myServer.isShutdown();

Name: isSingleplayer

Return Type: boolean

ZenScript
Copy
// Server.isSingleplayer() as boolean

myServer.isSingleplayer();

Link to isSpawningAnimals

Name: isSpawningAnimals

Return Type: boolean

ZenScript
Copy
// Server.isSpawningAnimals() as boolean

myServer.isSpawningAnimals();

Link to isSpawningMonsters

Name: isSpawningMonsters

Return Type: boolean

ZenScript
Copy
// Server.isSpawningMonsters() as boolean

myServer.isSpawningMonsters();

Name: isStopped

Return Type: boolean

ZenScript
Copy
// Server.isStopped() as boolean

myServer.isStopped();

Link to isUnderSpawnProtection

Name: isUnderSpawnProtection

Return Type: boolean

ZenScript
Copy
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

Name: levelKeys

Return Type: stdlib.List<ResourceLocation>

ZenScript
Copy
// Server.levelKeys() as stdlib.List<ResourceLocation>

myServer.levelKeys();

Name: overworld

Return Type: ServerLevel

ZenScript
Copy
// Server.overworld() as ServerLevel

myServer.overworld();

Link to setDefaultGameType

Name: setDefaultGameType

ZenScript
Copy
Server.setDefaultGameType(gameType as GameType)
ParameterType
Parameter
gameType
Type
GameType

Name: setDifficulty

ZenScript
Copy
Server.setDifficulty(difficulty as Difficulty, force as boolean)
ParameterType
Parameter
difficulty
Type
Difficulty
Parameter
force
Type
boolean

Link to setDifficultyLocked

Name: setDifficultyLocked

ZenScript
Copy
Server.setDifficultyLocked(locked as boolean)
ParameterType
Parameter
locked
Type
boolean

Link to setEnforceWhitelist

Name: setEnforceWhitelist

ZenScript
Copy
Server.setEnforceWhitelist(enforceWhitelist as boolean)
ParameterType
Parameter
enforceWhitelist
Type
boolean

Link to setFlightAllowed

Name: setFlightAllowed

ZenScript
Copy
Server.setFlightAllowed(flightAllowed as boolean)
ParameterType
Parameter
flightAllowed
Type
boolean

Name: setMotd

ZenScript
Copy
Server.setMotd(motd as string)
ParameterType
Parameter
motd
Type
string

Name: setPvpAllowed

ZenScript
Copy
Server.setPvpAllowed(pvpAllowed as boolean)
ParameterType
Parameter
pvpAllowed
Type
boolean
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
currentSmoothedTickTime
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