查看“Magic/Parameters”的源代码

== Spell Parameters ==

=== Spell Properties ===

There are some base properties of a spell that can't be changed by cast parameters or wand overrides. These properties go at the base level of a spell's configuration, alongside &quot;actions&quot;, &quot;effects&quot; and &quot;parameters&quot;.

Please check out the [http://mine.elmakers.com/reference/#spells Reference Manual] for complete descriptions of all spell properties!

== Wand Parameters ==

=== Wand Customization ===

Every wand is a unique item, though they may be created from templates. The survival templates can be found here:

https://github.com/elBukkit/MagicPlugin/blob/master/Magic/src/main/resources/examples/survival/wands/

Any of the parameters below may be used in a template, or applied to a wand in-game via any of the following commands

<pre class="">/wand configure
/wand upgrade
/wandp @p configure
/wandp @p upgrade</pre>
The &quot;upgrade&quot; command will never lower a value on a wand, and is meant for in-game command block or other<br />
use, to allow players to upgrade their wands, such incrase mana regeneration to a set limit, while not<br />
affecting a wand that already has a higher xp regen.

Note (mainly to other plugin developers) that these parameters are also the NBT tags used to store wand data, under the &quot;wand&quot;<br />
parent node.

==== Parameters ====

Please check out the [http://mine.elmakers.com/reference/#wands Reference Manual] for descriptions of all wand parameters!

=== Messages ===

All wand template names and descriptions are contained in messages.yml, <br />
though non-builtin wands may include a default name and description in the wands.yml definition.

== EffectLib Parameters ==

EffectLib effects can be used via an &quot;effectlib&quot; block. The only required parameter in this block is &quot;class&quot;, referring to an EffectLib class.

You can use the &quot;fxdemo&quot; spell in-game to preview all of the available effects.

Please check out the [http://mine.elmakers.com/reference/#effectlib Reference Manual] for a list of all EffectLib effects and parameters!

=== Examples ===

<pre class="">   effects:
      cast:
      - location: target
        effectlib:
          class: AnimatedBall
          duration: 5000</pre>
=== Developers ===

Developers may want to browse through the [http://jenkins.elmakers.com/job/EffectLib/doxygen/namespacede_1_1slikey_1_1effectlib_1_1effect.html doxygen documentation].

== Effect Parameters ==

=== Effects ===

Each effect is configured using a &quot;player&quot; class and several common parameters:

| Name | Values | Description<br />
|-------------------|----------------|-----------------<br />
| effectlib | [[EffectLibParameters|EffectLib]] | Configuration of an [[EffectLib|EffectLib]] effect.<br />
| location | target/origin/both | Where to play the effect<br />
| color | RRGGBB | The main color to use, only applies to some effects (like Fireworks)<br />
| color1 | RRGGBB | The secondary color to use, only applies to some effects (like Fireworks)<br />
| delay | milliseconds | How long to wait before starting the effect<br />
| effect | Effect name | A Bukkit effect, often includes sound and particles<br />
| sound | [[Sound|Sound name]] | A sound to play, taken from the Bukkit sound constant or sounds.json<br />
| sound''volume | 0.0 - 2.0 | The volume at which to play a sound<br />
| sound''pitch | 0.0 - 2.0 | The pitch to use for playing a sound<br />
| particle | Particle name | A Particle type to use, taken from a Magic constant<br />
| particle''count | count | The number of particles to spawn<br />
| particle''offset''x | integer | How much random x-jitter to apply to particles<br />
| particle''offset''y | integer | How much random y-jitter to apply to particles<br />
| particle''offset''z | integer | How much random z-jitter to apply to particles<br />
| particle''data | integer | A special magic data number, use with care, it can crash the client!!<br />
| particle''sub''type | string | A special magic data value, use with care, it can crash the client!!<br />
| firework | Firework Effect | The type of firework to launch, if other firework params are specified without this it will be random<br />
| firework''power | integer | The firework power<br />
| firework''flicker | true/false | Whether or not to flicker the firework effect

==== Built-in Effects ====

Magic comes with a few builtin effect players that may be useful, but in general if you're using EffectLib effects, EffectSingle is the only one you need.

==== Built-in Effect Configuration ====

| Name | Values | Description<br />
|-------------------|----------------|-----------------<br />
| class | Class name | An effect player class, either a builtin or a fully-qualified external EffectPlayer. Defaults to EffectSingle.

==== Repeating Effects ====

| Name | Values | Description<br />
|-------------------|----------------|-----------------<br />
| iterations | count | How many times to repeat the effect<br />
| period | milliseconds | How often to repeat the effect<br />
| reverse | true/false | Whether or not to play the effect in reverse

==== EffectRing ====

| Name | Values | Description<br />
|-------------------|----------------|-----------------<br />
| radius | blocks | How large the ring should get<br />
| size | count | How many effects to spawn per ring

==== EffectTrail ====

| Name | Values | Description<br />
|-------------------|----------------|-----------------<br />
| length | blocks | The length of the trail, may be automatic if a target was provided.

enum reference:

* Sound: https://raw.githubusercontent.com/Bukkit/Bukkit/master/src/main/java/org/bukkit/Sound.java
* Effect: https://raw.githubusercontent.com/Bukkit/Bukkit/master/src/main/java/org/bukkit/Effect.java
* ParticleType: https://github.com/Slikey/EffectLib/blob/master/src/main/java/de/slikey/effectlib/util/ParticleEffect.java#L44
* FireworkEffect: https://raw.githubusercontent.com/Bukkit/Bukkit/master/src/main/java/org/bukkit/FireworkEffect.java
* EffectLib Classes: http://dev.bukkit.org/bukkit-plugins/effectlib/