mirror of
https://github.com/EngineHub/WorldGuard.git
synced 2024-11-27 21:15:57 +01:00
Added documentation for required hooks. Improved missing hook messages.
This commit is contained in:
parent
f305b3a119
commit
c0b4d95082
21
README.txt
21
README.txt
@ -38,16 +38,22 @@ WorldGuard on your server. You can either restart your server or use
|
||||
/reloadplugin WorldGuard to reload the configuraton file after editing it.
|
||||
|
||||
NOTE: Some features may require a custom version of hMod. When the server
|
||||
is loaded with the plugin, WorldGuard will tell you missing features.
|
||||
is loaded with the plugin, WorldGuard will tell you missing features. Below
|
||||
the required hooks will be mentioned in square brackets below each
|
||||
feature, allowing to see what your server has or needs to use a certain
|
||||
feature of WorldGuard. A list of missing hooks will be printed when you
|
||||
start your server with Worldguard.
|
||||
|
||||
- summary-on-start (def. false)
|
||||
Print a summary of WorldGuard's protection settings at-a-glance when
|
||||
the plugin is loaded.
|
||||
|
||||
- item-durability (def. true)
|
||||
[Requires ITEM_PICK_UP]
|
||||
Enables item durability.
|
||||
|
||||
- classic-water (def. false)
|
||||
[Requires hook FLOW]
|
||||
Toggle use of classic water. Be foreward that your world may be
|
||||
flooded if you are not careful. If you have WorldEdit, you can use
|
||||
//drain in such an event, although that will drain the entire pool
|
||||
@ -56,6 +62,7 @@ is loaded with the plugin, WorldGuard will tell you missing features.
|
||||
spread (preventing waterfalls from becoming tsunamis).
|
||||
|
||||
- simulate-sponge (def. false)
|
||||
[Requires hook FLOW]
|
||||
Toggle simulation of the sponge from Classic. It blocks water from
|
||||
flowing near the sponge.
|
||||
|
||||
@ -65,12 +72,15 @@ is loaded with the plugin, WorldGuard will tell you missing features.
|
||||
increase server load exponentially, although 3-5 has fairly low impact.
|
||||
|
||||
- no-physics-gravel (def. false)
|
||||
[Requires hook BLOCK_PHYSICS]
|
||||
Prevents gravel from falling due to gravity.
|
||||
|
||||
- no-physics-sand (def. false)
|
||||
[Requires hook BLOCK_PHYSICS]
|
||||
Prevents sand from falling due to gravity.
|
||||
|
||||
- allow-portal-anywhere (def. false)
|
||||
[Requires hook BLOCK_PHYSICS]
|
||||
Allows you to place portal blocks anywhere.
|
||||
|
||||
- enforce-single-session (def. true)
|
||||
@ -80,29 +90,36 @@ is loaded with the plugin, WorldGuard will tell you missing features.
|
||||
the new session starts.
|
||||
|
||||
- block-tnt (def. false)
|
||||
[Requires hook EXPLODE]
|
||||
Block TNT explosions. TNT will still explode client-side but the blocks
|
||||
will be "restored" in a few seconds afterwards.
|
||||
|
||||
- block-lighter (def. false)
|
||||
[Requires hook IGNITE]
|
||||
Block flint and steel fires. Those with access to the commands
|
||||
/uselighter or /lighter can bypass this. /uselighter is not a real
|
||||
command; it is only used for permissions.
|
||||
|
||||
- block-creepers (def. false)
|
||||
[Requires hook EXPLODE]
|
||||
Block creeper explosions from destroying terrain (and possibly from
|
||||
causing damage).
|
||||
|
||||
- disable-lava-fire (def. false)
|
||||
[Requires hook IGNITE]
|
||||
Prevent lava from starting fires.
|
||||
|
||||
- allowed-lava-spread-blocks (no default)
|
||||
[Requires hook FLOW]
|
||||
List of block names/IDs to allow lava to spread to. Leave blank
|
||||
to disable this feature.
|
||||
|
||||
- disable-all-fire-spread (def. false)
|
||||
[Requires hook IGNITE]
|
||||
Disable all fire from spreading.
|
||||
|
||||
- disallowed-fire-spread-blocks (no default)
|
||||
[Requires hook FLOW]
|
||||
List of block names/IDs to prevent fire from spreading to. Leave blank
|
||||
to disable this feature. Enabling disable-all-fire-spread will
|
||||
override this function.
|
||||
@ -179,6 +196,7 @@ Commands
|
||||
--------
|
||||
|
||||
- /stopfire and /allowfire
|
||||
[Requires hook IGNITE]
|
||||
Disables and enables fire spread globally. Both commands require the
|
||||
permission to use only "/stopfire. Re-enabling fire spread with this
|
||||
command will not override other fire spread control features of
|
||||
@ -189,6 +207,7 @@ Server Commands
|
||||
---------------
|
||||
|
||||
- fire-stop and fire-allow
|
||||
[Requires hook IGNITE]
|
||||
Disables and enables fire spread globally. Re-enabling fire spread
|
||||
with this command will not override other fire spread control features
|
||||
of WorldGuard. Note that disabling fire does not disable fire damage
|
||||
|
@ -66,7 +66,8 @@ public void initialize() {
|
||||
missingFeatures.add("disabling fire or lava fire");
|
||||
}
|
||||
if (!registerHook("FLOW", PluginListener.Priority.HIGH)) {
|
||||
missingFeatures.add("controlling lava flow or sponges");
|
||||
missingFeatures.add("controlling lava flow");
|
||||
missingFeatures.add("sponges");
|
||||
}
|
||||
registerHook("LOGINCHECK", PluginListener.Priority.HIGH);
|
||||
registerHook("LOGIN", PluginListener.Priority.MEDIUM);
|
||||
@ -77,6 +78,7 @@ public void initialize() {
|
||||
registerHook("ITEM_DROP", PluginListener.Priority.HIGH);
|
||||
if (!registerHook("ITEM_PICK_UP", PluginListener.Priority.HIGH)) {
|
||||
missingFeatures.add("denying item pickups");
|
||||
missingFeatures.add("item durability fix");
|
||||
}
|
||||
registerHook("COMPLEX_BLOCK_CHANGE", PluginListener.Priority.HIGH);
|
||||
registerHook("COMPLEX_BLOCK_SEND", PluginListener.Priority.HIGH);
|
||||
|
Loading…
Reference in New Issue
Block a user