Refactor to maven standard layout (#270)
This commit is contained in:
Narimm
@@ -0,0 +1,41 @@
|
||||
This document describes the public API, which you can use to create extensions to GriefPrevention which add new features. Before I get into the specifics, let me give you a few examples of often-requested features which, to my knowledge, have not yet been implemented by anyone. If you want to make a big impact with a small project, these are the go-to areas! If you publish one of these extensions on BukkitDev, please contact me and I'll add a link from my project to yours.
|
||||
|
||||
Claim Buy/Sell
|
||||
|
||||
I keep saying no to this because I'm developing an anti grief plugin, not a real estate plugin. But it's a common ask. Lots of people would use an extension that allowed them to use server money to buy and sell claims, or to lease subdivisions.
|
||||
|
||||
More Locks
|
||||
|
||||
Many have asked for wooden doors, trap doors, and fence gates to require /AccessTrust. I've insisted that because players generally expect these to be openable (based on the Vanilla experience), players should just "earn" their privacy by finding some iron and building an iron door. Nonetheless, some folks definitely want this.
|
||||
|
||||
Claim Flags
|
||||
|
||||
Sometimes, folks want to add special flags to their claims like "no monsters spawn here". They can do this today by adding other plugins like WorldGuard, which are compatible with GriefPrevention, but it would be nice if they could just use one plugin (and an extension). I think their flag ideas come mostly from Residence and WorldGuard, so you can look there for ideas.
|
||||
|
||||
Claim Entry/Exit Messages
|
||||
|
||||
I keep telling people NO, I won't do this because it's not anti-grief-related and it's expensive to constantly track player movement. But folks want it, and they keep asking for it. You could build an extension which adds some slash commands for naming claims, and displays enter/exit messages as players walk around.
|
||||
|
||||
Now the specifics! Please note, these are the supported operations. I've done my best to "hide" fields and methods which you shouldn't play with, but if you happen to notice something not discussed here, it's best not to fiddle with it. If in doubt, at the very least look at my source code and comments before using something you're unfamiliar with in an extension.
|
||||
|
||||
Getting the Claim at a Location
|
||||
|
||||
Managing Permissions in a Claim
|
||||
|
||||
Creating a New Claim
|
||||
|
||||
Resizing or Moving a Claim
|
||||
|
||||
Extending a Claim Downward
|
||||
|
||||
Changing a Claim's Owner
|
||||
|
||||
Updating Other Claim Fields
|
||||
|
||||
Uniquely Identifying a Claim
|
||||
|
||||
Starting a Siege
|
||||
|
||||
Ending a Siege
|
||||
|
||||
Getting/Updating Player Data
|
||||
@@ -0,0 +1,371 @@
|
||||
name: GriefPrevention
|
||||
main: me.ryanhamshire.GriefPrevention.GriefPrevention
|
||||
softdepend: [Vault, Multiverse-Core, My Worlds, MystCraft, Transporter, TheUnderground, WorldGuard, WorldEdit, RoyalCommands, MultiWorld, Denizen]
|
||||
dev-url: http://dev.bukkit.org/server-mods/grief-prevention
|
||||
loadbefore: [TheUnderground]
|
||||
version: ${project.version}
|
||||
commands:
|
||||
abandonclaim:
|
||||
description: Deletes a claim.
|
||||
usage: /AbandonClaim
|
||||
aliases: [unclaim, declaim, removeclaim, disclaim]
|
||||
permission: griefprevention.claims
|
||||
abandontoplevelclaim:
|
||||
description: Deletes a claim and all its subdivisions.
|
||||
usage: /AbandonTopLevelClaim
|
||||
permission: griefprevention.claims
|
||||
abandonallclaims:
|
||||
description: Deletes ALL your claims.
|
||||
usage: /AbandonAllClaims
|
||||
permission: griefprevention.claims
|
||||
trust:
|
||||
description: Grants a player full access to your claim(s).
|
||||
usage: /Trust <player> Grants a player permission to build. See also /UnTrust, /ContainerTrust, /AccessTrust, and /PermissionTrust.
|
||||
aliases: tr
|
||||
permission: griefprevention.claims
|
||||
untrust:
|
||||
description: Revokes a player's access to your claim(s).
|
||||
usage: /UnTrust <player>
|
||||
aliases: ut
|
||||
permission: griefprevention.claims
|
||||
containertrust:
|
||||
description: Grants a player access to your claim's containers, crops, animals, bed, buttons, and levers.
|
||||
usage: /ContainerTrust <player>. Grants a player access to your inventory, crops, animals, bed, and buttons/levers.
|
||||
aliases: ct
|
||||
permission: griefprevention.claims
|
||||
accesstrust:
|
||||
description: Grants a player entry to your claim(s) and use of your bed.
|
||||
usage: /AccessTrust <player>. Grants a player access to your bed, buttons, and levers.
|
||||
aliases: at
|
||||
permission: griefprevention.claims
|
||||
permissiontrust:
|
||||
description: Grants a player permission to grant his level of permission to others.
|
||||
usage: /PermissionTrust <player>. Permits a player to share his permission level with others.
|
||||
aliases: pt
|
||||
permission: griefprevention.claims
|
||||
subdivideclaims:
|
||||
description: Switches the shovel tool to subdivision mode, used to subdivide your claims.
|
||||
usage: /SubdivideClaims
|
||||
aliases: [sc, subdivideclaim]
|
||||
permission: griefprevention.claims
|
||||
restrictsubclaim:
|
||||
description: Restricts a subclaim, so that it inherits no permissions from the parent claim
|
||||
usage: /restrictsubclaim
|
||||
aliases: rsc
|
||||
permission: griefprevention.claims
|
||||
adjustbonusclaimblocks:
|
||||
description: Adds or subtracts bonus claim blocks for a player.
|
||||
usage: /AdjustBonusClaimBlocks <player> <amount>
|
||||
permission: griefprevention.adjustclaimblocks
|
||||
aliases: acb
|
||||
adjustbonusclaimblocksall:
|
||||
description: Adds or subtracts bonus claim blocks for all online players.
|
||||
usage: /AdjustBonusClaimBlocksAll <player> <amount>
|
||||
permission: griefprevention.adjustclaimblocks
|
||||
aliases: acball
|
||||
setaccruedclaimblocks:
|
||||
description: Updates a player's accrued claim block total.
|
||||
usage: /SetAccruedClaimBlocks <player> <amount>
|
||||
permission: griefprevention.adjustclaimblocks
|
||||
aliases: scb
|
||||
deleteclaim:
|
||||
description: Deletes the claim you're standing in, even if it's not your claim.
|
||||
usage: /DeleteClaim
|
||||
permission: griefprevention.deleteclaims
|
||||
deleteallclaims:
|
||||
description: Deletes all of another player's claims.
|
||||
usage: /DeleteAllClaims <player>
|
||||
permission: griefprevention.deleteclaims
|
||||
deleteclaimsinworld:
|
||||
description: Deletes all the claims in a world. Only usable at the server console.
|
||||
usage: /DeleteClaimsInWorld <world>
|
||||
aliases: [deleteallclaimsinworld, clearclaimsinworld, clearallclaimsinworld]
|
||||
permission: griefprevention.deleteclaimsinworld
|
||||
deleteuserclaimsinworld:
|
||||
description: Deletes all the non-admin claims in a world. Only usable at the server console.
|
||||
usage: /DeleteUserClaimsInWorld <world>
|
||||
aliases: [deletealluserclaimsinworld, clearuserclaimsinworld, clearalluserclaimsinworld]
|
||||
permission: griefprevention.deleteclaimsinworld
|
||||
adminclaims:
|
||||
description: Switches the shovel tool to administrative claims mode.
|
||||
usage: /AdminClaims
|
||||
permission: griefprevention.adminclaims
|
||||
aliases: ac
|
||||
restorenature:
|
||||
description: Switches the shovel tool to restoration mode.
|
||||
usage: /RestoreNature
|
||||
permission: griefprevention.restorenature
|
||||
aliases: rn
|
||||
restorenatureaggressive:
|
||||
description: Switches the shovel tool to aggressive restoration mode.
|
||||
usage: /RestoreNatureAggressive
|
||||
permission: griefprevention.restorenatureaggressive
|
||||
aliases: rna
|
||||
restorenaturefill:
|
||||
description: Switches the shovel tool to fill mode.
|
||||
usage: /RestoreNatureFill <radius>
|
||||
permission: griefprevention.restorenatureaggressive
|
||||
aliases: rnf
|
||||
basicclaims:
|
||||
description: Switches the shovel tool back to basic claims mode.
|
||||
usage: /BasicClaims
|
||||
aliases: bc
|
||||
permission: griefprevention.claims
|
||||
extendclaim:
|
||||
description: Resizes the land claim you're standing in by pushing or pulling its boundary in the direction you're facing.
|
||||
usage: /ExtendClaim <numberOfBlocks>
|
||||
aliases: [expandclaim, resizeclaim]
|
||||
permission: griefprevention.claims
|
||||
claim:
|
||||
description: Creates a land claim centered at your current location.
|
||||
usage: /Claim [optional radius]
|
||||
aliases: [createclaim, makeclaim, newclaim]
|
||||
permission: griefprevention.claims
|
||||
buyclaimblocks:
|
||||
description: Purchases additional claim blocks with server money. Doesn't work on servers without a Vault-compatible economy plugin.
|
||||
usage: /BuyClaimBlocks <numberOfBlocks>
|
||||
aliases: buyclaim
|
||||
permission: griefprevention.buysellclaimblocks
|
||||
sellclaimblocks:
|
||||
description: Sells your claim blocks for server money. Doesn't work on servers without a Vault-compatible economy plugin.
|
||||
usage: /SellClaimBlocks <numberOfBlocks>
|
||||
aliases: sellclaim
|
||||
permission: griefprevention.buysellclaimblocks
|
||||
trapped:
|
||||
description: Ejects you to nearby unclaimed land. Has a substantial cooldown period.
|
||||
usage: /Trapped
|
||||
permission: griefprevention.trapped
|
||||
trustlist:
|
||||
description: Lists permissions for the claim you're standing in.
|
||||
usage: /TrustList
|
||||
permission: griefprevention.claims
|
||||
siege:
|
||||
description: Initiates a siege versus another player.
|
||||
usage: /Siege <playerName>
|
||||
permission: griefprevention.siege
|
||||
ignoreclaims:
|
||||
description: Toggles ignore claims mode.
|
||||
usage: /IgnoreClaims
|
||||
permission: griefprevention.ignoreclaims
|
||||
aliases: ic
|
||||
deletealladminclaims:
|
||||
description: Deletes all administrative claims.
|
||||
usage: /DeleteAllAdminClaims
|
||||
permission: griefprevention.adminclaims
|
||||
adminclaimslist:
|
||||
description: Lists all administrative claims.
|
||||
usage: /AdminClaimsList
|
||||
permission: griefprevention.adminclaims
|
||||
transferclaim:
|
||||
description: Converts an administrative claim to a private claim.
|
||||
usage: /TransferClaim <player>
|
||||
aliases: giveclaim
|
||||
permission: griefprevention.transferclaim
|
||||
unlockdrops:
|
||||
description: Allows other players to pick up the items you dropped when you died.
|
||||
usage: /UnlockDrops
|
||||
permission: griefprevention.unlockdrops
|
||||
claimslist:
|
||||
description: Lists information about a player's claim blocks and claims.
|
||||
usage: /ClaimsList or /ClaimsList <player>
|
||||
aliases: [claimlist, listclaims]
|
||||
permission: griefprevention.claims
|
||||
claimexplosions:
|
||||
description: Toggles whether explosives may be used in a specific land claim.
|
||||
usage: /ClaimExplosions
|
||||
permission: griefprevention.claims
|
||||
aliases: claimexplosion
|
||||
softmute:
|
||||
description: Toggles whether a player's messages will only reach other soft-muted players.
|
||||
usage: /SoftMute <player>
|
||||
permission: griefprevention.softmute
|
||||
gpreload:
|
||||
description: Reloads Grief Prevention's configuration settings. Does NOT totally reload the entire plugin.
|
||||
usage: /gpreload
|
||||
permission: griefprevention.reload
|
||||
givepet:
|
||||
description: Allows a player to give away a pet he or she tamed.
|
||||
usage: /GivePet <player>
|
||||
permission: griefprevention.givepet
|
||||
gpblockinfo:
|
||||
description: Allows an administrator to get technical information about blocks in the world and items in hand.
|
||||
usage: /GPBlockInfo
|
||||
permission: griefprevention.gpblockinfo
|
||||
ignoreplayer:
|
||||
description: Ignores another player's chat messages.
|
||||
usage: /IgnorePlayer <player name>
|
||||
aliases: [ignore]
|
||||
permission: griefprevention.ignore
|
||||
unignoreplayer:
|
||||
description: Unignores another player's chat messages.
|
||||
usage: /UnIgnorePlayer <player name>
|
||||
aliases: [unignore]
|
||||
permission: griefprevention.ignore
|
||||
ignoredplayerlist:
|
||||
description: Lists the players you're ignoring in chat.
|
||||
usage: /IgnoredPlayerList
|
||||
aliases: [ignores, ignored, ignorelist, ignoredlist, listignores, listignored, ignoring]
|
||||
permission: griefprevention.ignore
|
||||
separate:
|
||||
description: Forces two players to ignore each other in chat.
|
||||
usage: /Separate <player1> <player2>
|
||||
permission: griefprevention.separate
|
||||
unseparate:
|
||||
description: Reverses /separate.
|
||||
usage: /UnSeparate <player1> <player2>
|
||||
permission: griefprevention.separate
|
||||
claimbook:
|
||||
description: Gives a player a manual about claiming land.
|
||||
usage: /ClaimBook <player>
|
||||
permission: griefprevention.claimbook
|
||||
permissions:
|
||||
griefprevention.createclaims:
|
||||
description: Grants permission to create claims.
|
||||
default: true
|
||||
griefprevention.admin.*:
|
||||
description: Grants all administrative functionality.
|
||||
children:
|
||||
griefprevention.restorenature: true
|
||||
griefprevention.restorenatureaggressive: true
|
||||
griefprevention.ignoreclaims: true
|
||||
griefprevention.adminclaims: true
|
||||
griefprevention.adjustclaimblocks: true
|
||||
griefprevention.deleteclaims: true
|
||||
griefprevention.spam: true
|
||||
griefprevention.lava: true
|
||||
griefprevention.eavesdrop: true
|
||||
griefprevention.deathblow: true
|
||||
griefprevention.softmute: true
|
||||
griefprevention.reload: true
|
||||
griefprevention.visualizenearbyclaims: true
|
||||
griefprevention.overrideclaimcountlimit: true
|
||||
griefprevention.transferclaim: true
|
||||
griefprevention.claimslistother: true
|
||||
griefprevention.siegeimmune: true
|
||||
griefprevention.separate: true
|
||||
griefprevention.eavesdropsigns: true
|
||||
griefprevention.claimbook: true
|
||||
griefprevention.notignorable: true
|
||||
griefprevention.seeinactivity: true
|
||||
griefprevention.eavesdropimmune: true
|
||||
griefprevention.deleteclaimsinworld: true
|
||||
griefprevention.siegeteleport: true
|
||||
griefprevention.unlockothersdrops: true
|
||||
griefprevention.seeclaimsize: true
|
||||
griefprevention.siegeimmune:
|
||||
description: Makes a player immune to /Siege.
|
||||
default: op
|
||||
griefprevention.givepet:
|
||||
description: Grants permission to use /GivePet.
|
||||
default: true
|
||||
griefprevention.siege:
|
||||
description: Grants permission to use /Siege.
|
||||
default: true
|
||||
griefprevention.unlockdrops:
|
||||
description: Grants permission to use /UnlockDrops.
|
||||
default: true
|
||||
griefprevention.unlockothersdrops:
|
||||
description: Grants permission to use /UnlockDrops for other players.
|
||||
default: op
|
||||
griefprevention.trapped:
|
||||
description: Grants permission to use /Trapped.
|
||||
default: true
|
||||
griefprevention.claimslistother:
|
||||
description: Grants permission to use /ClaimsList to get another player's information.
|
||||
default: op
|
||||
griefprevention.restorenature:
|
||||
description: Grants permission to use /RestoreNature.
|
||||
default: op
|
||||
griefprevention.transferclaim:
|
||||
description: Grants permission to use /TransferClaim.
|
||||
default: op
|
||||
griefprevention.ignoreclaims:
|
||||
description: Grants permission to use /IgnoreClaims.
|
||||
default: op
|
||||
griefprevention.adminclaims:
|
||||
description: Grants permission to create administrative claims.
|
||||
default: op
|
||||
griefprevention.deleteclaims:
|
||||
description: Grants permission to delete other players' claims.
|
||||
default: op
|
||||
griefprevention.deleteclaimsinworld:
|
||||
description: Not used. DeleteClaimsInWorld must be executed at the server console.
|
||||
default: op
|
||||
griefprevention.adjustclaimblocks:
|
||||
description: Grants permission to add or remove bonus blocks from a player's account.
|
||||
default: op
|
||||
griefprevention.spam:
|
||||
description: Grants permission to log in, send messages, and send commands rapidly.
|
||||
default: op
|
||||
griefprevention.lava:
|
||||
description: Grants permission to place lava near the surface and outside of claims.
|
||||
default: op
|
||||
griefprevention.eavesdrop:
|
||||
description: Allows a player to see whispered chat messages (/tell) and softmuted messages.
|
||||
default: op
|
||||
griefprevention.eavesdropsigns:
|
||||
description: Allows a player to see sign placements as chat messages.
|
||||
default: op
|
||||
griefprevention.restorenatureaggressive:
|
||||
description: Grants access to /RestoreNatureAggressive and /RestoreNatureFill.
|
||||
default: op
|
||||
griefprevention.deathblow:
|
||||
description: Grants access to /DeathBlow.
|
||||
default: op
|
||||
griefprevention.reload:
|
||||
description: Grants access to /gpreload.
|
||||
default: op
|
||||
griefprevention.softmute:
|
||||
description: Grants access to /SoftMute.
|
||||
default: op
|
||||
griefprevention.claims:
|
||||
description: Grants access to claim-related slash commands.
|
||||
default: true
|
||||
griefprevention.buysellclaimblocks:
|
||||
description: Grants access to claim block buy/sell commands.
|
||||
default: true
|
||||
griefprevention.visualizenearbyclaims:
|
||||
description: Allows a player to see all nearby claims at once.
|
||||
default: op
|
||||
griefprevention.seeclaimsize:
|
||||
description: Allows a player to see claim size for other players claims when right clicking with investigation tool
|
||||
default: op
|
||||
griefprevention.gpblockinfo:
|
||||
description: Grants access to /GPBlockInfo.
|
||||
default: op
|
||||
griefprevention.overrideclaimcountlimit:
|
||||
description: Allows players to create more claims than the limit specified by the config.
|
||||
default: op
|
||||
griefprevention.separate:
|
||||
description: Grants access to /Separate and /UnSeparate.
|
||||
default: op
|
||||
griefprevention.ignore:
|
||||
description: Grants access to /Ignore, /Unignore, and /IgnoreList
|
||||
default: true
|
||||
griefprevention.claimbook:
|
||||
description: Grants access to /ClaimBook.
|
||||
default: op
|
||||
griefprevention.notignorable:
|
||||
description: Players with this permission can't be ignored.
|
||||
default: op
|
||||
griefprevention.seeinactivity:
|
||||
description: Players with this permission can see how long a claim owner has been offline.
|
||||
default: op
|
||||
griefprevention.eavesdropimmune:
|
||||
description: Players with this permission can't have their private messages eavesdropped.
|
||||
default: op
|
||||
griefprevention.fasteraccrual:
|
||||
description: Players with this permission accrue claim blocks at the faster rate specified in the config file.
|
||||
default: false
|
||||
griefprevention.fastestaccrual:
|
||||
description: Players with this permission accrue claim blocks at the fastest rate specified in the config file.
|
||||
default: false
|
||||
griefprevention.moreaccrued:
|
||||
description: Players with this permission can accrue more claim blocks (limit specified in the config file).
|
||||
default: false
|
||||
griefprevention.mostaccrued:
|
||||
description: Players with this permission can accrue more claim blocks (limit specified in the config file).
|
||||
default: false
|
||||
griefprevention.siegeteleport:
|
||||
description: Players with this permission can teleport into and out of besieged areas.
|
||||
default: op
|
||||
Reference in New Issue
Block a user