bettermodel-api/kr.toxicity.model.api.tracker/ModelScaler

ModelScaler

Defines how a model's scale is calculated.

Scalers can be constant values, derived from entity attributes, or composites of multiple scalers. They are serializable to JSON for configuration purposes.

Since

1.15.2

Inheritors

Composite

Types

Builder

interface Builder

Builder interface for creating Getters from JSON.

BuiltInDeserializer

interface BuiltInDeserializer : Function<JsonElement, ModelScaler>

Helper interface for built-in deserializers.

Composite

class Composite : ModelScaler

Implementation of a composite scaler.

Deserializer

class Deserializer

Registry and factory for scalers.

Getter

interface Getter

Functional interface for calculating scale.

Properties

DESERIALIZER

val DESERIALIZER: ModelScaler.Deserializer

The global deserializer instance for scalers.

Functions

composite

@NotNull

open fun composite(@NotNull scaler: @NotNull ModelScaler): @NotNull ModelScaler

Multiplies this scaler by another scaler.

@NotNull

open fun composite(@NotNull scalers: Array<@NotNull ModelScaler>): @NotNull ModelScaler

Creates a composite scaler that multiplies the results of multiple scalers.

data

@Nullable

abstract fun data(): @Nullable JsonElement

Returns the configuration data for this scaler as a JSON element.

defaultScaler

@NotNull

open fun defaultScaler(): @NotNull ModelScaler

Returns the default scaler (constant 1.0).

deserialize

@NotNull

open fun deserialize(@NotNull element: @NotNull JsonObject): @NotNull ModelScaler

Deserializes a scaler from a JSON object.

entity

@NotNull

open fun entity(): @NotNull ModelScaler

Returns a scaler that uses the entity's scale attribute.

multiply

@NotNull

open fun multiply(value: Float): @NotNull ModelScaler

Multiplies this scaler by a constant value.

name

@NotNull

abstract fun name(): @NotNull String

Returns the name of this scaler type.

scale

abstract fun scale(@NotNull tracker: @NotNull Tracker): Float

Calculates the scale for a given tracker.

serialize

@NotNull

open fun serialize(): @NotNull JsonObject

Serializes this scaler to a JSON object.

value

@NotNull

open fun value(value: Float): @NotNull ModelScaler

Returns a constant value scaler.