Solved Persistent Custom Maps

FINAL EDIT: See the last post for a solution if you're interested in showing player portraits (or any image) on a map in your plugin.

I've recently gotten into the Map API (I love it!), but there's one thing I'm not understanding- how do the renderers stay "attached" to their map views across server reloads? (Or... do they?)

EDIT: I think I'm realizing they do not, and it's up to me to keep track of my custom map id's and reattach the renderers... does that sound right? If so, please still read below because the 1.6 client crash seems weird to me.

I'm finding that after a server reload, my custom maps reset to a default map:

Before:


After Server Reload:


The same applies to map items in my inventory (not a frame).

Furthermore, I've noticed if I switch to 1.6 CB and the 1.6 client, my custom map actually crashes the client when viewed (!)

What am I doing wrong?

My renderer:
https://raw.github.com/elBukkit/Mag...akers/mine/bukkit/utilities/SkinRenderer.java

The render method (which I imagine is the important bit):

Code:java

@Override
public void render(MapView map, MapCanvas canvas, Player player) {
if (portraitImage == null) {
loadSkin();
}
if (portraitImage != null) {
canvas.drawImage(0, 0, portraitImage);
canvas.drawText(2, 116, MinecraftFont.Font, "¤" + MapPalette.GRAY_2 + ";" + playerName);
canvas.drawText(3, 117, MinecraftFont.Font, "¤" + MapPalette.WHITE + ";" + playerName);
}
}

I create the map like this:

https://raw.github.com/elBukkit/Mag.../bukkit/plugins/magic/spells/CameraSpell.java

Code:java

MapView newMap = Bukkit.createMap(world);
for(MapRenderer renderer : newMap.getRenderers()) {
newMap.removeRenderer(renderer);
}
MapRenderer renderer = new SkinRenderer(targetPlayer.getName());
newMap.addRenderer(renderer);
ItemStack newMapItem = new ItemStack(Material.MAP, 1, newMap.getId());
world.dropItemNaturally(player.getLocation(), newMapItem);

Thanks for any help/advice! I assume there's a way to make a map persistently hold an image, else people wouldn't be using these for signs and such... right?

 

In case anyone was curious, I followed some advice from desht in a related thread, and got this working. If anyone is really curious, here's my renderer:

https://raw.github.com/elBukkit/Mag...akers/mine/bukkit/utilities/SkinRenderer.java

In order to use this, you have to persist a map of player names to ids, and call SkinRenderer. loadPlayers() in your plugin's onEnable. (Well, I actually find it works better if you delay it a few seconds).

Then when you want to "take a picture" of another player, you would do something like this:

Code:java

@SuppressWarnings("deprecation")
public static MapView getPlayerPortrait(String playerName) {
// We're going to always take maps from the main world
// This is to avoid potential problems with maps created in other worlds...
// But it all has the potential to get out of sync anyway.
World world = Bukkit.getWorlds().get(0);
 
MapView playerMap = null;
if (playerPortraitIds.containsKey(playerName)) {
playerMap = Bukkit.getMap(playerPortraitIds.get(playerName));
}
 
if (playerMap == null) {
// Remove old entry ... since apparently this map is broken?
if (playerPortraitIds.containsKey(playerName)) {
Short id = playerPortraitIds.get(playerName);
plugin.getLogger().info("Unregistering map id " + id + " from " + playerName + ", map failed to load");
portraitIdPlayers.remove(id);
playerPortraitIds.remove(playerName);
}
playerMap = Bukkit.createMap(world);
if (playerMap != null) {
plugin.getLogger().info("Created new map id " + playerMap.getId() + " for " + playerName);
playerPortraitIds.put(playerName, playerMap.getId());
portraitIdPlayers.put(playerMap.getId(), playerName);
}
}
 
if (playerMap == null) return null;
 
for (MapRenderer renderer : playerMap.getRenderers()) {
playerMap.removeRenderer(renderer);
}
MapRenderer renderer = new SkinRenderer(playerName);
playerMap.addRenderer(renderer);
 
return playerMap;
}

I could've made the code a little more encapsulated (as in handling its own map id persistence), but for my plugin I wanted to integrate it into a general player data persistence system, so that's why I left it separate.

The 1.6 crash I got I think was unrelated- I believe I got my world data in such a state that there was a map entity in a frame that had an id which had not yet been generated by the world I was in. 1.7 did seem to handle it more gracefully, though.

 

Ok, one more bump for this, then I'm done. In case anyone ever comes looking (though I have to say, this thread seems invisible- I couldn't find it except in my "watched" list).

Anyway, if you want to add functionality to your plugin to display images (or player portraits) on maps, this class may be for you:

https://raw.github.com/elBukkit/Mag...om/elmakers/mine/bukkit/utilities/URLMap.java

I made it completely self-contained. Use it like so:

Code:java

// In your plugin's onEnable
public void onEnable {
    // This needs to be delayed a little bit, for some reason.
    Bukkit.getScheduler().scheduleSyncDelayedTask(plugin, new Runnable() {
            public void run() {
                                // This resets all renderers to their default state
                URLMap.resetAll();
                                // This loads the configuration file and initializes saved renderers
                URLMap.load(plugin);
            }
        }, 20);
...
}
 
// Anywhere else in your code:
 
// To Create a map with a URL
ItemStack mapitem = URLMap.getURLItem(url, x, y, width, height, "Cropped Photo");
// Or just
ItemStack fullSize = URLMap.getURLItem(url, "Photo");
// Helper function for player portraits
ItemStack playerPortrait = URLMap.getPlayerPortrait(playerName);

Maps id's are stored in a yml file in your plugin's folder, this file is written to as new maps are created.

Images are loaded asynchronously, and I've taken great care to make sure I don't lag the server (let me know if you experience otherwise).

Hope this helps somebody!