Home Migration Guide Getting Started With Scripts Commands Examples
BracketHandlers

MCServer

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.

script.zs
import crafttweaker.api.server.MCServer;

Implemented Interfaces

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

  • AutoCloseable

Methods

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

script.zs
// MCServer.executeCommand(command as string, silent as boolean) as int
world.asServerWorld().server.executeCommand("time set day", true);
ParameterTypeDescriptionOptionalDefaultValue
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

script.zs
// MCServer.executeCommand(command as string, player as MCPlayerEntity, silent as boolean) as int
world.asServerWorld().server.executeCommand("time set day", player, true);
ParameterTypeDescriptionOptionalDefaultValue
Parameter
command
Type
string
Description
No Description Provided
Optional
false
DefaultValue
Parameter
player
Type
MCPlayerEntity
Description
No Description Provided
Optional
false
DefaultValue
Parameter
silent
Type
boolean
Description
No Description Provided
Optional
true
DefaultValue
false

Get a server world instance based on resource location Throws an exception if the world location is unknown

Return Type: MCServerWorld

script.zs
// MCServer.getWorld(location as MCResourceLocation) as MCServerWorld
world.asServerWorld().server.getWorld(<resource:minecraft:the_end>);
ParameterTypeDescription
Parameter
location
Type
MCResourceLocation
Description
No Description Provided

Properties

NameTypeHas GetterHas SetterDescription
Name
worlds
Type
Collection<MCServerWorld>
Has Getter
true
Has Setter
false
Description
No Description Provided