blob: 02486c1f2ffe92a5ef0c6adad25356875a619c56 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
package org.bukkit.inventory.meta;
import java.util.List;
import org.bukkit.FireworkEffect;
import org.bukkit.Material;
/**
* Represents a {@link Material#FIREWORK_ROCKET} and its effects.
*/
public interface FireworkMeta extends ItemMeta {
/**
* Add another effect to this firework.
*
* @param effect The firework effect to add
* @throws IllegalArgumentException If effect is null
*/
void addEffect(FireworkEffect effect) throws IllegalArgumentException;
/**
* Add several effects to this firework.
*
* @param effects The firework effects to add
* @throws IllegalArgumentException If effects is null
* @throws IllegalArgumentException If any effect is null (may be thrown
* after changes have occurred)
*/
void addEffects(FireworkEffect... effects) throws IllegalArgumentException;
/**
* Add several firework effects to this firework.
*
* @param effects An iterable object whose iterator yields the desired
* firework effects
* @throws IllegalArgumentException If effects is null
* @throws IllegalArgumentException If any effect is null (may be thrown
* after changes have occurred)
*/
void addEffects(Iterable<FireworkEffect> effects) throws IllegalArgumentException;
/**
* Get the effects in this firework.
*
* @return An immutable list of the firework effects
*/
List<FireworkEffect> getEffects();
/**
* Get the number of effects in this firework.
*
* @return The number of effects
*/
int getEffectsSize();
/**
* Remove an effect from this firework.
*
* @param index The index of the effect to remove
* @throws IndexOutOfBoundsException If index {@literal < 0 or index >} {@link
* #getEffectsSize()}
*/
void removeEffect(int index) throws IndexOutOfBoundsException;
/**
* Remove all effects from this firework.
*/
void clearEffects();
/**
* Get whether this firework has any effects.
*
* @return true if it has effects, false if there are no effects
*/
boolean hasEffects();
/**
* Gets the approximate height the firework will fly.
*
* @return approximate flight height of the firework.
*/
int getPower();
/**
* Sets the approximate power of the firework. Each level of power is half
* a second of flight time.
*
* @param power the power of the firework, from 0-128
* @throws IllegalArgumentException if {@literal height<0 or height>128}
*/
void setPower(int power) throws IllegalArgumentException;
FireworkMeta clone();
}
|
