Class InteractionModule

java.lang.Object

com.hypixel.hytale.server.core.plugin.PluginBase

com.hypixel.hytale.server.core.plugin.JavaPlugin

com.hypixel.hytale.server.core.modules.interaction.InteractionModule

All Implemented Interfaces:

CommandOwner

public class InteractionModule
extends JavaPlugin

Since:

4/4/17.

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumCodec<InteractionType>	INTERACTION_TYPE_CODEC
static final SetCodec<InteractionType, EnumSet<InteractionType>>	INTERACTION_TYPE_SET_CODEC
static final PluginManifest	MANIFEST

Fields inherited from class PluginBase

METRICS_REGISTRY

Constructor Summary

Constructors

Constructor	Description
InteractionModule(JavaPluginInit init)

Method Summary

Modifier and Type	Method	Description
void	doMouseInteraction(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor, MouseInteraction packet, Player playerComponent, PlayerRef playerRefComponent)	Called to handle an incoming mouse interaction packet from the provided client,
static InteractionModule	get()
ResourceType<ChunkStore, BlockCounter>	getBlockCounterResourceType()
ComponentType<EntityStore, CarriedBlock>	getCarriedBlockComponentType()
ResourceType<EntityStore, CarriedBlockSystems.QueueResource>	getCarriedBlockQueueResourceType()
ComponentType<EntityStore, ChainingInteraction.Data>	getChainingDataComponent()
ComponentType<EntityStore, OpenChapterRewardsInteraction.ChapterRewardsPrompt>	getChapterRewardsPromptComponent()
ComponentType<EntityStore, OpenChapterRewardsInteraction.ChapterRewardsSoundPlayed>	getChapterRewardsSoundPlayedComponent()
ComponentType<EntityStore, InteractionHost>	getInteractionHostComponentType()
ComponentType<EntityStore, InteractionManager>	getInteractionManagerComponent()
ComponentType<EntityStore, Interactions>	getInteractionsComponentType()
ComponentType<ChunkStore, PlacedByInteractionComponent>	getPlacedByComponentType()
ComponentType<ChunkStore, TrackedPlacement>	getTrackedPlacementComponentType()

Methods inherited from class JavaPlugin

getClassLoader, getFile, getType

Methods inherited from class PluginBase

getAssetRegistry, getBasePermission, getChunkStoreRegistry, getClientFeatureRegistry, getCodecRegistry, getCodecRegistry, getCodecRegistry, getCommandRegistry, getDataDirectory, getEntityRegistry, getEntityStoreRegistry, getEventRegistry, getIdentifier, getLogger, getManifest, getName, getState, getTaskRegistry, isDisabled, isEnabled, preLoad

Methods inherited from class Object

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

Field Details

MANIFEST

@Nonnull
public static final PluginManifest MANIFEST

INTERACTION_TYPE_CODEC

@Nonnull
public static final EnumCodec<InteractionType> INTERACTION_TYPE_CODEC

INTERACTION_TYPE_SET_CODEC

@Nonnull
public static final SetCodec<InteractionType, EnumSet<InteractionType>> INTERACTION_TYPE_SET_CODEC

Constructor Details

InteractionModule

public InteractionModule(@Nonnull
 JavaPluginInit init)

Method Details

get

@Nonnull
public static InteractionModule get()

Returns:

the static InteractionModule instance

doMouseInteraction

public void doMouseInteraction(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor,
 @Nonnull
 MouseInteraction packet,
 @Nonnull
 Player playerComponent,
 @Nonnull
 PlayerRef playerRefComponent)

Called to handle an incoming mouse interaction packet from the provided client,

Parameters:

ref - The entity reference of the sending player entity.

componentAccessor - The associated ComponentAccessor<EntityStore> instance.

packet - The MouseInteraction packet instance that was received.

playerComponent - The Player component instance of the sending player entity.

playerRefComponent - The PlayerRef component instance of the sending player entity.

getChainingDataComponent

@Nonnull
public ComponentType<EntityStore, ChainingInteraction.Data> getChainingDataComponent()

Returns:

the component type for the ChainingInteraction.Data component.

getChapterRewardsPromptComponent

@Nonnull
public ComponentType<EntityStore, OpenChapterRewardsInteraction.ChapterRewardsPrompt> getChapterRewardsPromptComponent()

Returns:

the component type for the OpenChapterRewardsInteraction.ChapterRewardsPrompt component.

getChapterRewardsSoundPlayedComponent

@Nonnull
public ComponentType<EntityStore, OpenChapterRewardsInteraction.ChapterRewardsSoundPlayed> getChapterRewardsSoundPlayedComponent()

Returns:

the component type for the OpenChapterRewardsInteraction.ChapterRewardsSoundPlayed component.

getInteractionsComponentType

@Nonnull
public ComponentType<EntityStore, Interactions> getInteractionsComponentType()

Returns:

the component for the Interactions component.

getInteractionManagerComponent

@Nonnull
public ComponentType<EntityStore, InteractionManager> getInteractionManagerComponent()

Returns:

the component for the InteractionManager component.

getInteractionHostComponentType

@Nonnull
public ComponentType<EntityStore, InteractionHost> getInteractionHostComponentType()

Returns:

the component type for the InteractionHost component.

getPlacedByComponentType

@Nonnull
public ComponentType<ChunkStore, PlacedByInteractionComponent> getPlacedByComponentType()

Returns:

the component for the PlacedByInteractionComponent component.

getCarriedBlockComponentType

@Nonnull
public ComponentType<EntityStore, CarriedBlock> getCarriedBlockComponentType()

Returns:

the component type for the transient CarriedBlock component.

getCarriedBlockQueueResourceType

@Nonnull
public ResourceType<EntityStore, CarriedBlockSystems.QueueResource> getCarriedBlockQueueResourceType()

Returns:

the resource type tracking entities whose CarriedBlock changed this tick.

getBlockCounterResourceType

public ResourceType<ChunkStore, BlockCounter> getBlockCounterResourceType()

getTrackedPlacementComponentType

public ComponentType<ChunkStore, TrackedPlacement> getTrackedPlacementComponentType()