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 | Optional | Default Value |
|---|---|---|---|
Parameter command | Type string | Optional false | Default Value |
Parameter silent | Type boolean | Optional true | Default Value 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 | 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 |
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 |
|---|---|
Parameter location | Type ResourceLocation |
Return Type: int
// Server.getMaxPlayers() as int
myServer.getMaxPlayers();Return Type: string?
// Server.getModdedStatus() as string?
myServer.getModdedStatus();Return Type: string
// Server.getMotd() as string
myServer.getMotd();Return Type: int
// Server.getOperatorUserPermissionLevel() as int
myServer.getOperatorUserPermissionLevel();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
// Server.getOverworldData() as CraftTweakerSavedData
myServer.getOverworldData();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 |
|---|---|
Parameter level | Type ServerLevel? |
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 |
|---|---|
Parameter level | Type ServerLevel |
Parameter pos | Type BlockPos |
Parameter player | Type Player |
Return Type: stdlib.List<ResourceLocation>
// Server.levelKeys() as stdlib.List<ResourceLocation>
myServer.levelKeys();Return Type: ServerLevel
// Server.overworld() as ServerLevel
myServer.overworld();Server.setDefaultGameType(gameType as GameType)| Parameter | Type |
|---|---|
Parameter gameType | Type GameType |
Server.setDifficulty(difficulty as Difficulty, force as boolean)| Parameter | Type |
|---|---|
Parameter difficulty | Type Difficulty |
Parameter force | Type boolean |
Server.setDifficultyLocked(locked as boolean)| Parameter | Type |
|---|---|
Parameter locked | Type boolean |
Server.setEnforceWhitelist(enforceWhitelist as boolean)| Parameter | Type |
|---|---|
Parameter enforceWhitelist | Type boolean |
Server.setFlightAllowed(flightAllowed as boolean)| Parameter | Type |
|---|---|
Parameter flightAllowed | Type boolean |
Server.setMotd(motd as string)| Parameter | Type |
|---|---|
Parameter motd | Type string |
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 |