Server
Importing the class
If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.
import crafttweaker.api.game.Server;Extends
Server extends ReentrantBlockableEventLoop<TickTask>.
Implements
Server
implements the following interfaces:
Undocumented Interfaces
ServerInfo,ProfilerMeasured,ProcessorHandle<Runnable>,Executor
Members
Getter
// MinecraftServer.absoluteMaxWorldSize as intmyMinecraftServer.absoluteMaxWorldSize
Return Type:
int
absoluteMaxWorldSize() as int
// MinecraftServer.absoluteMaxWorldSize() as int;myMinecraftServer.absoluteMaxWorldSize();
Return Type:
int
Getter
// MinecraftServer.acceptsFailure as boolmyMinecraftServer.acceptsFailure
Return Type:
bool
acceptsFailure() as bool
// MinecraftServer.acceptsFailure() as bool;myMinecraftServer.acceptsFailure();
Return Type:
bool
Getter
// MinecraftServer.acceptsSuccess as boolmyMinecraftServer.acceptsSuccess
Return Type:
bool
acceptsSuccess() as bool
// MinecraftServer.acceptsSuccess() as bool;myMinecraftServer.acceptsSuccess();
Return Type:
bool
Getter
// MinecraftServer.allLevels as Iterable<ServerLevel>myMinecraftServer.allLevels
Return Type:
Iterable<ServerLevel>
allLevels() as Iterable<ServerLevel>
// MinecraftServer.allLevels() as Iterable<ServerLevel>;myMinecraftServer.allLevels();
Return Type:
Iterable<ServerLevel>
Getter
// MinecraftServer.alwaysAccepts as boolmyMinecraftServer.alwaysAccepts
Return Type:
bool
alwaysAccepts() as bool
// MinecraftServer.alwaysAccepts() as bool;myMinecraftServer.alwaysAccepts();
Return Type:
bool
Getter
// MinecraftServer.areNpcsEnabled as boolmyMinecraftServer.areNpcsEnabled
Return Type:
bool
areNpcsEnabled() as bool
// MinecraftServer.areNpcsEnabled() as bool;myMinecraftServer.areNpcsEnabled();
Return Type:
bool
Getter
// MinecraftServer.averageTickTime as floatmyMinecraftServer.averageTickTime
Return Type:
float
averageTickTime() as float
// MinecraftServer.averageTickTime() as float;myMinecraftServer.averageTickTime();
Return Type:
float
executeCommand(command as string, silent as bool = false) as int
Runs a command, if silent is true, the output is hidden.
Returns The success value of the command, or 0 if an exception occurred.script.zs
Returns The success value of the command, or 0 if an exception occurred.
Note: Some commands' success value is 0
// MinecraftServer.executeCommand(command as string, silent as bool = false) as int;myMinecraftServer.executeCommand("time set day", true);Parameters:
command: string Type: string silent: bool (optional) Type: bool
Default Value: false
Return Type:
int
executeCommand(command as string, player as Player, silent as bool = false) as int
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.script.zs
Returns The success value of the command, or 0 if an exception occurred.
Note: Some commands' success value is 0
// MinecraftServer.executeCommand(command as string, player as Player, silent as bool = false) as int;myMinecraftServer.executeCommand("time set day", player, true);Parameters:
Return Type:
int
getLevel(location as ResourceLocation) as ServerLevel
// MinecraftServer.getLevel(location as ResourceLocation) as ServerLevel;myMinecraftServer.getLevel(myResourceLocation);Parameters:
location: ResourceLocation Type: ResourceLocation
Return Type:
ServerLevel
getSpawnRadius(level as ServerLevel) as int
// MinecraftServer.getSpawnRadius(level as ServerLevel) as int;myMinecraftServer.getSpawnRadius(myServerLevel);Parameters:
level: ServerLevel Type: ServerLevel
Return Type:
int
Getter
// MinecraftServer.isCommandBlockEnabled as boolmyMinecraftServer.isCommandBlockEnabled
Return Type:
bool
isCommandBlockEnabled() as bool
// MinecraftServer.isCommandBlockEnabled() as bool;myMinecraftServer.isCommandBlockEnabled();
Return Type:
bool
Getter
// MinecraftServer.isDedicatedServer as boolmyMinecraftServer.isDedicatedServer
Return Type:
bool
isDedicatedServer() as bool
// MinecraftServer.isDedicatedServer() as bool;myMinecraftServer.isDedicatedServer();
Return Type:
bool
Getter
// MinecraftServer.isEnforceWhitelist as boolmyMinecraftServer.isEnforceWhitelist
Return Type:
bool
isEnforceWhitelist() as bool
// MinecraftServer.isEnforceWhitelist() as bool;myMinecraftServer.isEnforceWhitelist();
Return Type:
bool
Getter
// MinecraftServer.isFlightAllowed as boolmyMinecraftServer.isFlightAllowed
Return Type:
bool
isFlightAllowed() as bool
// MinecraftServer.isFlightAllowed() as bool;myMinecraftServer.isFlightAllowed();
Return Type:
bool
Getter
// MinecraftServer.isHardcore as boolmyMinecraftServer.isHardcore
Return Type:
bool
isHardcore() as bool
// MinecraftServer.isHardcore() as bool;myMinecraftServer.isHardcore();
Return Type:
bool
Getter
// MinecraftServer.isNetherEnabled as boolmyMinecraftServer.isNetherEnabled
Return Type:
bool
isNetherEnabled() as bool
// MinecraftServer.isNetherEnabled() as bool;myMinecraftServer.isNetherEnabled();
Return Type:
bool
Getter
// MinecraftServer.isPvpAllowed as boolmyMinecraftServer.isPvpAllowed
Return Type:
bool
isPvpAllowed() as bool
// MinecraftServer.isPvpAllowed() as bool;myMinecraftServer.isPvpAllowed();
Return Type:
bool
Getter
// MinecraftServer.isReady as boolmyMinecraftServer.isReady
Return Type:
bool
isReady() as bool
// MinecraftServer.isReady() as bool;myMinecraftServer.isReady();
Return Type:
bool
Getter
// MinecraftServer.isRunning as boolmyMinecraftServer.isRunning
Return Type:
bool
isRunning() as bool
// MinecraftServer.isRunning() as bool;myMinecraftServer.isRunning();
Return Type:
bool
Getter
// MinecraftServer.isShutdown as boolmyMinecraftServer.isShutdown
Return Type:
bool
isShutdown() as bool
// MinecraftServer.isShutdown() as bool;myMinecraftServer.isShutdown();
Return Type:
bool
Getter
// MinecraftServer.isSingleplayer as boolmyMinecraftServer.isSingleplayer
Return Type:
bool
isSingleplayer() as bool
// MinecraftServer.isSingleplayer() as bool;myMinecraftServer.isSingleplayer();
Return Type:
bool
Getter
// MinecraftServer.isSpawningAnimals as boolmyMinecraftServer.isSpawningAnimals
Return Type:
bool
isSpawningAnimals() as bool
// MinecraftServer.isSpawningAnimals() as bool;myMinecraftServer.isSpawningAnimals();
Return Type:
bool
Getter
// MinecraftServer.isSpawningMonsters as boolmyMinecraftServer.isSpawningMonsters
Return Type:
bool
isSpawningMonsters() as bool
// MinecraftServer.isSpawningMonsters() as bool;myMinecraftServer.isSpawningMonsters();
Return Type:
bool
Getter
// MinecraftServer.isStopped as boolmyMinecraftServer.isStopped
Return Type:
bool
isStopped() as bool
// MinecraftServer.isStopped() as bool;myMinecraftServer.isStopped();
Return Type:
bool
isUnderSpawnProtection(level as ServerLevel, pos as BlockPos, player as Player) as bool
// MinecraftServer.isUnderSpawnProtection(level as ServerLevel, pos as BlockPos, player as Player) as bool;myMinecraftServer.isUnderSpawnProtection(myServerLevel, myBlockPos, myPlayer);Parameters:
Return Type:
bool
Getter
// MinecraftServer.levelKeys as List<ResourceLocation>myMinecraftServer.levelKeys
Return Type:
List<ResourceLocation>
levelKeys() as List<ResourceLocation>
// MinecraftServer.levelKeys() as List<ResourceLocation>;myMinecraftServer.levelKeys();
Return Type:
List<ResourceLocation>
Getter
// MinecraftServer.maxPlayer as intmyMinecraftServer.maxPlayer
Return Type:
int
maxPlayer() as int
// MinecraftServer.maxPlayer() as int;myMinecraftServer.maxPlayer();
Return Type:
int
Getter
// MinecraftServer.moddeStatus as stringmyMinecraftServer.moddeStatus
Return Type:
string
moddeStatus() as string
// MinecraftServer.moddeStatus() as string;myMinecraftServer.moddeStatus();
Return Type:
string
Getter
// MinecraftServer.motd as stringmyMinecraftServer.motd
Return Type:
string
motd() as string
// MinecraftServer.motd() as string;myMinecraftServer.motd();
Return Type:
string
Getter
// MinecraftServer.operatorUserPermissionLevel as intmyMinecraftServer.operatorUserPermissionLevel
Return Type:
int
operatorUserPermissionLevel() as int
// MinecraftServer.operatorUserPermissionLevel() as int;myMinecraftServer.operatorUserPermissionLevel();
Return Type:
int
Getter
// MinecraftServer.overworld as ServerLevelmyMinecraftServer.overworld
Return Type:
ServerLevel
overworld() as ServerLevel
// MinecraftServer.overworld() as ServerLevel;myMinecraftServer.overworld();
Return Type:
ServerLevel
Getter
Gets the custom data of the overworld.
script.zs
The overworld is always loaded, so this can be used to store and access data no matter what level a player may be in.
// MinecraftServer.overworldData as CraftTweakerSavedDatamyMinecraftServer.overworldData
Return Type:
CraftTweakerSavedData
overworldData() as CraftTweakerSavedData
Gets the custom data of the overworld.
script.zs
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.
// MinecraftServer.overworldData() as CraftTweakerSavedData;myMinecraftServer.overworldData();
Return Type:
CraftTweakerSavedData
Getter
// MinecraftServer.playerCount as intmyMinecraftServer.playerCount
Return Type:
int
playerCount() as int
// MinecraftServer.playerCount() as int;myMinecraftServer.playerCount();
Return Type:
int
Getter
// MinecraftServer.playerList as PlayerListmyMinecraftServer.playerList
Return Type:
PlayerList
playerList() as PlayerList
// MinecraftServer.playerList() as PlayerList;myMinecraftServer.playerList();
Return Type:
PlayerList
Getter
// MinecraftServer.playerNames as string[]myMinecraftServer.playerNames
Return Type:
string[]
playerNames() as string[]
// MinecraftServer.playerNames() as string[];myMinecraftServer.playerNames();
Return Type:
string[]
Getter
// MinecraftServer.serverModName as stringmyMinecraftServer.serverModName
Return Type:
string
serverModName() as string
// MinecraftServer.serverModName() as string;myMinecraftServer.serverModName();
Return Type:
string
Getter
// MinecraftServer.serverVersion as stringmyMinecraftServer.serverVersion
Return Type:
string
serverVersion() as string
// MinecraftServer.serverVersion() as string;myMinecraftServer.serverVersion();
Return Type:
string
setDifficulty(difficulty as Difficulty, force as bool)
// MinecraftServer.setDifficulty(difficulty as Difficulty, force as bool);myMinecraftServer.setDifficulty(myDifficulty, myBool);Parameters:
difficulty: Difficulty Type: Difficulty force: bool Type: bool setDifficultyLocked(locked as bool)
// MinecraftServer.setDifficultyLocked(locked as bool);myMinecraftServer.setDifficultyLocked(myBool);Parameters:
locked: bool Type: bool setEnforceWhitelist(enforceWhitelist as bool)
// MinecraftServer.setEnforceWhitelist(enforceWhitelist as bool);myMinecraftServer.setEnforceWhitelist(myBool);Parameters:
enforceWhitelist: bool Type: bool setFlightAllowed(flightAllowed as bool)
// MinecraftServer.setFlightAllowed(flightAllowed as bool);myMinecraftServer.setFlightAllowed(myBool);Parameters:
flightAllowed: bool Type: bool setMotd(motd as string)
// MinecraftServer.setMotd(motd as string);myMinecraftServer.setMotd(myString);Parameters:
motd: string Type: string setPvpAllowed(pvpAllowed as bool)
// MinecraftServer.setPvpAllowed(pvpAllowed as bool);myMinecraftServer.setPvpAllowed(myBool);Parameters:
pvpAllowed: bool Type: bool Getter
// MinecraftServer.shouldInformAdmins as boolmyMinecraftServer.shouldInformAdmins
Return Type:
bool
shouldInformAdmins() as bool
// MinecraftServer.shouldInformAdmins() as bool;myMinecraftServer.shouldInformAdmins();
Return Type:
bool
Getter
// MinecraftServer.spawnProtectionRadius as intmyMinecraftServer.spawnProtectionRadius
Return Type:
int
spawnProtectionRadius() as int
// MinecraftServer.spawnProtectionRadius() as int;myMinecraftServer.spawnProtectionRadius();
Return Type:
int
Getter
// MinecraftServer.tickCount as intmyMinecraftServer.tickCount
Return Type:
int
tickCount() as int
// MinecraftServer.tickCount() as int;myMinecraftServer.tickCount();
Return Type:
int