Added permissions node to Documentation Printer.

This commit is contained in:
Wizjany 2011-05-27 00:17:51 -04:00
parent 4c532d9772
commit 62a78994fd
2 changed files with 364 additions and 280 deletions

View File

@ -171,7 +171,7 @@ public class DocumentationPrinter {
stream.println("name: WorldEdit"); stream.println("name: WorldEdit");
stream.println("main: com.sk89q.worldedit.bukkit.WorldEditPlugin"); stream.println("main: com.sk89q.worldedit.bukkit.WorldEditPlugin");
stream.println("version: \"WEVERSIONMACRO\""); stream.println("version: ${project.version}");
stream.println("commands:"); stream.println("commands:");
for (Class<?> cls : commandClasses) { for (Class<?> cls : commandClasses) {
@ -192,6 +192,12 @@ public class DocumentationPrinter {
+ StringUtil.joinQuotedString(cmd.aliases(), ", ", 1, "'") + StringUtil.joinQuotedString(cmd.aliases(), ", ", 1, "'")
+ "]"); + "]");
} }
if (!method.isAnnotationPresent(CommandPermissions.class)) {
continue;
}
CommandPermissions cmdPerms = method.getAnnotation(CommandPermissions.class);
stream.println(" permissions: "
+ StringUtil.joinQuotedString(cmdPerms.value(), ", ", 0, "'"));
} }
} }
} }

View File

@ -1,279 +1,357 @@
name: WorldEdit name: WorldEdit
main: com.sk89q.worldedit.bukkit.WorldEditPlugin main: com.sk89q.worldedit.bukkit.WorldEditPlugin
version: "${project.version}" version: ${project.version}
commands: commands:
chunkinfo: chunkinfo:
description: Get information about the chunk that you are inside description: Get information about the chunk that you are inside
usage: /<command> usage: /<command>
listchunks: permissions: 'worldedit.chunkinfo'
description: List chunks that your selection includes listchunks:
usage: /<command> description: List chunks that your selection includes
delchunks: usage: /<command>
description: Delete chunks that your selection includes permissions: 'worldedit.listchunks'
usage: /<command> delchunks:
clearclipboard: description: Delete chunks that your selection includes
description: Clear your clipboard usage: /<command>
usage: /<command> permissions: 'worldedit.delchunks'
/load: /load:
description: Load a schematic into your clipboard description: Load a schematic into your clipboard
usage: /<command> <filename> usage: /<command> <filename>
/save: permissions: 'worldedit.clipboard.load'
description: Save a schematic into your clipboard /save:
usage: /<command> <filename> description: Save a schematic into your clipboard
/copy: usage: /<command> <filename>
description: Copy the selection to the clipboard permissions: 'worldedit.clipboard.save'
usage: /<command> /copy:
/flip: description: Copy the selection to the clipboard
description: Flip the contents of the clipboard usage: /<command>
usage: /<command> [dir] permissions: 'worldedit.clipboard.copy'
/rotate: /flip:
description: Rotate the contents of the clipboard description: Flip the contents of the clipboard
usage: /<command> <angle-in-degrees> usage: /<command> [dir]
/cut: permissions: 'worldedit.clipboard.flip'
description: Cut the selection to the clipboard /rotate:
usage: /<command> [leave-id] description: Rotate the contents of the clipboard
/paste: usage: /<command> <angle-in-degrees>
description: Paste the clipboard's contents permissions: 'worldedit.clipboard.rotate'
usage: /<command> [-ao] /cut:
we: description: Cut the selection to the clipboard
description: WorldEdit commands usage: /<command> [leave-id]
usage: /<command> permissions: 'worldedit.clipboard.cut'
aliases: ['worldedit'] /paste:
toggleplace: description: Paste the clipboard's contents
description: usage: /<command> [-ao]
usage: /<command> permissions: 'worldedit.clipboard.paste'
searchitem: clearclipboard:
description: Search for an item description: Clear your clipboard
usage: /<command> [-bi] <query> usage: /<command>
aliases: ['/l', 'search'] permissions: 'worldedit.clipboard.clear'
/limit: /limit:
description: Modify block change limit description: Modify block change limit
usage: /<command> <limit> usage: /<command> <limit>
/hcyl: permissions: 'worldedit.limit'
description: Generate a hollow cylinder we:
usage: /<command> <block> <radius> [height] description: WorldEdit commands
/cyl: usage: /<command>
description: Generate a cylinder aliases: ['worldedit']
usage: /<command> <block> <radius> [height] toggleplace:
/hsphere: description:
description: Generate a hollow sphere usage: /<command>
usage: /<command> <block> <radius> [raised?] searchitem:
/sphere: description: Search for an item
description: Generate a filled sphere usage: /<command> [-bi] <query>
usage: /<command> <block> <radius> [raised?] aliases: ['/l', 'search']
forestgen: /hcyl:
description: Generate a forest description: Generate a hollow cylinder
usage: /<command> [size] [type] [density] usage: /<command> <block> <radius> [height]
pumpkins: permissions: 'worldedit.generation.cylinder'
description: Generate pumpkin patches /cyl:
usage: /<command> [size] description: Generate a cylinder
clearhistory: usage: /<command> <block> <radius> [height]
description: Clear your history permissions: 'worldedit.generation.cylinder'
usage: /<command> /hsphere:
/redo: description: Generate a hollow sphere
description: Redoes the last action (from history) usage: /<command> <block> <radius> [raised?]
usage: /<command> [times] permissions: 'worldedit.generation.sphere'
aliases: ['redo'] /sphere:
/undo: description: Generate a filled sphere
description: Undoes the last action usage: /<command> <block> <radius> [raised?]
usage: /<command> [times] permissions: 'worldedit.generation.sphere'
aliases: ['undo'] forestgen:
unstuck: description: Generate a forest
description: Escape from being stuck inside a block usage: /<command> [size] [type] [density]
usage: /<command> permissions: 'worldedit.generation.forest'
ascend: pumpkins:
description: Go up a floor description: Generate pumpkin patches
usage: /<command> usage: /<command> [size]
descend: permissions: 'worldedit.generation.pumpkins'
description: Go down a floor /undo:
usage: /<command> description: Undoes the last action
thru: usage: /<command> [times]
description: Passthrough walls aliases: ['undo']
usage: /<command> permissions: 'worldedit.history.undo'
jumpto: /redo:
description: Teleport to a location description: Redoes the last action (from history)
usage: /<command> usage: /<command> [times]
ceil: aliases: ['redo']
description: Go to the celing permissions: 'worldedit.history.redo'
usage: /<command> [clearance] clearhistory:
up: description: Clear your history
description: Go upwards some distance usage: /<command>
usage: /<command> <block> permissions: 'worldedit.history.clear'
/overlay: unstuck:
description: Set a block on top of blocks in the region description: Escape from being stuck inside a block
usage: /<command> <block> usage: /<command>
/walls: permissions: 'worldedit.navigation.unstuck'
description: Build the four sides of the selection ascend:
usage: /<command> <block> description: Go up a floor
/faces: usage: /<command>
description: Build the walls, ceiling, and roof of a selection permissions: 'worldedit.navigation.ascend'
usage: /<command> <block> descend:
aliases: ['/outline'] description: Go down a floor
/smooth: usage: /<command>
description: Smooth the elevation in the selection permissions: 'worldedit.navigation.descend'
usage: /<command> [iterations] ceil:
/regen: description: Go to the celing
description: Regenerates the contents of the selection usage: /<command> [clearance]
usage: /<command> permissions: 'worldedit.navigation.ceiling'
/replace: thru:
description: Replace all blocks in the selection with another description: Passthrough walls
usage: /<command> [from-block] <to-block> usage: /<command>
/stack: permissions: 'worldedit.navigation.thru'
description: Repeat the contents of the selection jumpto:
usage: /<command> [-a] [count] [direction] description: Teleport to a location
/set: usage: /<command>
description: Set all the blocks inside the selection to a block permissions: 'worldedit.navigation.jumpto'
usage: /<command> <block> up:
/move: description: Go upwards some distance
description: Move the contents of the selection usage: /<command> <block>
usage: /<command> [count] [direction] [leave-id] permissions: 'worldedit.navigation.up'
.s: /replace:
description: Execute last CraftScript description: Replace all blocks in the selection with another
usage: /<command> [args...] usage: /<command> [from-block] <to-block>
cs: permissions: 'worldedit.region.replace'
description: Execute a CraftScript /stack:
usage: /<command> <filename> [args...] description: Repeat the contents of the selection
/chunk: usage: /<command> [-sa] [count] [direction]
description: Set the selection to your current chunk permissions: 'worldedit.region.stack'
usage: /<command> /set:
/pos1: description: Set all the blocks inside the selection to a block
description: Set position 1 usage: /<command> <block>
usage: /<command> permissions: 'worldedit.region.set'
/pos2: /overlay:
description: Set position 2 description: Set a block on top of blocks in the region
usage: /<command> usage: /<command> <block>
/hpos1: permissions: 'worldedit.region.overlay'
description: Set position 1 to targeted block /walls:
usage: /<command> description: Build the four sides of the selection
/hpos2: usage: /<command> <block>
description: Set position 2 to targeted block permissions: 'worldedit.region.walls'
usage: /<command> /faces:
/wand: description: Build the walls, ceiling, and roof of a selection
description: Get the wand object usage: /<command> <block>
usage: /<command> aliases: ['/outline']
toggleeditwand: permissions: 'worldedit.region.faces'
description: Toggle functionality of the edit wand /smooth:
usage: /<command> description: Smooth the elevation in the selection
/contract: usage: /<command> [iterations]
description: Contract the selection area permissions: 'worldedit.region.smooth'
usage: /<command> <amount> [reverse-amount] [direction] /move:
/outset: description: Move the contents of the selection
description: Outset the selection area usage: /<command> [-s] [count] [direction] [leave-id]
usage: /<command> [-hv] <amount> permissions: 'worldedit.region.move'
/distr: /regen:
description: Get the distribution of blocks in the selection description: Regenerates the contents of the selection
usage: /<command> [-c] usage: /<command>
/count: permissions: 'worldedit.regen'
description: Counts the number of a certain type of block cs:
usage: /<command> <block> description: Execute a CraftScript
/size: usage: /<command> <filename> [args...]
description: Get information about the selection permissions: 'worldedit.scripting.execute'
usage: /<command> .s:
/shift: description: Execute last CraftScript
description: Shift the selection area usage: /<command> [args...]
usage: /<command> <amount> [direction] permissions: 'worldedit.scripting.execute'
/expand: /count:
description: Expand the selection area description: Counts the number of a certain type of block
usage: /<command> <amount> [reverse-amount] <direction> usage: /<command> <block>
/sel: permissions: 'worldedit.analysis.count'
description: Choose a region selector /size:
usage: /<command> [type] description: Get information about the selection
aliases: [','] usage: /<command>
/inset: permissions: 'worldedit.selection.size'
description: Inset the selection area /shift:
usage: /<command> [-hv] <amount> description: Shift the selection area
snapshot: usage: /<command> <amount> [direction]
description: Snapshot commands permissions: 'worldedit.selection.shift'
usage: /<command> /chunk:
aliases: ['snap'] description: Set the selection to your current chunk
restore: usage: /<command>
description: Restore the selection from a snapshot permissions: 'worldedit.selection.chunk'
usage: /<command> [snapshot] /expand:
aliases: ['/restore'] description: Expand the selection area
/: usage: /<command> <amount> [reverse-amount] <direction>
description: Toggle the super pickaxe pickaxe function permissions: 'worldedit.selection.expand'
usage: /<command> /contract:
aliases: [','] description: Contract the selection area
superpickaxe: usage: /<command> <amount> [reverse-amount] [direction]
description: Select super pickaxe mode permissions: 'worldedit.selection.contract'
usage: /<command> /pos1:
aliases: ['pickaxe', 'sp'] description: Set position 1
tool: usage: /<command>
description: Select a tool to bind permissions: 'worldedit.selection.pos'
usage: /<command> /pos2:
mat: description: Set position 2
description: Set the brush material usage: /<command>
usage: /<command> [pattern] permissions: 'worldedit.selection.pos'
aliases: ['material', 'fill'] /hpos1:
size: description: Set position 1 to targeted block
description: Set the brush size usage: /<command>
usage: /<command> [pattern] permissions: 'worldedit.selection.hpos'
mask: /hpos2:
description: Set the brush mask description: Set position 2 to targeted block
usage: /<command> [mask] usage: /<command>
none: permissions: 'worldedit.selection.hpos'
description: Turn off all superpickaxe alternate modes /wand:
usage: /<command> description: Get the wand object
repl: usage: /<command>
description: Block replacer tool permissions: 'worldedit.wand'
usage: /<command> <block> toggleeditwand:
cycler: description: Toggle functionality of the edit wand
description: Block data cycler tool usage: /<command>
usage: /<command> permissions: 'worldedit.wand.toggle'
brush: /outset:
description: Brush tool description: Outset the selection area
usage: /<command> usage: /<command> [-hv] <amount>
aliases: ['br'] permissions: 'worldedit.selection.outset'
info: /inset:
description: Block information tool description: Inset the selection area
usage: /<command> usage: /<command> [-hv] <amount>
tree: permissions: 'worldedit.selection.inset'
description: Tree generator tool /distr:
usage: /<command> [type] description: Get the distribution of blocks in the selection
deltree: usage: /<command> [-c]
description: Floating tree remover tool permissions: 'worldedit.analysis.distr'
usage: /<command> /sel:
/fillr: description: Choose a region selector
description: Fill a hole recursively usage: /<command> [type]
usage: /<command> <block> <radius> [depth] aliases: [',']
fixlava: snapshot:
description: Fix lava to be stationary description: Snapshot commands
usage: /<command> <radius> usage: /<command>
fixwater: aliases: ['snap']
description: Fix water to be stationary restore:
usage: /<command> <radius> description: Restore the selection from a snapshot
removeabove: usage: /<command> [snapshot]
description: Remove blocks above your head. aliases: ['/restore']
usage: /<command> [size] [height] permissions: 'worldedit.snapshots.restore'
removebelow: size:
description: Remove blocks below your head. description: Set the brush size
usage: /<command> [size] [height] usage: /<command> [pattern]
removenear: permissions: 'worldedit.brush.options.size'
description: Remove blocks near you. mask:
usage: /<command> <block> [size] description: Set the brush mask
replacenear: usage: /<command> [mask]
description: Replace nearby blocks permissions: 'worldedit.brush.options.mask'
usage: /<command> <size> <from-id> <to-id> /:
snow: description: Toggle the super pickaxe pickaxe function
description: Simulates snow usage: /<command>
usage: /<command> [radius] aliases: [',']
thaw: permissions: 'worldedit.superpickaxe'
description: Thaws the area superpickaxe:
usage: /<command> [radius] description: Select super pickaxe mode
ex: usage: /<command>
description: Extinguish nearby fire aliases: ['pickaxe', 'sp']
usage: /<command> [radius] tool:
aliases: ['ext', 'extinguish'] description: Select a tool to bind
butcher: usage: /<command>
description: Kill all or nearby mobs mat:
usage: /<command> [radius] description: Set the brush material
remove: usage: /<command> [pattern]
description: Remove all entities of a type aliases: ['material', 'fill']
usage: /<command> <type> <radius> permissions: 'worldedit.brush.options.material'
aliases: ['rem', 'rement'] info:
/fill: description: Block information tool
description: Fill a hole usage: /<command>
usage: /<command> <block> <radius> [depth] permissions: 'worldedit.tool.info'
/drain: none:
description: Drain a pool description: Turn off all superpickaxe alternate modes
usage: /<command> <radius> usage: /<command>
tree:
description: Tree generator tool
usage: /<command> [type]
permissions: 'worldedit.tool.tree'
repl:
description: Block replacer tool
usage: /<command> <block>
permissions: 'worldedit.tool.replacer'
cycler:
description: Block data cycler tool
usage: /<command>
permissions: 'worldedit.tool.data-cycler'
brush:
description: Brush tool
usage: /<command>
aliases: ['br']
deltree:
description: Floating tree remover tool
usage: /<command>
permissions: 'worldedit.tool.deltree'
remove:
description: Remove all entities of a type
usage: /<command> <type> <radius>
aliases: ['rem', 'rement']
permissions: 'worldedit.remove'
/fill:
description: Fill a hole
usage: /<command> <block> <radius> [depth]
permissions: 'worldedit.fill'
/fillr:
description: Fill a hole recursively
usage: /<command> <block> <radius> [depth]
permissions: 'worldedit.fill.recursive'
/drain:
description: Drain a pool
usage: /<command> <radius>
permissions: 'worldedit.drain'
fixlava:
description: Fix lava to be stationary
usage: /<command> <radius>
permissions: 'worldedit.fixlava'
fixwater:
description: Fix water to be stationary
usage: /<command> <radius>
permissions: 'worldedit.fixwater'
removeabove:
description: Remove blocks above your head.
usage: /<command> [size] [height]
permissions: 'worldedit.removeabove'
removebelow:
description: Remove blocks below your head.
usage: /<command> [size] [height]
permissions: 'worldedit.removebelow'
removenear:
description: Remove blocks near you.
usage: /<command> <block> [size]
permissions: 'worldedit.removenear'
replacenear:
description: Replace nearby blocks
usage: /<command> <size> <from-id> <to-id>
permissions: 'worldedit.replacenear'
snow:
description: Simulates snow
usage: /<command> [radius]
permissions: 'worldedit.snow'
thaw:
description: Thaws the area
usage: /<command> [radius]
permissions: 'worldedit.thaw'
ex:
description: Extinguish nearby fire
usage: /<command> [radius]
aliases: ['ext', 'extinguish']
permissions: 'worldedit.extinguish'
butcher:
description: Kill all or nearby mobs
usage: /<command> [-p] [radius]
permissions: 'worldedit.butcher'