Server
Link to server
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 Copyimport 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
- CommandSource
- AutoCloseable
Methods
Link to methods
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.
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 | Description | Optional | DefaultValue |
|---|---|---|---|---|
Parameter command | Type string | Description No Description Provided | Optional false | DefaultValue |
Parameter silent | Type boolean | Description No Description Provided | Optional true | DefaultValue false |
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 | Description | Optional | DefaultValue |
|---|---|---|---|---|
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 |
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();
Name: getAverageTickTime
Return Type: float
ZenScript Copy// Server.getAverageTickTime() as float
myServer.getAverageTickTime();
Name: getDefaultGameType
Return Type: GameType
ZenScript Copy// Server.getDefaultGameType() as GameType
myServer.getDefaultGameType();
Name: getForcedGameType
Return Type: GameType
ZenScript Copy// Server.getForcedGameType() as GameType
myServer.getForcedGameType();
Name: getLevel
Return Type: ServerLevel
ZenScript CopyServer.getLevel(location as ResourceLocation) as ServerLevel
| Parameter | Type | Description |
|---|---|---|
Parameter location | Type ResourceLocation | Description No Description Provided |
Name: getMaxPlayers
Return Type: int
ZenScript Copy// Server.getMaxPlayers() as int
myServer.getMaxPlayers();
Name: getModdedStatus
Return Type: invalid
ZenScript Copy// Server.getModdedStatus() as invalid
myServer.getModdedStatus();
Name: getMotd
Return Type: string
ZenScript Copy// Server.getMotd() as string
myServer.getMotd();
Name: getOperatorUserPermissionLevel
Return Type: int
ZenScript Copy// Server.getOperatorUserPermissionLevel() as int
myServer.getOperatorUserPermissionLevel();
Name: getPlayerCount
Return Type: int
ZenScript Copy// Server.getPlayerCount() as int
myServer.getPlayerCount();
Name: getPlayerNames
Return Type: string[]
ZenScript Copy// Server.getPlayerNames() as string[]
myServer.getPlayerNames();
Name: getServerModName
Return Type: string
ZenScript Copy// Server.getServerModName() as string
myServer.getServerModName();
Name: getServerVersion
Return Type: string
ZenScript Copy// Server.getServerVersion() as string
myServer.getServerVersion();
Name: getSpawnProtectionRadius
Return Type: int
ZenScript Copy// Server.getSpawnProtectionRadius() as int
myServer.getSpawnProtectionRadius();
Name: getSpawnRadius
Return Type: int
ZenScript CopyServer.getSpawnRadius(level as ServerLevel) as int
| Parameter | Type | Description |
|---|---|---|
Parameter level | Type ServerLevel | Description No Description Provided |
Name: getTickCount
Return Type: int
ZenScript Copy// Server.getTickCount() as int
myServer.getTickCount();
Name: isCommandBlockEnabled
Return Type: boolean
ZenScript Copy// Server.isCommandBlockEnabled() as boolean
myServer.isCommandBlockEnabled();
Name: isDedicatedServer
Return Type: boolean
ZenScript Copy// Server.isDedicatedServer() as boolean
myServer.isDedicatedServer();
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();
Name: isSpawningAnimals
Return Type: boolean
ZenScript Copy// Server.isSpawningAnimals() as boolean
myServer.isSpawningAnimals();
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();
Name: isUnderSpawnProtection
Return Type: boolean
ZenScript CopyServer.isUnderSpawnProtection(level as ServerLevel, pos as BlockPos, player as Player) as boolean
| Parameter | Type | Description |
|---|---|---|
Parameter level | Type ServerLevel | Description No Description Provided |
Parameter pos | Type BlockPos | Description No Description Provided |
Parameter player | Type Player | Description No Description Provided |
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();
Name: setDefaultGameType
Return Type: void
ZenScript CopyServer.setDefaultGameType(gameType as GameType) as void
| Parameter | Type | Description |
|---|---|---|
Parameter gameType | Type GameType | Description No Description Provided |
Name: setDifficulty
Return Type: void
ZenScript CopyServer.setDifficulty(difficulty as Difficulty, force as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter difficulty | Type Difficulty | Description No Description Provided |
Parameter force | Type boolean | Description No Description Provided |
Name: setDifficultyLocked
Return Type: void
ZenScript CopyServer.setDifficultyLocked(locked as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter locked | Type boolean | Description No Description Provided |
Name: setEnforceWhitelist
Return Type: void
ZenScript CopyServer.setEnforceWhitelist(enforceWhitelist as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter enforceWhitelist | Type boolean | Description No Description Provided |
Name: setFlightAllowed
Return Type: void
ZenScript CopyServer.setFlightAllowed(flightAllowed as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter flightAllowed | Type boolean | Description No Description Provided |
Name: setMotd
Return Type: void
ZenScript CopyServer.setMotd(motd as string) as void
| Parameter | Type | Description |
|---|---|---|
Parameter motd | Type string | Description No Description Provided |
Name: setPvpAllowed
Return Type: void
ZenScript CopyServer.setPvpAllowed(pvpAllowed as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter pvpAllowed | Type boolean | Description No Description Provided |
Properties
Link to properties
| Name | Type | Has Getter | Has Setter | Description |
|---|---|---|---|---|
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 |