Class PlayerMemories

java.lang.Object

com.hypixel.hytale.builtin.adventure.memories.component.PlayerMemories

All Implemented Interfaces:

Component<EntityStore>, Cloneable

public class PlayerMemories
extends Object
implements Component<EntityStore>

A component that represents the memories that a player entity has collected.

Field Summary

Fields

Modifier and Type	Field	Description
static final BuilderCodec<PlayerMemories>	CODEC	The codec used to parse PlayerMemories instances.

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
PlayerMemories()

Method Summary

Modifier and Type	Method	Description
Component<EntityStore>	clone()
static ComponentType<EntityStore, PlayerMemories>	getComponentType()
int	getMemoriesCapacity()
Set<Memory>	getRecordedMemories()
boolean	hasMemories()
boolean	recordMemory(Memory memory)	Records a memory in the players memories.
void	setMemoriesCapacity(int memoriesCapacity)
boolean	takeMemories(Set<Memory> outMemories)	Removes all the memories from this player's memories and adds it to the provided set.

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Field Details

CODEC

@Nonnull
public static final BuilderCodec<PlayerMemories> CODEC

The codec used to parse PlayerMemories instances.

Constructor Details

PlayerMemories

public PlayerMemories()

Method Details

getComponentType

public static ComponentType<EntityStore, PlayerMemories> getComponentType()

clone

@Nonnull
public Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.

getMemoriesCapacity

public int getMemoriesCapacity()

setMemoriesCapacity

public void setMemoriesCapacity(int memoriesCapacity)

recordMemory

public boolean recordMemory(Memory memory)

Records a memory in the players memories.

Parameters:

memory - The memory to record.

Returns:

true if the memory is new

hasMemories

public boolean hasMemories()

takeMemories

public boolean takeMemories(@Nonnull
 Set<Memory> outMemories)

Removes all the memories from this player's memories and adds it to the provided set.

Parameters:

outMemories - The set to add the memories to.

getRecordedMemories

@Nonnull
public Set<Memory> getRecordedMemories()