Package com.minecolonies.api.research.requirements

Class ResearchResearchRequirement

java.lang.Object

com.minecolonies.api.research.requirements.ResearchResearchRequirement

All Implemented Interfaces:

IResearchRequirement

public class ResearchResearchRequirement
extends Object
implements IResearchRequirement

Certain building research requirements.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESEARCH_REQUIRED_RESEARCH_PROP	The property name for a non-parent research requirement.

Constructor Summary

Constructors

Constructor	Description
ResearchResearchRequirement(com.google.gson.JsonObject json)	Create research based research requirement.
ResearchResearchRequirement(net.minecraft.nbt.CompoundTag nbt)	Create research based research requirement.

Method Summary

Modifier and Type	Method	Description
net.minecraft.network.chat.MutableComponent	getDesc()	Get a human-readable description of the requirement, or a translation key.
ModResearchRequirements.ResearchRequirementEntry	getRegistryEntry()	Get the ModResearchRequirements.ResearchRequirementEntry for this Research Requirement.
net.minecraft.resources.ResourceLocation	getResearchId()
boolean	isFulfilled(IColony colony)	Check if this requirement is fulfilled for a certain colony.
net.minecraft.nbt.CompoundTag	writeToNBT()	Write the ResearchRequirement's traits to NBT, to simplify serialization for client-viewable data.

Methods inherited from class java.lang.Object

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

Field Details

RESEARCH_REQUIRED_RESEARCH_PROP

public static final String RESEARCH_REQUIRED_RESEARCH_PROP

The property name for a non-parent research requirement.

See Also:

• Constant Field Values

Constructor Details

ResearchResearchRequirement

public ResearchResearchRequirement(net.minecraft.nbt.CompoundTag nbt)

Create research based research requirement.

Parameters:

nbt - the nbt containing the relevant data.

ResearchResearchRequirement

public ResearchResearchRequirement(com.google.gson.JsonObject json)

Create research based research requirement.

Parameters:

json - the json containing the relevant data.

Method Details

getResearchId

public net.minecraft.resources.ResourceLocation getResearchId()

Returns:

the research identifier

getRegistryEntry

public ModResearchRequirements.ResearchRequirementEntry getRegistryEntry()

Description copied from interface: IResearchRequirement

Get the ModResearchRequirements.ResearchRequirementEntry for this Research Requirement.

Specified by:

getRegistryEntry in interface IResearchRequirement

Returns:

a registry entry.

getDesc

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

Description copied from interface: IResearchRequirement

Get a human-readable description of the requirement, or a translation key.

Specified by:

getDesc in interface IResearchRequirement

Returns:

translation text component.

isFulfilled

public boolean isFulfilled(IColony colony)

Description copied from interface: IResearchRequirement

Check if this requirement is fulfilled for a certain colony.

Specified by:

isFulfilled in interface IResearchRequirement

Parameters:

colony - the colony to check.

Returns:

true if so.

writeToNBT

public net.minecraft.nbt.CompoundTag writeToNBT()

Description copied from interface: IResearchRequirement

Write the ResearchRequirement's traits to NBT, to simplify serialization for client-viewable data.

Specified by:

writeToNBT in interface IResearchRequirement

Returns:

an NBT file which must, at minimum, contain the necessary traits to reassemble the effect.