Skip to content

Commands

Jump to bottom
netcrafter edited this page Nov 21, 2015 · 6 revisions

##Command List All commands follow format /wgpg <command|commandAlias> <args...>. <> = required argument. [] = optional argument. Optional arguments must be specified when running WGPG commands from the console.

  • /wgpg polygon <regionName> <radius> <vertices> <offset> <minY> <maxY> [X] [Z] [world]
    • Generate polygonal shapes using Worldguard polygonal regions.
    • Alias: p
    • Permission: wgpg.polygon
  • /wgpg ellipse <regionName> <radiusX> <radiusZ> <vertices> <offset> <rotation> <minY> <maxY> [X] [Z] [world]
    • Generate elliptic shapes using Worldguard polygonal regions.
    • Alias: e
    • Permission: wgpg.ellipse
  • /wgpg circle <regionName> <radius> <minY> <maxY> [X] [Z] [world]
    • Generate circles using Worldguard polygonal regions. A shorted version of the polygon command for creating circles.
    • Alias: c
    • Permission: wgpg.circle
  • /wgpg square <regionName> <size> <minY> <maxY> [rotation] [X] [Z] [world]
    • Generate squares using Worldguard cuboid regions or polygonal regions if rotation specified.
    • Alias: s
    • Permission: wgpg.square
  • /wgpg rectangle <regionName> <sizeX> <sizeZ> <minY> <maxY> [rotation] [X] [Z] [world]
    • Generate rectangles using Worldguard cuboid regions or polygonal regions if rotation specified.
    • Alias: r
    • Permission: wgpg.rectangle
  • /wgpg help
    • Displays a list of WGPG commands.
    • Alias: /wgpg
    • Permission: wgpg.help
  • /wgpg reload
    • Reloads the configuration file.
    • Permission: wgpg.reload

##Command Arguments

####regionName The name you wish to give to the region and the name used by WorldGuard to reference the region. By default you can't create a regions with the name of an existing region. To allow override existing regions enable the override-existing-region option in the config or give the player the permission node wgpg.override. When running commands from the console it will override existing regions, so be careful.

Validation rules:

  • Alphanumeric characters, underscores, commas, apostrophes, hyphens and plus signs.
  • Between 1 and 255 characters long.
  • Can't be "_global_".

####radius The radius is the distance between the center of the polygon set by the X and Y parameters and the vertices of the polygon. Radius
Validation rules:

  • Decimal (double)
  • Greater than or equal to 1

####size The size is the distance from the center of the square set by the X and Z parameters and the edge which intersects the axis centered at X and Z coordinates of the center.
size
Validation rules:

  • Decimal (double)
  • Greater than or equal to 1

####sizeX & sizeZ Similar to size, it's the distance between the center the rectangle set by the X and Y parameters and the edge on the respective axis centered at X and Z coordinates of the center.

Validation rules:

  • Decimal (double)
  • Greater than or equal to 1

####radiusX & radiusZ The distance from the center set by the X and Z parameters and the intersection of the ellipse on the respective axis centered at the center. radiusXZ Validation rules:

  • Decimal (double)
  • Greater than or equal to 1

####vertices The number of vertices in the polygon/ellipse. This is also equal to the number of sides.
Examples: 2 points = straight line, 3 points = triangle, 4 points = square, 5 points = pentagon, 6 points = hexagon, 8 points = octagon, 360 points = circle.

Validation rules:

  • Integer
  • Between 2 and 360

####offset The offset of the coordinate in degrees. The offset sets in a clockwise direction when facing north in game. offset
Validation rules:

  • Decimal (double)
  • Between 0 and 360

####rotation The number of degrees to rotate the axis. The axis of the ellipse will appear to rotate in a clockwise direction when facing north in game. rotationX
rotationZ

Offset and rotation might seem to be the same but they aren't. In the example below both ellipses have a rotation of 45 degrees but the second one has an offset of 30 degrees. Rotation rotates the axis, offset sets the degrees to offset the vertices selected from the ellipse.
rotationVSoffset
Validation rules:

  • Decimal (double)
  • Between 0 and 360

####minY The minimum Y coordinate for all the coordinates of the WorldGuard region.

Validation rules:

  • Integer
  • Between 0 and 255
  • Less than or equal to maxY value

####maxY The maximum Y coordinate for all the coordinates of the WorldGuard region.

Validation rules:

  • Integer
  • Between 0 and 255
  • Greater than or equal to minY value

####X The X coordinate at the center of the polygon/ellipse/square. This is an optional argument if the command is being run by a player. If not specified then the players current location is used.

Validation rules:

  • Decimal (double)

####Z The X coordinate at the center of the polygon/ellipse/square. This is an optional argument if the command is being run by a player. If not specified then the players current location is used.

Validation rules:

  • Decimal (double)

####world The world to create the region in. This is an optional argument if the command is being run by a player. If not specified then the players current world will be used.

Validation rules:

  • Valid world name

##Deleting regions: You can remove regions generated with WGPG using the WorldGuards remove command.
/rg remove <region>
You can also use other regular Worldguard region commands once the region has be created. For example to edit flags, members, owners, priorities, etc. Once the region has been created is behaves exactly like any other WorldGuard region. WGPG can safely be removed after the regions creation.

##Adding Members and Owners: To add members and owners to regions created by WGPG you can use the regular WorldGuard commands:
/rg addowner <region> <player>
or
/rg addmember <region> <player>
In the configuration file you can enable the options add-as-owner and/or add-as-member if you want to be added to the region automatically, as either a member, the owner, or both upon creation of the region.

Clone this wiki locally