Server - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

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

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

CommandSource
AutoCloseable

Methods

areNpcsEnabled

Name: areNpcsEnabled

Return Type: boolean

ZenScript
 Copy
// Server.areNpcsEnabled() as boolean

myServer.areNpcsEnabled();

executeCommand

Name: executeCommand

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

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

myServer.executeCommand("time set day", true);

Parameter	Type	Optional	Default Value
Parameter command	Type string	Optional false	Default Value
Parameter silent	Type boolean	Optional true	Default Value false

executeCommand

Name: executeCommand

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

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

myServer.executeCommand("time set day", player, true);

Parameter	Type	Optional	Default 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

getAbsoluteMaxWorldSize

Name: getAbsoluteMaxWorldSize

Return Type: int

ZenScript
 Copy
// Server.getAbsoluteMaxWorldSize() as int

myServer.getAbsoluteMaxWorldSize();

getAllLevels

Name: getAllLevels

Return Type: stdlib.Iterable<ServerLevel>

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

myServer.getAllLevels();

getAverageTickTime

Name: getAverageTickTime

Return Type: float

ZenScript
 Copy
// Server.getAverageTickTime() as float

myServer.getAverageTickTime();

getDefaultGameType

Name: getDefaultGameType

Return Type: GameType

ZenScript
 Copy
// Server.getDefaultGameType() as GameType

myServer.getDefaultGameType();

getForcedGameType

Name: getForcedGameType

Return Type: GameType?

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

myServer.getForcedGameType();

getLevel

Name: getLevel

Return Type: ServerLevel?

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

Parameter	Type
Parameter location	Type ResourceLocation

getMaxPlayers

Name: getMaxPlayers

Return Type: int

ZenScript
 Copy
// Server.getMaxPlayers() as int

myServer.getMaxPlayers();

getModdedStatus

Name: getModdedStatus

Return Type: string?

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

myServer.getModdedStatus();

getMotd

Name: getMotd

Return Type: string

ZenScript
 Copy
// Server.getMotd() as string

myServer.getMotd();

getOperatorUserPermissionLevel

Name: getOperatorUserPermissionLevel

Return Type: int

ZenScript
 Copy
// Server.getOperatorUserPermissionLevel() as int

myServer.getOperatorUserPermissionLevel();

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

getPlayerCount

Name: getPlayerCount

Return Type: int

ZenScript
 Copy
// Server.getPlayerCount() as int

myServer.getPlayerCount();

getPlayerNames

Name: getPlayerNames

Return Type: string[]

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

myServer.getPlayerNames();

getServerModName

Name: getServerModName

Return Type: string

ZenScript
 Copy
// Server.getServerModName() as string

myServer.getServerModName();

getServerVersion

Name: getServerVersion

Return Type: string

ZenScript
 Copy
// Server.getServerVersion() as string

myServer.getServerVersion();

getSpawnProtectionRadius

Name: getSpawnProtectionRadius

Return Type: int

ZenScript
 Copy
// Server.getSpawnProtectionRadius() as int

myServer.getSpawnProtectionRadius();

getSpawnRadius

Name: getSpawnRadius

Return Type: int

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

Parameter	Type
Parameter level	Type ServerLevel?

getTickCount

Name: getTickCount

Return Type: int

ZenScript
 Copy
// Server.getTickCount() as int

myServer.getTickCount();

isCommandBlockEnabled

Name: isCommandBlockEnabled

Return Type: boolean

ZenScript
 Copy
// Server.isCommandBlockEnabled() as boolean

myServer.isCommandBlockEnabled();

isDedicatedServer

Name: isDedicatedServer

Return Type: boolean

ZenScript
 Copy
// Server.isDedicatedServer() as boolean

myServer.isDedicatedServer();

isEnforceWhitelist

Name: isEnforceWhitelist

Return Type: boolean

ZenScript
 Copy
// Server.isEnforceWhitelist() as boolean

myServer.isEnforceWhitelist();

isFlightAllowed

Name: isFlightAllowed

Return Type: boolean

ZenScript
 Copy
// Server.isFlightAllowed() as boolean

myServer.isFlightAllowed();

isHardcore

Name: isHardcore

Return Type: boolean

ZenScript
 Copy
// Server.isHardcore() as boolean

myServer.isHardcore();

isNetherEnabled

Name: isNetherEnabled

Return Type: boolean

ZenScript
 Copy
// Server.isNetherEnabled() as boolean

myServer.isNetherEnabled();

isPvpAllowed

Name: isPvpAllowed

Return Type: boolean

ZenScript
 Copy
// Server.isPvpAllowed() as boolean

myServer.isPvpAllowed();

isReady

Name: isReady

Return Type: boolean

ZenScript
 Copy
// Server.isReady() as boolean

myServer.isReady();

isRunning

Name: isRunning

Return Type: boolean

ZenScript
 Copy
// Server.isRunning() as boolean

myServer.isRunning();

isShutdown

Name: isShutdown

Return Type: boolean

ZenScript
 Copy
// Server.isShutdown() as boolean

myServer.isShutdown();

isSingleplayer

Name: isSingleplayer

Return Type: boolean

ZenScript
 Copy
// Server.isSingleplayer() as boolean

myServer.isSingleplayer();

isSpawningAnimals

Name: isSpawningAnimals

Return Type: boolean

ZenScript
 Copy
// Server.isSpawningAnimals() as boolean

myServer.isSpawningAnimals();

isSpawningMonsters

Name: isSpawningMonsters

Return Type: boolean

ZenScript
 Copy
// Server.isSpawningMonsters() as boolean

myServer.isSpawningMonsters();

isStopped

Name: isStopped

Return Type: boolean

ZenScript
 Copy
// Server.isStopped() as boolean

myServer.isStopped();

isUnderSpawnProtection

Name: isUnderSpawnProtection

Return Type: boolean

ZenScript
 Copy
Server.isUnderSpawnProtection(level as ServerLevel, pos as BlockPos, player as Player) as boolean

Parameter	Type
Parameter level	Type ServerLevel
Parameter pos	Type BlockPos
Parameter player	Type Player

levelKeys

Name: levelKeys

Return Type: stdlib.List<ResourceLocation>

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

myServer.levelKeys();

overworld

Name: overworld

Return Type: ServerLevel

ZenScript
 Copy
// Server.overworld() as ServerLevel

myServer.overworld();

setDefaultGameType

Name: setDefaultGameType

ZenScript
 Copy
Server.setDefaultGameType(gameType as GameType)

Parameter	Type
Parameter gameType	Type GameType

setDifficulty

Name: setDifficulty

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

Parameter	Type
Parameter difficulty	Type Difficulty
Parameter force	Type boolean

setDifficultyLocked

Name: setDifficultyLocked

ZenScript
 Copy
Server.setDifficultyLocked(locked as boolean)

Parameter	Type
Parameter locked	Type boolean

setEnforceWhitelist

Name: setEnforceWhitelist

ZenScript
 Copy
Server.setEnforceWhitelist(enforceWhitelist as boolean)

Parameter	Type
Parameter enforceWhitelist	Type boolean

setFlightAllowed

Name: setFlightAllowed

ZenScript
 Copy
Server.setFlightAllowed(flightAllowed as boolean)

Parameter	Type
Parameter flightAllowed	Type boolean

setMotd

Name: setMotd

ZenScript
 Copy
Server.setMotd(motd as string)

Parameter	Type
Parameter motd	Type string

setPvpAllowed

Name: setPvpAllowed

ZenScript
 Copy
Server.setPvpAllowed(pvpAllowed as boolean)

Parameter	Type
Parameter pvpAllowed	Type boolean

Properties

Name	Type	Has Getter	Has Setter	Description
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 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