net.malisis.core.renderer.icon.provider

Interface IIconProvider

All Superinterfaces:

IComponent

All Known Subinterfaces:

IBlockIconProvider, IBlockIconProvider.ISidesIconProvider, IBlockIconProvider.IStatesIconProvider, IGuiIconProvider, IItemIconProvider

All Known Implementing Classes:

ConnectedIconsProvider, GuiIconProvider, MegaTextureIconProvider, PropertyEnumIconProvider, SidesIconProvider

public interface IIconProvider
extends IComponent

The IIconProvider interface allows to pass Icon to the rendering processes.
The interface extends IComponent so it can be added to MalisisBlock components.

Method Summary

Modifier and Type	Method and Description
static IconProviderBuilder	create(Icon icon) Creates a IconProviderBuilder.
static IconProviderBuilder	create(java.lang.String name) Creates a IconProviderBuilder.
static IconProviderBuilder	create(java.lang.String prefix, Icon icon) Creates a IconProviderBuilder with a prefix.
static IconProviderBuilder	create(java.lang.String prefix, java.lang.String name) Creates a IconProviderBuilder with a prefix.
Icon	getIcon() Gets the Icon to use.
default boolean	isClientComponent() Checks if this component should only be used client side.

Methods inherited from interface net.malisis.core.block.IComponent

getComponent, getDependencies

Method Detail

isClientComponent

default boolean isClientComponent()

Description copied from interface: IComponent

Checks if this component should only be used client side.

Specified by:

isClientComponent in interface IComponent

Returns:

true, if is client component

getIcon

Icon getIcon()

Gets the Icon to use.

Returns:

the icon

create

static IconProviderBuilder create(Icon icon)

Creates a IconProviderBuilder.

Returns:

the icon provider builder

create

static IconProviderBuilder create(java.lang.String prefix,
                                  Icon icon)

Creates a IconProviderBuilder with a prefix.
The prefix will be prepend for all string passed to the builder.

Parameters:

prefix - the prefix

icon - the icon

Returns:

the icon provider builder

create

static IconProviderBuilder create(java.lang.String name)

Creates a IconProviderBuilder.

Parameters:

name - the name

Returns:

the icon provider builder

create

static IconProviderBuilder create(java.lang.String prefix,
                                  java.lang.String name)

Creates a IconProviderBuilder with a prefix.
The prefix will be prepend for all string passed to the builder.

Parameters:

prefix - the prefix

name - the name

Returns:

the icon provider builder