Index (BMUtils 5.1.0 API)

B C E F G J L S W
All Classes and Interfaces|All Packages

B

BMCopy - Class in com.technicjelle.BMUtils: Utility functions for copying stuff to BlueMap
BMNConfigDirectory - Class in com.technicjelle.BMUtils.BMNative: BMUtils allocates a config directory for every native BlueMap addon.
Here are functions to retrieve that directory.

The directory name is the addon's ID.
BMNConfigDirectory.BMNCopy - Class in com.technicjelle.BMUtils.BMNative: Utility functions for copying stuff to the config directory that BMUtils allocated.
BMNLogger - Class in com.technicjelle.BMUtils.BMNative: A logger for BlueMap Native Addons
BMNLogger(ClassLoader) - Constructor for class com.technicjelle.BMUtils.BMNative.BMNLogger: Creates a new logger for a BlueMap Native Addon
BMNLogger(String) - Constructor for class com.technicjelle.BMUtils.BMNative.BMNLogger: Creates a new logger for a BlueMap Addon
BMNMetadata - Class in com.technicjelle.BMUtils.BMNative: Utility functions for interfacing with the metadata of native BlueMap addons
BMSkin - Class in com.technicjelle.BMUtils: Utility functions for BlueMap skins and playerheads

C

Cheese - Class in com.technicjelle.BMUtils: A Shape with possibly some holes.
Cheese(Shape) - Constructor for class com.technicjelle.BMUtils.Cheese: Creates a new Cheese with no holes.
Cheese(Shape, Shape...) - Constructor for class com.technicjelle.BMUtils.Cheese: Creates a new Cheese with holes.
Cheese(Shape, Collection) - Constructor for class com.technicjelle.BMUtils.Cheese: Creates a new Cheese with holes.
com.technicjelle.BMUtils - package com.technicjelle.BMUtils: Utilities for BlueMap Addons.
com.technicjelle.BMUtils.BMNative - package com.technicjelle.BMUtils.BMNative: Utilities for Native BlueMap Addons.
createPlatterFromCells(Vector2d, Vector2i...) - Static method in class com.technicjelle.BMUtils.Cheese: Creates BlueMap Shapes with potentially some holes, from a collection of custom-sized cells.
Designed to be looped over and fed into a BlueMap ShapeMarker or ExtrudeMarker
createPlatterFromChunks(Vector2i...) - Static method in class com.technicjelle.BMUtils.Cheese: Creates BlueMap Shapes with potentially some holes, from a collection of chunks.
Designed to be looped over and fed into a BlueMap ShapeMarker or ExtrudeMarker
createSingleFromCells(Vector2d, Vector2i...) - Static method in class com.technicjelle.BMUtils.Cheese: Creates a single BlueMap Shape with potentially some holes, from a collection of custom-sized cells.
Designed to be fed directly into a BlueMap ShapeMarker or ExtrudeMarker.
createSingleFromChunks(Vector2i...) - Static method in class com.technicjelle.BMUtils.Cheese: Creates a single BlueMap Shape with potentially some holes, from a collection of chunks.
Designed to be fed directly into a BlueMap ShapeMarker or ExtrudeMarker.

E

expandShapeAccurate(Shape, double) - Static method in class com.technicjelle.BMUtils.ShapeExtensions: Expands a Shape by a given amount, in all directions.
More accurate for free-form shapes, like ellipses and circles, but less intuitive for rectangular shapes
Use ShapeExtensions.expandShapeRect(Shape, double) for more rectangular shapes.

Example: expanding a square by 1 in each direction will only offset each edge by (√2)/2
expandShapeRect(Shape, double) - Static method in class com.technicjelle.BMUtils.ShapeExtensions: Expands a Shape by a given amount, in all directions.
This function is more intuitive for rectangular shapes, but technically not exactly mathematically accurate.
Use ShapeExtensions.expandShapeAccurate(Shape, double) for more free-form shapes, like ellipses and circles.

Example: expanding a 16x16 square by 1 in each direction results in an 18x18 square

F

fileToMap(BlueMapMap, Path, String) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any file to the BlueMap asset folder of a specific map.
If the resource already exists, it will be overwritten.
Do not use this method for copying scripts or styles, as those need to be installed in the webapp.
fileToMap(BlueMapMap, Path, String, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any file to the BlueMap asset folder of a specific map.
Do not use this method for copying scripts or styles, as those need to be installed in the webapp.
fileToWebApp(BlueMapAPI, Path, String) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any file to the BlueMap asset folder.
If the resource already exists, it will be overwritten.
If the resource is a script or style, it will be registered with BlueMap.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.
fileToWebApp(BlueMapAPI, Path, String, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any file to the BlueMap asset folder.
If the resource is a script or style, it will be registered with BlueMap.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.
fileToWebApp(BlueMapAPI, Path, String, boolean, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any file to the BlueMap asset folder.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.
fromFile(BlueMapAPI, ClassLoader, Path, String, boolean) - Static method in class com.technicjelle.BMUtils.BMNative.BMNConfigDirectory.BMNCopy: Every native BlueMap addon has its own config directory, which is allocated by BlueMap.
This function copies a file to that directory.
fromJarResource(BlueMapAPI, ClassLoader, String, String, boolean) - Static method in class com.technicjelle.BMUtils.BMNative.BMNConfigDirectory.BMNCopy: Every native BlueMap addon has its own config directory, which is allocated by BlueMap.
This function copies a resource from the jar to that directory.
fromStream(BlueMapAPI, ClassLoader, InputStream, String, boolean) - Static method in class com.technicjelle.BMUtils.BMNative.BMNConfigDirectory.BMNCopy: Every native BlueMap addon has its own config directory, which is allocated by BlueMap.
This function copies a stream to that directory.

G

getAddonID(ClassLoader) - Static method in class com.technicjelle.BMUtils.BMNative.BMNMetadata: Gets the addon's ID from the addon metadata file
getAllocatedDirectory(BlueMapAPI, ClassLoader) - Static method in class com.technicjelle.BMUtils.BMNative.BMNConfigDirectory: This function gives you the path to your addon's allocated config directory.
getHoles() - Method in class com.technicjelle.BMUtils.Cheese
getKey(ClassLoader, String) - Static method in class com.technicjelle.BMUtils.BMNative.BMNMetadata: Gets any arbitrary key from the addon metadata file
getPacksDirectory(BlueMapAPI) - Static method in class com.technicjelle.BMUtils.BMNative.BMNConfigDirectory: Gets the directory where BlueMap Native Addons are stored.
Probably shouldn't be used directly, use BMNConfigDirectory.getAllocatedDirectory(BlueMapAPI, ClassLoader) instead.
getPlayerHeadIconAddress(BlueMapAPI, UUID, BlueMapMap) - Static method in class com.technicjelle.BMUtils.BMSkin: Gets the URL to a player head icon for a specific map.
If the icon doesn't exist yet, it will be created.
getServerConfigDirectory(BlueMapAPI) - Static method in class com.technicjelle.BMUtils.BMNative.BMNConfigDirectory: Gets the directory where the server stores the mod/plugin configuration directories.
getShape() - Method in class com.technicjelle.BMUtils.Cheese

J

jarResourceToMap(BlueMapMap, ClassLoader, String, String) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies a resource from the jar to the BlueMap asset folder of a specific map.
If the resource already exists, it will be overwritten.
Do not use this method for copying scripts or styles, as those need to be installed in the webapp.
jarResourceToMap(BlueMapMap, ClassLoader, String, String, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies a resource from the jar to the BlueMap asset folder of a specific map.
Do not use this method for copying scripts or styles, as those need to be installed in the webapp.
jarResourceToWebApp(BlueMapAPI, ClassLoader, String, String) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies a resource from the jar to the BlueMap asset folder.
If the resource already exists, it will be overwritten.
If the resource is a script or style, it will be registered with BlueMap.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.
jarResourceToWebApp(BlueMapAPI, ClassLoader, String, String, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies a resource from the jar to the BlueMap asset folder.
If the resource is a script or style, it will be registered with BlueMap.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.
jarResourceToWebApp(BlueMapAPI, ClassLoader, String, String, boolean, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies a resource from the jar to the BlueMap asset folder.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.

L

logDebug(String) - Method in class com.technicjelle.BMUtils.BMNative.BMNLogger: Logs a debug message
logError(String) - Method in class com.technicjelle.BMUtils.BMNative.BMNLogger: Logs an error message
logError(String, Throwable) - Method in class com.technicjelle.BMUtils.BMNative.BMNLogger: Logs an error message with an exception
logInfo(String) - Method in class com.technicjelle.BMUtils.BMNative.BMNLogger: Logs an info message
logWarning(String) - Method in class com.technicjelle.BMUtils.BMNative.BMNLogger: Logs a warning message

S

scaleShapeAround(Shape, double, Vector2d) - Static method in class com.technicjelle.BMUtils.ShapeExtensions: Scales a shape by a given factor, around a given origin
scaleShapeMiddle(Shape, double) - Static method in class com.technicjelle.BMUtils.ShapeExtensions: Scales a shape by a given factor, around the middle of the shape
scaleShapeOrigin(Shape, double) - Static method in class com.technicjelle.BMUtils.ShapeExtensions: Scales a shape by a given factor, around the origin (0, 0)
ShapeExtensions - Class in com.technicjelle.BMUtils: Utility functions for Shapes
shrinkShapeAccurate(Shape, double) - Static method in class com.technicjelle.BMUtils.ShapeExtensions: Shrinks a Shape by a given amount, in all directions.
More accurate for free-form shapes, like ellipses and circles, but less intuitive for rectangular shapes
Use ShapeExtensions.shrinkShapeRect(Shape, double) for more rectangular shapes.

Example: shrinking a square by 1 in each direction will only offset each edge by (√2)/2
shrinkShapeRect(Shape, double) - Static method in class com.technicjelle.BMUtils.ShapeExtensions: Shrinks a Shape by a given amount, in all directions.
This function is more intuitive for rectangular shapes, but technically not exactly mathematically accurate.
Use ShapeExtensions.shrinkShapeAccurate(Shape, double) for more free-form shapes, like ellipses and circles.

Example: shrinking a 16x16 square by 1 in each direction results in a 14x14 square
streamToMap(BlueMapMap, InputStream, String) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any stream to the BlueMap asset folder of a specific map.
If the resource already exists, it will be overwritten.
Do not use this method for copying scripts or styles, as those need to be installed in the webapp.
streamToMap(BlueMapMap, InputStream, String, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any stream to the BlueMap asset folder of a specific map.
Do not use this method for copying scripts or styles, as those need to be installed in the webapp.
streamToWebApp(BlueMapAPI, InputStream, String) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any stream to the BlueMap asset folder.
If the resource already exists, it will be overwritten.
If the resource is a script or style, it will be registered with BlueMap.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.
streamToWebApp(BlueMapAPI, InputStream, String, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any stream to the BlueMap asset folder.
If the resource is a script or style, it will be registered with BlueMap.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.
streamToWebApp(BlueMapAPI, InputStream, String, boolean, boolean) - Static method in class com.technicjelle.BMUtils.BMCopy: Copies any stream to the BlueMap asset folder.
This function should be called directly inside BlueMapAPI.onEnable(Consumer), not in a separate thread.

W

WARNING: - Section in com.technicjelle.BMUtils.Cheese.createSingleFromCells(Vector2d, Vector2i...)
WARNING: - Section in com.technicjelle.BMUtils.Cheese.createSingleFromChunks(Vector2i...)

B C E F G J L S W
All Classes and Interfaces|All Packages