Package com.minecolonies.core.commands.generalcommands

Class ScanCommand

java.lang.Object

com.ldtteam.structurize.commands.AbstractCommand

com.minecolonies.core.commands.generalcommands.ScanCommand

public class ScanCommand
extends com.ldtteam.structurize.commands.AbstractCommand

Command for opening WindowScanTool or scanning a structure into a file

Nested Class Summary

Nested classes/interfaces inherited from class com.ldtteam.structurize.commands.AbstractCommand

com.ldtteam.structurize.commands.AbstractCommand.CommandTree, com.ldtteam.structurize.commands.AbstractCommand.StructurizeCommandExceptionType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANCHOR_POS	Anchor position command argument.
static final String	FILE_NAME	The filename command argument.
static final String	NAME	Descriptive string.
static final String	PLAYER_NAME	The player name command argument.
static final String	POS1	Position 1 command argument.
static final String	POS2	Position 2 command argument.

Constructor Summary

Constructors

Constructor	Description
ScanCommand()

Method Summary

Modifier and Type	Method	Description
static com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.commands.CommandSourceStack>	build()
static @NotNull String	format(com.ldtteam.structurize.util.ScanToolData.Slot slot)	Generates a command string for the given parameters.
static void	saveStructure(net.minecraft.world.level.Level world, net.minecraft.world.entity.player.Player player, com.ldtteam.structurize.util.ScanToolData.Slot slot, boolean saveEntities)	Scan the structure and save it to the disk.

Methods inherited from class com.ldtteam.structurize.commands.AbstractCommand

getEnvironmentType, newArgument, newLiteral, throwSyntaxException, throwSyntaxException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

Descriptive string.

See Also:

• Constant Field Values

FILE_NAME

public static final String FILE_NAME

The filename command argument.

See Also:

• Constant Field Values

PLAYER_NAME

public static final String PLAYER_NAME

The player name command argument.

See Also:

• Constant Field Values

POS1

public static final String POS1

Position 1 command argument.

See Also:

• Constant Field Values

POS2

public static final String POS2

Position 2 command argument.

See Also:

• Constant Field Values

ANCHOR_POS

public static final String ANCHOR_POS

Anchor position command argument.

See Also:

• Constant Field Values

Constructor Details

ScanCommand

public ScanCommand()

Method Details

saveStructure

public static void saveStructure(net.minecraft.world.level.Level world,
 net.minecraft.world.entity.player.Player player,
 com.ldtteam.structurize.util.ScanToolData.Slot slot,
 boolean saveEntities)

Scan the structure and save it to the disk.

Parameters:

world - Current world.

player - causing this action.

slot - the scan data.

saveEntities - whether to scan in entities

build

public static com.mojang.brigadier.builder.LiteralArgumentBuilder<net.minecraft.commands.CommandSourceStack> build()

format

@NotNull
public static @NotNull String format(@NotNull
 com.ldtteam.structurize.util.ScanToolData.Slot slot)

Generates a command string for the given parameters.

Parameters:

slot - The scan slot data.

Returns:

The command string.