Package net.minecraftforge.common.loot

Record Class CanToolPerformAction

java.lang.Object

java.lang.Record

net.minecraftforge.common.loot.CanToolPerformAction

All Implemented Interfaces:

Predicate<LootContext>, LootContextUser, LootItemCondition

public record CanToolPerformAction(ToolAction action)
extends Record
implements LootItemCondition

This LootItemCondition "forge:can_tool_perform_action" can be used to check if a tool can perform a given ToolAction.

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.world.level.storage.loot.predicates.LootItemCondition

LootItemCondition.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final ToolAction	action	The field for the action record component.
static final com.mojang.serialization.MapCodec<CanToolPerformAction>	CODEC
static final LootItemConditionType	TYPE

Constructor Summary

Constructors

Constructor	Description
CanToolPerformAction(ToolAction action)	Creates an instance of a CanToolPerformAction record class.

Method Summary

Modifier and Type	Method	Description
ToolAction	action()	Returns the value of the action record component.
static LootItemCondition.Builder	canToolPerformAction(ToolAction action)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull Set<LootContextParam<?>>	getReferencedContextParams()
@NotNull LootItemConditionType	getType()
final int	hashCode()	Returns a hash code value for this object.
boolean	test(LootContext ctx)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraft.world.level.storage.loot.LootContextUser

validate

Methods inherited from interface java.util.function.Predicate

and, negate, or

Field Details

action

private final ToolAction action

The field for the action record component.

CODEC

public static final com.mojang.serialization.MapCodec<CanToolPerformAction> CODEC

TYPE

public static final LootItemConditionType TYPE

Constructor Details

CanToolPerformAction

public CanToolPerformAction(ToolAction action)

Creates an instance of a CanToolPerformAction record class.

Parameters:

action - the value for the action record component

Method Details

getType

@NotNull
public @NotNull LootItemConditionType getType()

Specified by:

getType in interface LootItemCondition

getReferencedContextParams

@NotNull
public @NotNull Set<LootContextParam<?>> getReferencedContextParams()

Specified by:

getReferencedContextParams in interface LootContextUser

test

public boolean test(LootContext ctx)

Specified by:

test in interface Predicate<LootContext>

canToolPerformAction

public static LootItemCondition.Builder canToolPerformAction(ToolAction action)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

action

public ToolAction action()

Returns the value of the action record component.

Returns:

the value of the action record component