Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

<div lang="en" dir="ltr" class="mw-content-ltr">
== Introduction ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Map Displays are programmed different from what you might be used to with Bukkit. They are completely callback driven, which means you don't start and stop the display yourself. Instead, you override methods in the Map Display class to load and display the contents you want. If you want to show unique information per display, this information must be stored in the Map Item itself.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Execution Flow ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
# BKCommonLib identifies an ItemStack in an ItemFrame or player inventory which declares a Map Display
# BKCommonLib optionally discovers neighbouring item frames to increase the resolution of the display
# BKCommonLib sees in item metadata what Map Display class should be loaded, constructs it, and starts the main update loop
# Main update loop calls MapDisplay ''onAttached()'', then regularly calls ''onTick()'' and performs other background updates
# If a player is clicking on item frames with the map, or is holding the map and controlling it, event callbacks are fired
# Once no player is nearby anymore to view it, hold it or all chunks unload containing the map (Session Mode), ''onDetached()'' is called and the display update loop is shut down
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
All of the above means you should only concern yourself with a few things:
* Creating the initial ItemStack where you set the Map Display class and initial settings to use
* Implementing the Map Display class so that it responds to input and draws the right information, optionally using '''Widgets'''
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Things you '''must not attempt to do''' because BKCommonLib's API does this for you automatically:
* Setting Map IDs, item frame tiling. IDs are automatically calculated and updated so they don't clash with other plugins.
* Starting the display after giving the ItemStack to a player or putting it in ItemFrames. This is done automatically within a tick.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
There are javadocs [https://ci.mg-dev.eu/javadocs/BKCommonLib here], or you can browse the Map Display related code yourself [https://github.com/bergerhealer/BKCommonLib/tree/master/src/main/java/com/bergerkiller/bukkit/common/map here].
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Basic Structure ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You start by adding a new class to your plugin that '''extends MapDisplay''' overriding a few methods:
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
<pre>
package com.my.plugin;
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
import com.bergerkiller.bukkit.common.map.MapDisplay;
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
public class MyCustomDisplay extends MapDisplay {
    @Override
    public void onAttached() {
        // Setup your display and draw the initial contents
    }
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
@Override
    public void onDetached() {
        // Stop any tasks, unregister stuff or save important information to disk
    }
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
@Override
    public void onTick() {
        // Perform per-tick updates here
    }
}
</pre>
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Then to create an ItemStack that when given loads this display, use the following code:
<pre>
ItemStack item = MapDisplay.createMapItem(MyCustomDisplay.class);
ItemUtil.setDisplayName(item, "My Custom Display"); // Optional
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
player.getInventory().addItem(item);
seplayerder.sendMessage(ChatColor.GREEN + "Given My Custom Display map!");
</pre>
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To include additional metadata for use in the display (''properties'' field) you can also use the ''MapDisplayProperties'' class to build the item:
<pre>
MapDisplayProperties prop = MapDisplayProperties.createNew(MyCustomDisplay.class);
prop.set("creator", player.getName());
prop.set("background", "https://url/to/some/image.png");
ItemStack item = prop.getMapItem();
// Rest is the same
</pre>
</div>

Export translations

Navigation menu

Search