Commands

This section of the wiki is severely outdated

Table of Contents

1. Commands
    1.1 Alias command
    1.2 Brush command
    1.3 VoxelHelp command
    1.4 Material command
    1.5 Material Mask command
    1.6 Undo command
    1.7 Undo Other command
    1.8 Redo command
    1.9 Redo Other command
    1.10 Reset command
    1.11 VoxelSniper command
   
2. Brushes
   

---

1. Commands

A note on syntax of the usage strings, angle brackets (eg. <foo>) denote required arguments and square brackets (eg. [bar]) denote optional arguments.

1.1 Alias command

Permissions: voxelsniper.command.alias
Usage: /alias <target> [-g] <alias>=<value>

The alias command is used to define aliases which are then used by many of the other commands in order to increase your efficiency and provide quick access to more complicated functions. The [target] is one of several alias targets which are detailed below. The optional -g flag specifies whether this alias is global, in other words if this alias should be available to all users. Setting the -g flag requires the extra permission node voxelsniper.command.alias.global.

There are two alias targets available by default: brush, and material.

Brush aliases are applied to the brush command and can be used to alias a string to one or more brush parts. This alias target is used extensively to provide backwards comparability to old voxelsniper brush names.

Material aliases are applied to all of the material commands and may be used to provide shorthand or alternate names for materials which, lets be honest, are sometimes horrible named by default.

1.2 Brush command

Aliases: b
Permissions: voxelsniper.command.brush
Usage: /brush <brush...> or /b # to set your brush size

The brush command is one of the central and most important commands in VoxelSniper. It allows you to set your currently selected brush. Its syntax is made up of a chain of brush part specifications.

Before we get into a description of how to define a brush we should first mention a secondary function of this command which is the usage pattern of /b # which sets your brush size to the specified value.

A key difference to how this command has worked in the past versions is that this value may now be a floating point value, for example you can now set your brush size to /b 5.5 which would look the same as having a brush size of 5 and the true circle mode set in the old version of VoxelSniper.

Now into how to specify your brush, your selected brush is made up of a series of brush parts. Each part forms a discrete function and are generally divided into four categories. Shapes, masks, effects, and miscellaneous parts. Shapes define a region within the world to be acted on by other parts. Masks modify the region defined by a shape. Effects apply some function to the region. Anything else which performs an extraneous action falls into the miscellaneous category.

The brush parts defined with this command are chained together sequentially and executed in order. Although it should be noted that the output of a brush part is not limited to being the input of next next part but rather exists in a shared space which all subsequent parts have access to.

Some examples:

/b ball material: This brush is made up of two parts, the ball brush part which is a shape and the material brush part which is an effect. Neither of the brush parts has any arguments passed to them. When executed the ball shape will be called first and will define a spherical shape around your targeted point with a radius set by your brush size. Next this region will be taken by the material brush part and acted on which will have the effect of setting every point in the region to your primary material.

1.3 VoxelHelp command

Aliases: vhelp
Permissions: voxelsniper.command.help
Usage: /voxelhelp <brush part>

This command provides in-game help information on the various brush parts. To use it simply specify the brush part name that you would like more information on. For example, /voxelhelp ball would give more information on the ball brush part.

1.4 Material command

Aliases: v
Permissions: voxelsniper.command.material
Usage: /material <material>

This command sets your primary material. Material aliases are applied to the material argument.

1.5 MaskMaterial command

Aliases: vr
Permissions: voxelsniper.command.materialmask
Usage: /maskmaterial <material>

This command sets your secondary material (also known as your replace material). Material aliases are applied to the material argument.

1.6 Undo command

Aliases: u
Permissions: voxelsniper.command.undo
Usage: /undo [n]

This command will undo one or more of your recent changes. If the n argument is specified then n changes are undone, otherwise a single change is undone. By default 30 recent changes are stored per user, although this is modifiable with configuration.

If the server is restarted then all player undo queues are cleared.

1.7 UndoOther command

Aliases: uu
Permissions: voxelsniper.command.undoother
Usage: /undoother <name> [n]

This command undoes one or more changes from another player's undo queue. If the n argument is specified then n changes are undone, otherwise a single change is undone. By default 30 recent changes are stored per user, although this is modifiable with configuration.

This command will still function if the player is offline. However, like the standard undo command all players undo queues are cleared on server restart.

> At this time this command does not attempt to match partial names. Will change soon.

1.8 Redo command

Permissions: voxelsniper.command.redo
Usage: /redo [n]

This command will redo one or more previously undone changes. The same limitations of the undo command still apply.

1.9 RedoOther command

Permissions: voxelsniper.command.redoother
Usage: /redoother <name> [n]

Similar to the UndoOther command this command will redo the specified player's last n (or 1 if n is not specified) undone changes.

1.10 VoxelReset command

Aliases: d
Permissions: voxelsniper.command.reset
Usage: /voxelreset

Resets all of your settings to the default values. Some things modified are your personal brush settings, your current brush, and your material settings. Things such as stored aliases are not reset.

1.11 VoxelSniper command

Aliases: vs
Permissions: voxelsniper.command.vs

This command is designed for getting and setting runtime information and various debug options. It's functions are split between a number of sub-commands. The subcommands are accessed by /voxelsniper [subcommand] <args>.

version
Usage: /voxelsniper version
Displays information on the currently version of voxelsniper which is loaded.

range
Usage: /voxelsniper range #
This subcommand sets the maximum range of a snipe. For example, if your range is set to 5 even if you are aiming at a target 15 blocks away your selected brush will still execute 5 blocks away from you.

unittest
Usage: /voxelsniper unittest
This debug commands executes a variety of tests in-game to test that the system is working correctly. This is very useful when you think you have encountered a bug within VoxelSniper and would like to validate its internal integrity.

WARNING: The unit test performed executes small brushes a short distance from your position and may be destructive. Do not execute this command near to anything you care about.