Package com.portingdeadmods.researchd.impl.research.effect

Record Class CommandResearchEffect

java.lang.Object

java.lang.Record

com.portingdeadmods.researchd.impl.research.effect.CommandResearchEffect

All Implemented Interfaces:

ResearchEffect

public record CommandResearchEffect(String onUnlockCommand, String onLockCommand)
extends Record
implements ResearchEffect

Executes commands when a research is unlocked/locked.

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.resources.ResourceLocation	ID
static final Pattern	PLACEHOLDER_PATTERN
static final String	PLAYER_NAME_PLACEHOLDER
static final String	RESEARCH_ID_PLACEHOLDER
static final ResearchEffectSerializer<CommandResearchEffect>	SERIALIZER
static final String	TEAM_NAME_PLACEHOLDER

Constructor Summary

Constructors

Constructor	Description
CommandResearchEffect(String onUnlockCommand, String onLockCommand)	Creates an instance of a CommandResearchEffect record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ResearchEffectSerializer<CommandResearchEffect>	getSerializer()
final int	hashCode()	Returns a hash code value for this object.
net.minecraft.resources.ResourceLocation	id()
void	onLock(net.minecraft.world.level.Level level, ResearchTeam team, net.minecraft.resources.ResourceKey<Research> research)	Inverse of ResearchEffect.onUnlock(net.minecraft.world.level.Level, com.portingdeadmods.researchd.api.team.ResearchTeam, net.minecraft.resources.ResourceKey<com.portingdeadmods.researchd.api.research.Research>).
String	onLockCommand()	Returns the value of the onLockCommand record component.
void	onUnlock(net.minecraft.world.level.Level level, ResearchTeam team, net.minecraft.resources.ResourceKey<Research> research)
String	onUnlockCommand()	Returns the value of the onUnlockCommand record component.
final String	toString()	Returns a string representation of this record class.
ResearchEffectType	type()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.portingdeadmods.researchd.api.research.effects.ResearchEffect

getTranslation

Field Details

ID

public static final net.minecraft.resources.ResourceLocation ID

PLAYER_NAME_PLACEHOLDER

public static final String PLAYER_NAME_PLACEHOLDER

See Also:

• Constant Field Values

TEAM_NAME_PLACEHOLDER

public static final String TEAM_NAME_PLACEHOLDER

See Also:

• Constant Field Values

RESEARCH_ID_PLACEHOLDER

public static final String RESEARCH_ID_PLACEHOLDER

See Also:

• Constant Field Values

PLACEHOLDER_PATTERN

public static final Pattern PLACEHOLDER_PATTERN

SERIALIZER

public static final ResearchEffectSerializer<CommandResearchEffect> SERIALIZER

Constructor Details

CommandResearchEffect

public CommandResearchEffect(String onUnlockCommand,
 String onLockCommand)

Creates an instance of a CommandResearchEffect record class.

Parameters:

onUnlockCommand - the value for the onUnlockCommand record component

onLockCommand - the value for the onLockCommand record component

Method Details

onUnlock

public void onUnlock(net.minecraft.world.level.Level level,
 ResearchTeam team,
 net.minecraft.resources.ResourceKey<Research> research)

Specified by:

onUnlock in interface ResearchEffect

onLock

public void onLock(net.minecraft.world.level.Level level,
 ResearchTeam team,
 net.minecraft.resources.ResourceKey<Research> research)

Description copied from interface: ResearchEffect

Inverse of ResearchEffect.onUnlock(net.minecraft.world.level.Level, com.portingdeadmods.researchd.api.team.ResearchTeam, net.minecraft.resources.ResourceKey<com.portingdeadmods.researchd.api.research.Research>). Called when a previously-completed research is removed, and once per non-completed research at team-creation / datapack-reload time so the default "everything blocked" state is built up incrementally rather than from a separate initDefault pass.

Specified by:

onLock in interface ResearchEffect

id

public net.minecraft.resources.ResourceLocation id()

Specified by:

id in interface ResearchEffect

type

public ResearchEffectType type()

Specified by:

type in interface ResearchEffect

getSerializer

public ResearchEffectSerializer<CommandResearchEffect> getSerializer()

Specified by:

getSerializer in interface ResearchEffect

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.

onUnlockCommand

public String onUnlockCommand()

Returns the value of the onUnlockCommand record component.

Returns:

the value of the onUnlockCommand record component

onLockCommand

public String onLockCommand()

Returns the value of the onLockCommand record component.

Returns:

the value of the onLockCommand record component