io.github.bananapuncher714.cartographer.core.map.palette

Class PaletteManager

java.lang.Object

io.github.bananapuncher714.cartographer.core.map.palette.PaletteManager

public class PaletteManager
extends java.lang.Object

Manage the MinimapPalette for Minimap.

Author:

BananaPuncher714

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaletteManager.ColorType Contains different ways to write a color.

Field Summary

Fields

Modifier and Type	Field and Description
protected CartographerLogger	logger
protected java.util.Map<java.lang.String,MinimapPalette>	palettes
protected Cartographer	plugin

Constructor Summary

Constructors

Constructor and Description
PaletteManager(Cartographer plugin) Only one PaletteManager is recommended.

Method Summary

Modifier and Type	Method and Description
MinimapPalette	construct(java.util.List<java.lang.String> palettes) Construct a new MinimapPalette from a list of palette ids.
CartographerLogger	getLogger()
MinimapPalette	load(org.bukkit.configuration.file.FileConfiguration config) Create a MinimapPalette from the config provided.
void	register(java.lang.String name, MinimapPalette palette) Register a new MinimapPalette.
void	save(MinimapPalette palette, org.bukkit.configuration.file.FileConfiguration config, PaletteManager.ColorType format) Save the given MinimapPalette to file with the PaletteManager.ColorType indicated.
java.lang.String	toString(java.awt.Color color, PaletteManager.ColorType type) Convert a color to a string.
java.lang.String	toString(int color, PaletteManager.ColorType type) Convert an integer color to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

plugin

protected Cartographer plugin

palettes

protected java.util.Map<java.lang.String,MinimapPalette> palettes

logger

protected CartographerLogger logger

Constructor Detail

PaletteManager

public PaletteManager(Cartographer plugin)

Only one PaletteManager is recommended. To get the current one in use, call Cartographer.getPaletteManager().

Parameters:

plugin - Requires a Cartographer plugin.

Method Detail

register

public void register(java.lang.String name,
                     MinimapPalette palette)

Register a new MinimapPalette. Will overwrite any existing one with the same id.

Parameters:

name - Cannot be null.

palette - Cannot be null.

construct

public MinimapPalette construct(java.util.List<java.lang.String> palettes)

Construct a new MinimapPalette from a list of palette ids.

Parameters:

palettes - A non null list of ids.

Returns:

A compound MinimapPalette.

load

public MinimapPalette load(org.bukkit.configuration.file.FileConfiguration config)

Create a MinimapPalette from the config provided.

Parameters:

config - Cannot be null, and has to follow a MinimapPalette format.

Returns:

A MinimapPalette.

save

public void save(MinimapPalette palette,
                 org.bukkit.configuration.file.FileConfiguration config,
                 PaletteManager.ColorType format)

Save the given MinimapPalette to file with the PaletteManager.ColorType indicated.

Parameters:

palette - The MinimapPalette to save. Cannot be null.

config - The config to save to. Cannot be null.

format - The ColorType to use. Cannot be null.

toString

public java.lang.String toString(int color,
                                 PaletteManager.ColorType type)

Convert an integer color to a string.

Parameters:

color - The integer color.

type - The format to use. Cannot be null.

Returns:

A string that follows the PaletteManager.ColorType pattern.

toString

public java.lang.String toString(java.awt.Color color,
                                 PaletteManager.ColorType type)

Convert a color to a string.

Parameters:

color - Cannot be null.

type - The format to use. Cannot be null.

Returns:

A string that follows the PaletteManager.ColorType pattern.

getLogger

public CartographerLogger getLogger()