blob: b0811f80edbe7650feb6da30aea4abc46f5948e4 (
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
package org.bukkit.map;
import java.util.List;
import org.bukkit.World;
/**
* Represents a map item.
*/
public interface MapView {
/**
* An enum representing all possible scales a map can be set to.
*/
public static enum Scale {
CLOSEST(0),
CLOSE(1),
NORMAL(2),
FAR(3),
FARTHEST(4);
private byte value;
private Scale(int value) {
this.value = (byte) value;
}
/**
* Get the scale given the raw value.
* @param value The raw scale
* @return The enum scale, or null for an invalid input
*/
public static Scale valueOf(byte value) {
switch(value) {
case 0: return CLOSEST;
case 1: return CLOSE;
case 2: return NORMAL;
case 3: return FAR;
case 4: return FARTHEST;
default: return null;
}
}
/**
* Get the raw value of this scale level.
* @return The scale value
*/
public byte getValue() {
return value;
}
}
/**
* Get the ID of this map item. Corresponds to the damage value of a map
* in an inventory.
* @return The ID of the map.
*/
public short getId();
/**
* Check whether this map is virtual. A map is virtual if its lowermost
* MapRenderer is plugin-provided.
* @return Whether the map is virtual.
*/
public boolean isVirtual();
/**
* Get the scale of this map.
* @return The scale of the map.
*/
public Scale getScale();
/**
* Set the scale of this map.
* @param scale The scale to set.
*/
public void setScale(Scale scale);
/**
* Get the center X position of this map.
* @return The center X position.
*/
public int getCenterX();
/**
* Get the center Z position of this map.
* @return The center Z position.
*/
public int getCenterZ();
/**
* Set the center X position of this map.
* @param x The center X position.
*/
public void setCenterX(int x);
/**
* Set the center Z position of this map.
* @param z The center Z position.
*/
public void setCenterZ(int z);
/**
* Get the world that this map is associated with. Primarily used by the
* internal renderer, but may be used by external renderers. May return
* null if the world the map is associated with is not loaded.
* @return The World this map is associated with.
*/
public World getWorld();
/**
* Set the world that this map is associated with. The world is used by
* the internal renderer, and may also be used by external renderers.
* @param world The World to associate this map with.
*/
public void setWorld(World world);
/**
* Get a list of MapRenderers currently in effect.
* @return A List<MapRenderer> containing each map renderer.
*/
public List<MapRenderer> getRenderers();
/**
* Add a renderer to this map.
* @param renderer The MapRenderer to add.
*/
public void addRenderer(MapRenderer renderer);
/**
* Remove a renderer from this map.
* @param renderer The MapRenderer to remove.
* @return True if the renderer was successfully removed.
*/
public boolean removeRenderer(MapRenderer renderer);
}
|
