Contents
- Description
- Field Summary
- Method Summary
- Field Details
- Method Details
- getCombatConfig()
- getInteractionVars()
- getForwardedModifiers()
- isEmpty()
- exportedStateCount()
- applyComponentStateMap(BuilderSupport)
- popComponentStateMap(BuilderSupport)
- createScope(BuilderSupport, BuilderParameters, Scope)
- createScope(ExecutionContext, BuilderParameters, Scope)
- applyTo(StdScope, BuilderParameters, ExecutionContext)
- validateForwardedModifiers(BuilderModifier, BuilderParameters, BuilderManager, ExecutionContext, String, List)
- fromJSON(JsonObject, BuilderParameters, StateMappingHelper, ExtraInfo)
- readModifierObject(JsonObject, BuilderParameters, StringHolder, Consumer, Consumer, StateMappingHelper, ExtraInfo)
- toSchema(SchemaContext)
Class BuilderModifier
java.lang.Object
com.hypixel.hytale.server.npc.asset.builder.BuilderModifier
- All Implemented Interfaces:
ForwardedModifier
- Direct Known Subclasses:
EmptyBuilderModifier
BuilderModifier is read from JSON file to overwrite parameters in a BuilderParameters section when building from a a template.
The BuilderParameters block is in the template file and exposes all values which can be modified when instantiating the template. The BuilderModifier contains key value pairs. BuilderParameter values with matching keys are overwritten with the value from the modifier before the template is instantiated.
Example Parameters Block:
"Parameters": {
"Appearance": {"Value": "Sheep"},
"WanderRadius": {"Value": 5},
"MaxSpeed": {"Value": 3},
}
Example Modifier Block overwriting values "Appearance" and "WanderRadius" in template "Test":
"Reference": "Test",
"Modify": {
"Appearance": "Cow_Brown",
"WanderRadius": 10
}
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BuilderModifierSentinel stored in agetForwardedModifiers()map for a JSONnullvalue, meaning "explicitly drop any forwarded modifier for this slot and fall back to the slot reference's own Modify".static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Method Summary
Modifier and TypeMethodDescriptionvoidapplyComponentStateMap(BuilderSupport support) voidapplyTo(StdScope scope, BuilderParameters builderParameters, ExecutionContext executionContext) Overlay this modifier's parameter overrides onto an existing scope.createScope(BuilderSupport builderSupport, BuilderParameters builderParameters, Scope globalScope) createScope(ExecutionContext executionContext, BuilderParameters builderParameters, Scope globalScope) intstatic BuilderModifierfromJSON(com.google.gson.JsonObject jsonObject, BuilderParameters builderParameters, StateMappingHelper helper, ExtraInfo extraInfo) Map of slot name to the modifier forwarded to the component filling that slot, ornullif none.booleanisEmpty()voidpopComponentStateMap(BuilderSupport support) static voidreadModifierObject(com.google.gson.JsonObject jsonObject, BuilderParameters builderParameters, StringHolder holder, Consumer<StringHolder> referenceConsumer, Consumer<BuilderModifier> builderModifierConsumer, StateMappingHelper helper, ExtraInfo extraInfo) static SchematoSchema(SchemaContext context) static booleanvalidateForwardedModifiers(BuilderModifier mod, BuilderParameters params, BuilderManager builderManager, ExecutionContext context, String configName, List<String> errors) Validates a modifier's forwarded modifiers fully at load time.
-
Field Details
-
KEY_MODIFY
- See Also:
-
KEY_EXPORT_STATES
- See Also:
-
KEY_INTERFACE_PARAMETERS
- See Also:
-
KEY_COMBAT_CONFIG
- See Also:
-
KEY_INTERACTION_VARS
- See Also:
-
KEY_FORWARDED_MODIFIERS
- See Also:
-
CLEARED
Sentinel stored in agetForwardedModifiers()map for a JSONnullvalue, meaning "explicitly drop any forwarded modifier for this slot and fall back to the slot reference's own Modify".
-
-
Method Details
-
getCombatConfig
-
getInteractionVars
-
getForwardedModifiers
Map of slot name to the modifier forwarded to the component filling that slot, ornullif none. A value ofCLEAREDmeans the forward was explicitly nulled out. -
isEmpty
public boolean isEmpty() -
exportedStateCount
public int exportedStateCount() -
applyComponentStateMap
-
popComponentStateMap
-
createScope
@Nonnull public Scope createScope(@Nonnull BuilderSupport builderSupport, @Nonnull BuilderParameters builderParameters, Scope globalScope) -
createScope
@Nonnull public Scope createScope(ExecutionContext executionContext, @Nonnull BuilderParameters builderParameters, @Nullable Scope globalScope) -
applyTo
public void applyTo(@Nonnull StdScope scope, @Nonnull BuilderParameters builderParameters, ExecutionContext executionContext) Overlay this modifier's parameter overrides onto an existing scope. -
validateForwardedModifiers
public static boolean validateForwardedModifiers(@Nonnull BuilderModifier mod, @Nonnull BuilderParameters params, @Nonnull BuilderManager builderManager, @Nonnull ExecutionContext context, String configName, @Nonnull List<String> errors) Validates a modifier's forwarded modifiers fully at load time. -
fromJSON
@Nonnull public static BuilderModifier fromJSON(@Nonnull com.google.gson.JsonObject jsonObject, @Nonnull BuilderParameters builderParameters, @Nonnull StateMappingHelper helper, @Nonnull ExtraInfo extraInfo) -
readModifierObject
public static void readModifierObject(@Nonnull com.google.gson.JsonObject jsonObject, @Nonnull BuilderParameters builderParameters, @Nonnull StringHolder holder, @Nonnull Consumer<StringHolder> referenceConsumer, @Nonnull Consumer<BuilderModifier> builderModifierConsumer, @Nonnull StateMappingHelper helper, @Nonnull ExtraInfo extraInfo) -
toSchema
-