Server - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

导入类

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;

已实现的接口

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

CommandSource
AutoCloseable

使用方式

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

参数	类型	可选	默认值
参数 command	类型 string	可选 false	默认值
参数 silent	类型布尔值	可选 true	默认值 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);

参数	类型	可选	默认值
参数 command	类型 string	可选 false	默认值
参数 player	类型 Player	可选 false	默认值
参数 silent	类型布尔值	可选 true	默认值 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?

参数	类型
参数位置	类型资源位置

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

参数	类型
参数 level	类型 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

参数	类型
参数 level	类型 ServerLevel
参数点	类型 BlockPos
参数 player	类型 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)

参数	类型
参数 gameType	类型 GameType

setDifficulty

Name: setDifficulty

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

参数	类型
参数 difficulty	类型 Difficulty
参数 force	类型布尔值

setDifficultyLocked

Name: setDifficultyLocked

ZenScript
 Copy
Server.setDifficultyLocked(locked as boolean)

参数	类型
参数 locked	类型布尔值

setEnforceWhitelist

Name: setEnforceWhitelist

ZenScript
 Copy
Server.setEnforceWhitelist(enforceWhitelist as boolean)

参数	类型
参数 enforceWhitelist	类型布尔值

setFlightAllowed

Name: setFlightAllowed

ZenScript
 Copy
Server.setFlightAllowed(flightAllowed as boolean)

参数	类型
参数 flightAllowed	类型布尔值

setMotd

Name: setMotd

ZenScript
 Copy
Server.setMotd(motd as string)

参数	类型
参数 motd	类型 string

setPvpAllowed

Name: setPvpAllowed

ZenScript
 Copy
Server.setPvpAllowed(pvpAllowed as boolean)

参数	类型
参数 pvpAllowed	类型布尔值

参数

名称	类型	可获得	可设置	描述
名称 absoluteMaxWorldSize	类型 int	可获得 true	可设置 false	描述
名称 allLevels	类型 stdlib.Iterable<ServerLevel>	可获得 true	可设置 false	描述
名称 areNpcsEnabled	类型布尔值	可获得 true	可设置 false	描述
名称 averageTickTime	类型 float	可获得 true	可设置 false	描述
名称 defaultGameTime	类型 GameType	可获得 true	可设置 false	描述
名称 forcedGameType	类型 GameType?	可获得 true	可设置 false	描述
名称 isCommandBlockEnabled	类型布尔值	可获得 true	可设置 false	描述
名称 isDedicatedServer	类型布尔值	可获得 true	可设置 false	描述
名称 isEnforceWhitelist	类型布尔值	可获得 true	可设置 false	描述
名称 isFlightAllowed	类型布尔值	可获得 true	可设置 false	描述
名称 isHardcore	类型布尔值	可获得 true	可设置 false	描述
名称 isNetherEnabled	类型布尔值	可获得 true	可设置 false	描述
名称 isPvpAllowed	类型布尔值	可获得 true	可设置 false	描述
名称 isReady	类型布尔值	可获得 true	可设置 false	描述
名称 isRunning	类型布尔值	可获得 true	可设置 false	描述
名称 isShutdown	类型布尔值	可获得 true	可设置 false	描述
名称 isSingleplayer	类型布尔值	可获得 true	可设置 false	描述
名称 isSpawningAnimals	类型布尔值	可获得 true	可设置 false	描述
名称 isSpawningMonsters	类型布尔值	可获得 true	可设置 false	描述
名称 isStopped	类型布尔值	可获得 true	可设置 false	描述
名称 levelKeys	类型 stdlib.List<ResourceLocation>	可获得 true	可设置 false	描述
名称 maxPlayer	类型 int	可获得 true	可设置 false	描述
名称 moddeStatus	类型 string?	可获得 true	可设置 false	描述
名称 motd	类型 string	可获得 true	可设置 false	描述
名称 operatorUserPermissionLevel	类型 int	可获得 true	可设置 false	描述
名称 overworld	类型 ServerLevel	可获得 true	可设置 false	描述
名称 overworldData	类型 CraftTweakerSavedData	可获得 true	可设置 false	描述 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.
名称 playerCount	类型 int	可获得 true	可设置 false	描述
名称 playerNames	类型 string[]	可获得 true	可设置 false	描述
名称 serverModName	类型 string	可获得 true	可设置 false	描述
名称 serverVersion	类型 string	可获得 true	可设置 false	描述
名称 spawnProtectionRadius	类型 int	可获得 true	可设置 false	描述
名称 tickCount	类型 int	可获得 true	可设置 false	描述