Class BuilderMotionControllerMap

java.lang.Object

com.hypixel.hytale.server.npc.asset.builder.BuilderBase<Map<String, MotionController>>

com.hypixel.hytale.server.npc.movement.controllers.builders.BuilderMotionControllerMap

All Implemented Interfaces:

NamedSchema, SchemaConvertable<Void>, Builder<Map<String, MotionController>>, BuilderContext, ISpawnable

public class BuilderMotionControllerMap
extends BuilderBase<Map<String, MotionController>>
implements ISpawnable

Constructor Summary

Constructors

Constructor	Description
BuilderMotionControllerMap()

Method Summary

Modifier and Type	Method	Description
Map<String, MotionController>	build(BuilderSupport builderSupport)
SpawnTestResult	canSpawn(SpawningContext context)	Called to test whether this spawnable class type is spawnable regarding the given context
Class<Map<String, MotionController>>	category()
BuilderDescriptorState	getBuilderDescriptorState()
String	getIdentifier()
String	getLongDescription()
void	getMovementModes(SpawningContext context, Set<MovementMode> outSupportedMovementModes, Set<MovementMode> outDefaultMovementModes, Set<MovementMode> outSafeMovementModes)	Query all movement mode sets for this spawnable.
String	getShortDescription()
SpawnPositionPlacement	getSpawnPlacement(SpawningContext context)	Query where a spawn position for this spawnable must sit for the movement mode in the context.
final boolean	isEnabled(ExecutionContext context)
Builder<Map<String, MotionController>>	readConfig(com.google.gson.JsonElement data)
boolean	requiresSpawnDropHeightCheck(SpawningContext context)	Called to test whether a spawn drop height check applies to this spawnable for the given context.
boolean	validate(String configName, NPCLoadTimeValidationHelper validationHelper, ExecutionContext context, Scope globalScope, List<String> errors)	Iterates the builder tree and validates all present dynamic value holders based on the execution context and scope provided.

Methods inherited from class BuilderBase

canRequireFeature, cleanupParameters, createVector3d, createVector3d, enumSetToStrings, excludeFromRegularBuilding, expectBooleanElement, expectKey, expectObject, expectObject, expectStringArray, expectStringArray, expectStringElement, getArray, getAsset, getAsset, getAssetArray, getAssetArray, getBoolean, getBoolean, getBuilderManager, getBuilderParameters, getCodecObject, getDependencies, getDescriptionArray, getDescriptor, getDictionary, getDomain, getDouble, getDouble, getDoubleArray, getDoubleArray, getDoubleRange, getDoubleRange, getEnum, getEnum, getEnumSet, getEnumSet, getEvaluatorHelper, getFloat, getFloat, getInstructionContextHelper, getInt, getInt, getIntArray, getIntArray, getIntRange, getIntRange, getLabel, getObject, getOverride, getOverride, getOwner, getParameterBlock, getSchemaName, getStateMappingHelper, getString, getString, getStringArray, getStringArray, getTypeName, getVector3d, getVector3d, ignoreAttribute, readBoolean, readCommonConfig, readConfig, readString, readString, readStringArray, readStringArray, registerTags, requireArray, requireArray, requireAsset, requireAsset, requireAssetArray, requireAssetArray, requireBoolean, requireBoolean, requireCodecObject, requireDictionary, requireDouble, requireDouble, requireDoubleArray, requireDoubleArray, requireDoubleIfNotOverridden, requireDoubleRange, requireDoubleRange, requireEmbeddableArray, requireEnum, requireEnum, requireEnumArray, requireEnumSet, requireEnumSet, requireFloat, requireFloat, requireInt, requireInt, requireIntArray, requireIntArray, requireIntIfNotOverridden, requireIntRange, requireIntRange, requireObject, requireString, requireString, requireStringArray, requireStringArray, requireStringIfNotOverridden, requireTemporalArray, requireTemporalRange, requireVector3d, requireVector3d, setLabel, setTypeName, stringsToEnumArray, stringsToEnumSet, stringToEnum, toSchema, validateAsset, validateAssetList, validateReferencedProvidedFeatures

Methods inherited from class Object

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

Methods inherited from interface Builder

addDynamicDependency, clearDynamicDependencies, getDynamicDependencies, hasDynamicDependencies, isDeprecated, isSpawnable

Methods inherited from interface BuilderContext

getBreadCrumbs, getBreadCrumbs, getParent, setCurrentStateName

Methods inherited from interface SchemaConvertable

toSchema

Constructor Details

BuilderMotionControllerMap

public BuilderMotionControllerMap()

Method Details

build

@Nonnull
public Map<String, MotionController> build(@Nonnull
 BuilderSupport builderSupport)

Specified by:

build in interface Builder<Map<String, MotionController>>

getShortDescription

@Nonnull
public String getShortDescription()

Specified by:

getShortDescription in class BuilderBase<Map<String, MotionController>>

getLongDescription

@Nonnull
public String getLongDescription()

Specified by:

getLongDescription in class BuilderBase<Map<String, MotionController>>

getBuilderDescriptorState

@Nonnull
public BuilderDescriptorState getBuilderDescriptorState()

Specified by:

getBuilderDescriptorState in interface Builder<Map<String, MotionController>>

Specified by:

getBuilderDescriptorState in class BuilderBase<Map<String, MotionController>>

readConfig

@Nonnull
public Builder<Map<String, MotionController>> readConfig(@Nonnull
 com.google.gson.JsonElement data)

Overrides:

readConfig in class BuilderBase<Map<String, MotionController>>

category

public Class<Map<String, MotionController>> category()

Specified by:

category in interface Builder<Map<String, MotionController>>

isEnabled

public final boolean isEnabled(ExecutionContext context)

Specified by:

isEnabled in interface Builder<Map<String, MotionController>>

getIdentifier

@Nonnull
public String getIdentifier()

Specified by:

getIdentifier in interface ISpawnable

Returns:

the unique identifier of the spawnable class type

canSpawn

@Nonnull
public SpawnTestResult canSpawn(@Nonnull
 SpawningContext context)

Description copied from interface: ISpawnable

Called to test whether this spawnable class type is spawnable regarding the given context

Specified by:

canSpawn in interface ISpawnable

Parameters:

context - The SpawningContext to test against

Returns:

true if this spawnable can spawn, false if otherwise

requiresSpawnDropHeightCheck

public boolean requiresSpawnDropHeightCheck(@Nonnull
 SpawningContext context)

Description copied from interface: ISpawnable

Called to test whether a spawn drop height check applies to this spawnable for the given context.

The motion controller that supports the movement mode in the context resolves the answer. An implementation that cannot resolve it returns true, so the caller keeps the check.

Specified by:

requiresSpawnDropHeightCheck in interface ISpawnable

Parameters:

context - The SpawningContext to test against

Returns:

true if the caller must check the spawn drop height, false if otherwise

getSpawnPlacement

@Nonnull
public SpawnPositionPlacement getSpawnPlacement(@Nonnull
 SpawningContext context)

Description copied from interface: ISpawnable

Query where a spawn position for this spawnable must sit for the movement mode in the context.

The motion controller that supports the movement mode in the context resolves the answer. An implementation that cannot resolve it returns SpawnPositionPlacement.ON_GROUND.

A position search uses the answer to place its candidates. The spawnable still judges the finished candidate in ISpawnable.canSpawn(SpawningContext).

Specified by:

getSpawnPlacement in interface ISpawnable

Parameters:

context - The SpawningContext to test against

Returns:

the placement a spawn position must have

getMovementModes

public void getMovementModes(@Nonnull
 SpawningContext context,
 @Nonnull
 Set<MovementMode> outSupportedMovementModes,
 @Nonnull
 Set<MovementMode> outDefaultMovementModes,
 @Nonnull
 Set<MovementMode> outSafeMovementModes)

Description copied from interface: ISpawnable

Query all movement mode sets for this spawnable.

Specified by:

getMovementModes in interface ISpawnable

Parameters:

context - The SpawningContext to test against

outSupportedMovementModes - Populated with every movement mode the NPC's motion controller is capable of. Must be cleared before population.

outDefaultMovementModes - Populated with the movement modes used when no user configuration is present. Must be cleared before population.

outSafeMovementModes - Populated with movement modes the NPC can use safely given its breathing configuration (e.g. air-breathing walkers exclude UNDERWATER_WALK). Must be cleared before population.

validate

public boolean validate(String configName,
 @Nonnull
 NPCLoadTimeValidationHelper validationHelper,
 @Nonnull
 ExecutionContext context,
 Scope globalScope,
 @Nonnull
 List<String> errors)

Description copied from interface: Builder

Iterates the builder tree and validates all present dynamic value holders based on the execution context and scope provided. Will also run an optional ILoadTimeValidationHelper

Specified by:

validate in interface Builder<Map<String, MotionController>>

Overrides:

validate in class BuilderBase<Map<String, MotionController>>

Parameters:

configName - the name of the parent file from which the execution context and scope are derived

validationHelper - an optional validation helper that will be run in certain contexts depending on implementations

context - the execution context for resolving value holders

globalScope - the scope for resolving value holders

errors - a list for storing any errors encountered

Returns:

false if any errors were encountered during validation, true otherwise