com.bergerkiller.bukkit.common.internal.blocks

Class BlockRenderProvider

java.lang.Object

com.bergerkiller.bukkit.common.internal.blocks.BlockRenderProvider

Direct Known Subclasses:

FluidRenderingProvider, GrassRenderingProvider, RedstoneWireRenderingProvider

public abstract class BlockRenderProvider
extends Object

Lookup table for systems that handle additional block rendering options. When rendering actual real-world blocks, this method should be used to get that information. Some blocks are handled on the server-side, but blocks like Water lack this required information.

Constructor Summary

Constructors

Constructor and Description
BlockRenderProvider()

Method Summary

Modifier and Type	Method and Description
void	addOptions(BlockRenderOptions options, org.bukkit.World world, int x, int y, int z) Adds options specific to the provider.
Model	createModel(MapResourcePack resources, BlockRenderOptions options) Creates the displayed Block Model for certain block render options
static BlockRenderProvider	get(BlockData blockData) Gets the render provider for a certain Block Material Type Data
abstract Collection<org.bukkit.Material>	getTypes() Gets all Material types handled by this provider
protected void	linkResource(MapResourcePack.ResourceType type, String path, String resource) Adds a link to a resource stored in BKCommonLib itself
InputStream	openResource(MapResourcePack.ResourceType type, String path) Retrieves the resource (model json, png texture, etc.) at a particular path.
static void	register(BlockRenderProvider provider) Registers a new render provider

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockRenderProvider

public BlockRenderProvider()

Method Detail

register

public static void register(BlockRenderProvider provider)

Registers a new render provider

Parameters:

provider - to register

get

public static BlockRenderProvider get(BlockData blockData)

Gets the render provider for a certain Block Material Type Data

Parameters:

blockData - to get the provider for

Returns:

render provider

linkResource

protected void linkResource(MapResourcePack.ResourceType type,
                            String path,
                            String resource)

Adds a link to a resource stored in BKCommonLib itself

Parameters:

type - of resource

path - to the resource

resource - path within BKCommonLib

openResource

public InputStream openResource(MapResourcePack.ResourceType type,
                                String path)
                         throws IOException

Retrieves the resource (model json, png texture, etc.) at a particular path. This is called as a fallback when the resource is not found in the resource pack, while loading a model provided by this render provider.

Parameters:

type - of resource

path - to get the resource at

Returns:

resource, null or exception if not found

Throws:

IOException

createModel

public Model createModel(MapResourcePack resources,
                         BlockRenderOptions options)

Creates the displayed Block Model for certain block render options

Parameters:

resources - from which model dependencies (textures, other models) can be loaded

options - for rendering the block model

Returns:

block model, null if not available

addOptions

public void addOptions(BlockRenderOptions options,
                       org.bukkit.World world,
                       int x,
                       int y,
                       int z)

Adds options specific to the provider. world can be null when default render options are requested

Parameters:

options - to add to

world - the block is at

x - - coordinate of the Block

y - - coordinate of the Block

z - - coordinate of the Block

getTypes

public abstract Collection<org.bukkit.Material> getTypes()

Gets all Material types handled by this provider

Returns:

material types