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.
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
Return Type: boolean
// 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
// 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 |
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
// 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 |
Return Type: int
// Server.getAbsoluteMaxWorldSize() as int
myServer.getAbsoluteMaxWorldSize();
Return Type: stdlib.Iterable<ServerLevel>
// Server.getAllLevels() as stdlib.Iterable<ServerLevel>
myServer.getAllLevels();
Return Type: float
// Server.getAverageTickTime() as float
myServer.getAverageTickTime();
Return Type: GameType
// Server.getDefaultGameType() as GameType
myServer.getDefaultGameType();
Return Type: GameType
// Server.getForcedGameType() as GameType
myServer.getForcedGameType();
Return Type: ServerLevel
Server.getLevel(location as ResourceLocation) as ServerLevel
Parameter | Type | Description |
---|---|---|
Parameter location | Type ResourceLocation | Description No Description Provided |
Return Type: int
// Server.getMaxPlayers() as int
myServer.getMaxPlayers();
Return Type: invalid
// Server.getModdedStatus() as invalid
myServer.getModdedStatus();
Return Type: string
// Server.getMotd() as string
myServer.getMotd();
Return Type: int
// Server.getOperatorUserPermissionLevel() as int
myServer.getOperatorUserPermissionLevel();
Return Type: int
// Server.getPlayerCount() as int
myServer.getPlayerCount();
Return Type: string[]
// Server.getPlayerNames() as string[]
myServer.getPlayerNames();
Return Type: string
// Server.getServerModName() as string
myServer.getServerModName();
Return Type: string
// Server.getServerVersion() as string
myServer.getServerVersion();
Return Type: int
// Server.getSpawnProtectionRadius() as int
myServer.getSpawnProtectionRadius();
Return Type: int
Server.getSpawnRadius(level as ServerLevel) as int
Parameter | Type | Description |
---|---|---|
Parameter level | Type ServerLevel | Description No Description Provided |
Return Type: int
// Server.getTickCount() as int
myServer.getTickCount();
Return Type: boolean
// Server.isCommandBlockEnabled() as boolean
myServer.isCommandBlockEnabled();
Return Type: boolean
// Server.isDedicatedServer() as boolean
myServer.isDedicatedServer();
Return Type: boolean
// Server.isEnforceWhitelist() as boolean
myServer.isEnforceWhitelist();
Return Type: boolean
// Server.isFlightAllowed() as boolean
myServer.isFlightAllowed();
Return Type: boolean
// Server.isHardcore() as boolean
myServer.isHardcore();
Return Type: boolean
// Server.isNetherEnabled() as boolean
myServer.isNetherEnabled();
Return Type: boolean
// Server.isPvpAllowed() as boolean
myServer.isPvpAllowed();
Return Type: boolean
// Server.isReady() as boolean
myServer.isReady();
Return Type: boolean
// Server.isRunning() as boolean
myServer.isRunning();
Return Type: boolean
// Server.isShutdown() as boolean
myServer.isShutdown();
Return Type: boolean
// Server.isSingleplayer() as boolean
myServer.isSingleplayer();
Return Type: boolean
// Server.isSpawningAnimals() as boolean
myServer.isSpawningAnimals();
Return Type: boolean
// Server.isSpawningMonsters() as boolean
myServer.isSpawningMonsters();
Return Type: boolean
// Server.isStopped() as boolean
myServer.isStopped();
Return Type: boolean
Server.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 |
Return Type: stdlib.List<ResourceLocation>
// Server.levelKeys() as stdlib.List<ResourceLocation>
myServer.levelKeys();
Return Type: ServerLevel
// Server.overworld() as ServerLevel
myServer.overworld();
Return Type: void
Server.setDefaultGameType(gameType as GameType) as void
Parameter | Type | Description |
---|---|---|
Parameter gameType | Type GameType | Description No Description Provided |
Return Type: void
Server.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 |
Return Type: void
Server.setDifficultyLocked(locked as boolean) as void
Parameter | Type | Description |
---|---|---|
Parameter locked | Type boolean | Description No Description Provided |
Return Type: void
Server.setEnforceWhitelist(enforceWhitelist as boolean) as void
Parameter | Type | Description |
---|---|---|
Parameter enforceWhitelist | Type boolean | Description No Description Provided |
Return Type: void
Server.setFlightAllowed(flightAllowed as boolean) as void
Parameter | Type | Description |
---|---|---|
Parameter flightAllowed | Type boolean | Description No Description Provided |
Return Type: void
Server.setMotd(motd as string) as void
Parameter | Type | Description |
---|---|---|
Parameter motd | Type string | Description No Description Provided |
Return Type: void
Server.setPvpAllowed(pvpAllowed as boolean) as void
Parameter | Type | Description |
---|---|---|
Parameter pvpAllowed | Type boolean | Description No Description Provided |
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 |