Class PlayerRefAddedSystem

java.lang.Object

com.hypixel.hytale.component.system.System<EntityStore>

com.hypixel.hytale.component.system.RefSystem<EntityStore>

com.hypixel.hytale.server.core.universe.system.PlayerRefAddedSystem

All Implemented Interfaces:

ISystem<EntityStore>, QuerySystem<EntityStore>

public class PlayerRefAddedSystem
extends RefSystem<EntityStore>

A ref system that handles adding/removing a player ref to/from a world upon player leave/join.

Field Summary

Fields inherited from interface ISystem

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
PlayerRefAddedSystem(ComponentType<EntityStore, PlayerRef> playerRefComponentType)	Default Constructor for a PlayerRefAddedSystem instance.

Method Summary

Modifier and Type	Method	Description
Set<Dependency<EntityStore>>	getDependencies()
Query<EntityStore>	getQuery()
void	onEntityAdded(Ref<EntityStore> ref, AddReason reason, Store<EntityStore> store, CommandBuffer<EntityStore> commandBuffer)	Called after an entity has been added to a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.
void	onEntityRemove(Ref<EntityStore> ref, RemoveReason reason, Store<EntityStore> store, CommandBuffer<EntityStore> commandBuffer)	Called before an entity has been removed from a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.

Methods inherited from class System

getComponentRegistrations, getResourceRegistrations, registerResource, registerResource

Methods inherited from class Object

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

Methods inherited from interface ISystem

getGroup, onSystemRegistered, onSystemUnregistered

Methods inherited from interface QuerySystem

getHierarchyScope, test

Constructor Details

PlayerRefAddedSystem

public PlayerRefAddedSystem(@Nonnull
 ComponentType<EntityStore, PlayerRef> playerRefComponentType)

Default Constructor for a PlayerRefAddedSystem instance.

Parameters:

playerRefComponentType - The PlayerRef component type.

Method Details

getDependencies

@Nonnull
public Set<Dependency<EntityStore>> getDependencies()

getQuery

public Query<EntityStore> getQuery()

onEntityAdded

public void onEntityAdded(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 AddReason reason,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 CommandBuffer<EntityStore> commandBuffer)

Description copied from class: RefSystem

Called after an entity has been added to a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.

Specified by:

onEntityAdded in class RefSystem<EntityStore>

Parameters:

ref - The entity reference of the added entity.

reason - The reason for the entity being added.

store - The store the entity was added to.

commandBuffer - The command buffer to execute tasks. Note: The command buffer tasks are executed after all systems have processed the entity add.

onEntityRemove

public void onEntityRemove(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 RemoveReason reason,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 CommandBuffer<EntityStore> commandBuffer)

Description copied from class: RefSystem

Called before an entity has been removed from a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.

Specified by:

onEntityRemove in class RefSystem<EntityStore>

Parameters:

ref - The entity reference of the removed entity.

reason - The reason for the entity being removed.

store - The store the entity is being removed from.

commandBuffer - The command buffer to execute tasks. Note: The command buffer tasks are executed after all systems have processed the entity remove.