Class RoleChangeSystem

java.lang.Object

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

com.hypixel.hytale.component.system.tick.TickingSystem<EntityStore>

com.hypixel.hytale.server.npc.systems.RoleChangeSystem

All Implemented Interfaces:

ISystem<EntityStore>, TickableSystem<EntityStore>

public class RoleChangeSystem
extends TickingSystem<EntityStore>

Handles the processing of RoleChangeSystem.RoleChangeRequests once per tick so that the NPC is reinitialised with the new Role. Role changes can be requested by calling requestRoleChange(Ref, Role, int, boolean, Store).

Should be set as the last NPC system to run in a tick.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoleChangeSystem.RoleChangeQueue	A resource that handles the changing of roles for NPC entities

Field Summary

Fields inherited from interface ISystem

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor

Description

RoleChangeSystem(ResourceType<EntityStore, RoleChangeSystem.RoleChangeQueue> roleChangeQueueResourceType, ComponentType<EntityStore, BeaconSupport> beaconSupportComponentType, ComponentType<EntityStore, PlayerBlockEventSupport> playerBlockEventSupportComponentType, ComponentType<EntityStore, NPCBlockEventSupport> npcBlockEventSupportComponentType, ComponentType<EntityStore, PlayerEntityEventSupport> playerEntityEventSupportComponentType, ComponentType<EntityStore, NPCEntityEventSupport> npcEntityEventSupportComponentType, ComponentType<EntityStore, Timers> timersComponentType, ComponentType<EntityStore, StateEvaluator> stateEvaluatorComponentType, ComponentType<EntityStore, ValueStore> valueStoreComponentType)

Default Constructor for a RoleChangeSystem instance

Method Summary

Modifier and Type	Method	Description
Set<Dependency<EntityStore>>	getDependencies()
static void	requestRoleChange(Ref<EntityStore> ref, Role role, int roleIndex, boolean changeAppearance, Store<EntityStore> store)	Called to request a role change for a specific NPC entity
static void	requestRoleChange(Ref<EntityStore> ref, Role role, int roleIndex, boolean changeAppearance, String state, String subState, boolean detachFromSpawning, ComponentAccessor<EntityStore> store)	Called to request a role change for a specific NPC entity
static void	requestRoleChange(Ref<EntityStore> ref, Role role, int roleIndex, boolean changeAppearance, String state, String subState, ComponentAccessor<EntityStore> store)	Called to request a role change for a specific NPC entity
void	tick(float dt, int systemIndex, Store<EntityStore> store)	Required reading: CommandBuffer

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

Constructor Details

RoleChangeSystem

public RoleChangeSystem(@Nonnull
 ResourceType<EntityStore, RoleChangeSystem.RoleChangeQueue> roleChangeQueueResourceType,
 @Nonnull
 ComponentType<EntityStore, BeaconSupport> beaconSupportComponentType,
 @Nonnull
 ComponentType<EntityStore, PlayerBlockEventSupport> playerBlockEventSupportComponentType,
 @Nonnull
 ComponentType<EntityStore, NPCBlockEventSupport> npcBlockEventSupportComponentType,
 @Nonnull
 ComponentType<EntityStore, PlayerEntityEventSupport> playerEntityEventSupportComponentType,
 @Nonnull
 ComponentType<EntityStore, NPCEntityEventSupport> npcEntityEventSupportComponentType,
 @Nonnull
 ComponentType<EntityStore, Timers> timersComponentType,
 @Nonnull
 ComponentType<EntityStore, StateEvaluator> stateEvaluatorComponentType,
 @Nonnull
 ComponentType<EntityStore, ValueStore> valueStoreComponentType)

Default Constructor for a RoleChangeSystem instance

Parameters:

roleChangeQueueResourceType - The RoleChangeSystem.RoleChangeQueue resource type

beaconSupportComponentType - The BeaconSupport component type

playerBlockEventSupportComponentType - The PlayerBlockEventSupport component type

npcBlockEventSupportComponentType - The NPCBlockEventSupport component type

playerEntityEventSupportComponentType - The PlayerEntityEventSupport component type

npcEntityEventSupportComponentType - The NPCEntityEventSupport component type

timersComponentType - The Timers component type

stateEvaluatorComponentType - The StateEvaluator component type

valueStoreComponentType - The ValueStore component type

Method Details

getDependencies

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

tick

public void tick(float dt,
 int systemIndex,
 @Nonnull
 Store<EntityStore> store)

Description copied from class: TickingSystem

Required reading: CommandBuffer

Called once per world tick.

Specified by:

tick in interface TickableSystem<EntityStore>

Specified by:

tick in class TickingSystem<EntityStore>

Parameters:

dt - The delta time in seconds.

systemIndex - The index of this system, used for faster lookups in Store.

requestRoleChange

public static void requestRoleChange(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Role role,
 int roleIndex,
 boolean changeAppearance,
 @Nonnull
 Store<EntityStore> store)

Called to request a role change for a specific NPC entity

Parameters:

ref - The entity reference of the NPC entity to request a role change for

role - The Role instance to change the NPC to

roleIndex - The asset index of the role to change to

changeAppearance - true if the NPC entities appearance should change, false otherwise

store - The entity store for component access

requestRoleChange

public static void requestRoleChange(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Role role,
 int roleIndex,
 boolean changeAppearance,
 @Nullable
 String state,
 @Nullable
 String subState,
 @Nonnull
 ComponentAccessor<EntityStore> store)

Called to request a role change for a specific NPC entity

Parameters:

ref - The entity reference of the NPC entity to request a role change for

role - The Role instance to change the NPC to

roleIndex - The asset index of the role to change to

changeAppearance - true if the NPC entities appearance should change, false otherwise

state - The configured state, or null if undesired

subState - The configured substate, or null if undesired

store - The entity store for component access

requestRoleChange

public static void requestRoleChange(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Role role,
 int roleIndex,
 boolean changeAppearance,
 @Nullable
 String state,
 @Nullable
 String subState,
 boolean detachFromSpawning,
 @Nonnull
 ComponentAccessor<EntityStore> store)

Called to request a role change for a specific NPC entity

Parameters:

ref - The entity reference of the NPC entity to request a role change for

role - The Role instance to change the NPC to

roleIndex - The asset index of the role to change to

changeAppearance - true if the NPC entities appearance should change, false otherwise

state - The configured state, or null if undesired

subState - The configured substate, or null if undesired

detachFromSpawning - true to remove the NPC from world-spawn population tracking and despawning

store - The entity store for component access