me.desht.pneumaticcraft.api.misc

Interface IPlayerMatcher

All Superinterfaces:

java.util.function.Predicate<net.minecraft.entity.player.PlayerEntity>

All Known Implementing Classes:

BiomeMatcher, DimensionMatcher, GamestagesMatcher

public interface IPlayerMatcher
extends java.util.function.Predicate<net.minecraft.entity.player.PlayerEntity>

A player matcher predicate with potential multiple uses - currently used by the Amadron tablet to check if a particular offer is usable by a player.

This matcher should be able to run on both client and server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IPlayerMatcher.MatcherFactory<T extends IPlayerMatcher> Implement this and register it via PneumaticRegistry.IPneumaticCraftInterface.registerPlayerMatcher(ResourceLocation, me.desht.pneumaticcraft.api.misc.IPlayerMatcher.MatcherFactory).

Method Summary

Modifier and Type	Method and Description
void	addDescription(net.minecraft.entity.player.PlayerEntity player, java.util.List<net.minecraft.util.text.ITextComponent> tooltip) Add this matcher's information to a tooltip.
default void	standardTooltip(net.minecraft.entity.player.PlayerEntity player, java.util.List<net.minecraft.util.text.ITextComponent> tooltip, net.minecraft.util.text.ITextComponent header, java.util.List<net.minecraft.util.text.ITextComponent> itemList) Utility method to add a standardised tooltip for a matcher.
void	toBytes(net.minecraft.network.PacketBuffer buffer) Serialize this matcher object to a packet buffer, for sync'ing to clients
com.google.gson.JsonElement	toJson() Serialize this matcher object to JSON, for data generation.

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or, test

Method Detail

toBytes

void toBytes(net.minecraft.network.PacketBuffer buffer)

Serialize this matcher object to a packet buffer, for sync'ing to clients

Parameters:

buffer - a packet buffer

toJson

com.google.gson.JsonElement toJson()

Serialize this matcher object to JSON, for data generation.

Returns:

a JSON element

addDescription

void addDescription(net.minecraft.entity.player.PlayerEntity player,
                    java.util.List<net.minecraft.util.text.ITextComponent> tooltip)

Add this matcher's information to a tooltip. This is used for example by the Amadron Tablet GUI to show information about this matcher.

Parameters:

player - the relevant player

tooltip - a tooltip list

standardTooltip

default void standardTooltip(net.minecraft.entity.player.PlayerEntity player,
                             java.util.List<net.minecraft.util.text.ITextComponent> tooltip,
                             net.minecraft.util.text.ITextComponent header,
                             java.util.List<net.minecraft.util.text.ITextComponent> itemList)

Utility method to add a standardised tooltip for a matcher. Don't override this - it is strongly recommended to call it from addDescription(PlayerEntity, List) for a consistent tooltip for all matchers.

Parameters:

player - the player, as received by addDescription(PlayerEntity, List)

tooltip - tooltip to add to, as received by addDescription(PlayerEntity, List)

header - the header text line

itemList - a list of items that this matcher matches against