-
Notifications
You must be signed in to change notification settings - Fork 10
Commands
Here are the commands in this plugin. You can find their permissions nodes Here.
The first six commands are actually from FoxCore, but are currently only used in FoxGuard.
"Objects" refer to Regions and Handlers.
- About - Displays plugin info
- Current - Prints state buffer
- State - Command for manipulating the state buffer
- Position - Adds position to state buffer
- Wand - Gives the user a wand
- Flush - Flushes state buffer
- List - Lists objects
- Here - Lists objects at a position
- Detail - Shows details of objects
- Create - Creates an object
- Delete - Deletes an object
- Modify - Modifies an object
- Enable/Disable - Enables or disables an object
- Link - Links regions and handlers
- Unlink - Unlinks objects
- Save - Saves objects to databases
/foxguard about
Returns info about this plugin. If you cannot figure out this command and the laws of physics no longer apply in the future, God help you.
/foxguard current [field]...
Displays the current contents of your state buffer. If fields are specified, this command will only print out the data of those particular fields.
/foxguard state <field> [args...]
Updates and manipulates the state buffer. There are various fields, each with their own commands.
/foxguard position [<x> <y> <z>] or
/foxguard state position add [<x> <y> <z>]
Adds a position to your state buffer. If no parameters are specified, then your current position is used. You can optionally specify exact or relative coordinates. Syntax is the same as that of default Minecraft.
/foxguard position - Adds your current position.
/foxguard position 0 0 0 - Adds the origin.
/foxguard position ~ ~10 ~ - Adds a position 10 blocks above you.
/foxguard wand <type>
Gives you a wand. Current Wand Types available are position (for selection) and counter (mostly harmless). Position wands may also carry custom colours, see the Wands page.
/foxguard flush [field]...
Clears your state buffer. If no fields are specified, all fields are cleared. You can optionally specify which fields to clear.
/foxguard flush - Clears out all fields.
/foxguard flush positions - Clears out positions.
/foxguard flush regions handlers - Clears out Regions and Handlers.
/foxguard list <regions [--w:<world>] | handlers>
Lists Regions or Handlers on the server. If no world is specified, the Regions from all of the worlds are listed.
/foxguard here [-r] [-h] [--w:<world>] [<x> <y> <z>]
Lists the regions and handlers present at a certain position. World defaults to player's current world. Position defaults to player's current position. World and position must be specified if ran from the console.
Flags:
-
r: List only regions. -
h: List only handlers. -
w,world: Used to specify the world to check.
Args:
-
x,y,z: Coordinates to check. Can be relative or absolute.
/foxguard detail <region [--w:<worldname>] | handler> <name> [args...]
Shows detailed information about a Region or Handler. World defaults to current world. This command can take optional arguments at the end, which are passed on to the Region or Handler. Some may use these arguments to filter or return specific information.
/foxguard detail handler hello - Show detailed information about Handler hello.
/foxguard detail region --w:DIM-1 hi a few args - Show detailed information about Region hi in world "DIM-1" with the query a few args.
/foxguard create <region [--w:<world>] | handler> <name> [--priority:<num>] <type> [args...]
Creates a new Region or Handler. Names must be alphanumeric (including underscores and dollar signs) and must not begin with a number. Underscores and dollar signs are allowed as a first character, but that is generally reserved for internal use. Type corresponds to the type of Region or Handler you want to create, and each type may take different parameters. Your state buffer is also used in the creation of Regions and Handlers. Regions often take position lists in their construction, and some Objects can be constructed from other objects. Refer to the documentation of the type of object you are creating for more information.
/foxguard create region --w:DIM1 hello rectangular -20 -20 20 20 - Creates a Rectangular Region of name hello in world "DIM1" and passes on the arguments -20 -20 20 20 to it.
/foxguard create handler heythere 5 simple - Creates a Simple Handler of name heythere with priority 5.
/foxguard delete <region [--w:<world>] | handler> <name>
Deletes a Region or Handler. Cannot be undone. Globals cannot be deleted. It is recommended that you disable objects instead of deleting them unless you made a mistake.
/foxguard modify <region [--w:<world>] | handler> <name> [arguments...]
Modifies a Region or Handler. Refer to documentation of individual objects for what arguments they take, if any. Some objects cannot be modified.
/foxguard <enable | disable> [region [--w:<world>] | handler] [names]...
Enables and disables Regions and Handlers. Disabled objects behave as if they didn't exist, but keep all their settings as normal. Applies to objects in the state buffer as well. If a category isn't specified, both Regions and Handlers in the state buffer will be disabled. If a category is specified, you can optionally add names of objects in addition to those already in the state buffer.
/foxguard link [ [--w:<worldname>] <region name> <handler name> ]
Links Regions and Handlers together. If no parameters are specified, all Regions in your state buffer are linked to all Handlers in your state buffer. Optionally a Region and Handler can be specified for a single link. State buffer objects are then ignored.
/foxguard link - links the objects in your state buffer.
/foxguard link hello hi - links the region hello to handler hi.
/foxguard link --:world saveme fromthenether - links the region saveme from the world world (overworld) to the handler fromthenether.
/foxguard unlink [FULL | EVERYTHING]
Unlinks Regions and Handlers from each other. If no parameters are specified, the Regions in your state buffer are unlinked from the Handlers in your state buffer. If "FULL" (case sensitive) is specified, every Region and Handler in your state buffer is completely unlinked, with the exception of the Global Regions from the Global Handlers. If "EVERYTHING" (case sensitive) is specified, then all Regions and Handlers are unlinked, again with the exception of the Global Regions from the Global Handlers.
/foxguard save
Manually saves FoxGuard objects to database files. Files automatically save when the server is shutdown. You should use this frequently to make sure you don't lose anything.