blob: e98650544ae11e38d27efa1e8fdd93c09c4dffe2 (
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
package org.bukkit.inventory.meta;
import org.bukkit.Color;
import org.bukkit.potion.PotionEffect;
import org.bukkit.potion.PotionEffectType;
import org.bukkit.potion.PotionData;
import java.util.List;
/**
* Represents a potion or item that can have custom effects.
*/
public interface PotionMeta extends ItemMeta {
/**
* Sets the underlying potion data
*
* @param data PotionData to set the base potion state to
*/
void setBasePotionData(PotionData data);
/**
* Returns the potion data about the base potion
*
* @return a PotionData object
*/
PotionData getBasePotionData();
/**
* Checks for the presence of custom potion effects.
*
* @return true if custom potion effects are applied
*/
boolean hasCustomEffects();
/**
* Gets an immutable list containing all custom potion effects applied to
* this potion.
* <p>
* Plugins should check that hasCustomEffects() returns true before calling
* this method.
*
* @return the immutable list of custom potion effects
*/
List<PotionEffect> getCustomEffects();
/**
* Adds a custom potion effect to this potion.
*
* @param effect the potion effect to add
* @param overwrite true if any existing effect of the same type should be
* overwritten
* @return true if the potion meta changed as a result of this call
*/
boolean addCustomEffect(PotionEffect effect, boolean overwrite);
/**
* Removes a custom potion effect from this potion.
*
* @param type the potion effect type to remove
* @return true if the potion meta changed as a result of this call
*/
boolean removeCustomEffect(PotionEffectType type);
/**
* Checks for a specific custom potion effect type on this potion.
*
* @param type the potion effect type to check for
* @return true if the potion has this effect
*/
boolean hasCustomEffect(PotionEffectType type);
/**
* Moves a potion effect to the top of the potion effect list.
* <p>
* This causes the client to display the potion effect in the potion's name.
*
* @param type the potion effect type to move
* @return true if the potion meta changed as a result of this call
* @deprecated use {@link org.bukkit.potion.PotionType#PotionType}
*/
@Deprecated
boolean setMainEffect(PotionEffectType type);
/**
* Removes all custom potion effects from this potion.
*
* @return true if the potion meta changed as a result of this call
*/
boolean clearCustomEffects();
/**
* Checks for existence of a potion color.
*
* @return true if this has a custom potion color
*/
boolean hasColor();
/**
* Gets the potion color that is set. A custom potion color will alter the
* display of the potion in an inventory slot.
* <p>
* Plugins should check that hasColor() returns <code>true</code> before
* calling this method.
*
* @return the potion color that is set
*/
Color getColor();
/**
* Sets the potion color. A custom potion color will alter the display of
* the potion in an inventory slot.
*
* @param color the color to set
*/
void setColor(Color color);
@Override
PotionMeta clone();
}
|
