Package com.minecolonies.core.colony.buildings.moduleviews

Class ItemListModuleView

java.lang.Object

com.minecolonies.api.colony.buildings.modules.AbstractBuildingModuleView

com.minecolonies.core.colony.buildings.moduleviews.ItemListModuleView

All Implemented Interfaces:

IBuildingModuleView, IItemListModuleView

Direct Known Subclasses:

FloristFlowerListModuleView

public class ItemListModuleView
extends AbstractBuildingModuleView
implements IItemListModuleView

Client side version of the abstract class for all buildings which require a filterable list of allowed items.

Field Summary

Fields inherited from class com.minecolonies.api.colony.buildings.modules.AbstractBuildingModuleView

buildingView, colonyView

Constructor Summary

Constructors

Constructor	Description
ItemListModuleView(String id, net.minecraft.network.chat.Component desc, boolean inverted, Function<IBuildingView,Set<ItemStorage>> allItems)	Create a nw grouped item list view for the client side.

Method Summary

Modifier and Type	Method	Description
void	addItem(ItemStorage item)	Add item to the view and notify the server side.
void	clearItems()	Clear the list of items
void	deserialize(@NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)	Deserialize the data on the client side.
Function<IBuildingView,Set<ItemStorage>>	getAllItems()	Get the supplier of the list of all items to display.
net.minecraft.network.chat.Component	getDesc()	Get the lang string for the title.
net.minecraft.resources.ResourceLocation	getIconResourceLocation()	Get the resource location of the icon for the module view.
String	getId()	Get the unique id of this group (used to sync with server side).
int	getSize()	Get the size of allowed items.
com.ldtteam.blockui.views.BOWindow	getWindow()	Get the matching window for the module.
boolean	isAllowedItem(ItemStorage item)	Check if an item is in the list of allowed items.
boolean	isInverted()	Check if the list is enabling or disabling.
void	removeItem(ItemStorage item)	Remove an item from the view and notify the server side.

Methods inherited from class com.minecolonies.api.colony.buildings.modules.AbstractBuildingModuleView

canBeHiredAs, getBuildingView, getColony, getProducer, setBuildingView, setColonyView, setProducer

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.IBuildingModuleView

getBuildingView, getColony, getIcon, getProducer, isPageVisible, setBuildingView, setColonyView, setProducer

Constructor Details

ItemListModuleView

public ItemListModuleView(String id,
 net.minecraft.network.chat.Component desc,
 boolean inverted,
 Function<IBuildingView,Set<ItemStorage>> allItems)

Create a nw grouped item list view for the client side.

Parameters:

id - the id.

desc - desc lang string.

inverted - enabling or disabling.

allItems - a supplier for all the items.

Method Details

addItem

public void addItem(ItemStorage item)

Description copied from interface: IItemListModuleView

Add item to the view and notify the server side.

Specified by:

addItem in interface IItemListModuleView

Parameters:

item - the item to add.

isAllowedItem

public boolean isAllowedItem(ItemStorage item)

Description copied from interface: IItemListModuleView

Check if an item is in the list of allowed items.

Specified by:

isAllowedItem in interface IItemListModuleView

Parameters:

item - the item to check.

Returns:

true if so.

getSize

public int getSize()

Description copied from interface: IItemListModuleView

Get the size of allowed items.

Specified by:

getSize in interface IItemListModuleView

Returns:

the size.

removeItem

public void removeItem(ItemStorage item)

Description copied from interface: IItemListModuleView

Remove an item from the view and notify the server side.

Specified by:

removeItem in interface IItemListModuleView

Parameters:

item - the item to remove.

getId

public String getId()

Description copied from interface: IItemListModuleView

Get the unique id of this group (used to sync with server side).

Specified by:

getId in interface IItemListModuleView

Returns:

the id.

getAllItems

public Function<IBuildingView,Set<ItemStorage>> getAllItems()

Description copied from interface: IItemListModuleView

Get the supplier of the list of all items to display.

Specified by:

getAllItems in interface IItemListModuleView

Returns:

the list.

isInverted

public boolean isInverted()

Description copied from interface: IItemListModuleView

Check if the list is enabling or disabling.

Specified by:

isInverted in interface IItemListModuleView

Returns:

true if enabling.

clearItems

public void clearItems()

Description copied from interface: IItemListModuleView

Clear the list of items

Specified by:

clearItems in interface IItemListModuleView

getDesc

public net.minecraft.network.chat.Component getDesc()

Description copied from interface: IBuildingModuleView

Get the lang string for the title.

Specified by:

getDesc in interface IBuildingModuleView

Returns:

the lang string.

deserialize

public void deserialize(@NotNull
 @NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)

Description copied from interface: IBuildingModuleView

Deserialize the data on the client side.

Specified by:

deserialize in interface IBuildingModuleView

Parameters:

buf - the buffer to read it from.

getWindow

public com.ldtteam.blockui.views.BOWindow getWindow()

Description copied from interface: IBuildingModuleView

Get the matching window for the module.

Specified by:

getWindow in interface IBuildingModuleView

Returns:

the window.

getIconResourceLocation

public net.minecraft.resources.ResourceLocation getIconResourceLocation()

Description copied from interface: IBuildingModuleView

Get the resource location of the icon for the module view.

Specified by:

getIconResourceLocation in interface IBuildingModuleView

Returns:

the resource location.