Package kr.toxicity.model.api

Interface BetterModelConfig

public interface BetterModelConfig
Represents the main configuration interface for BetterModel.

This interface provides access to various configuration settings, including debug options, pack generation settings, module toggles, and runtime behaviors.

Since:
1.15.2

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    BetterModelConfig.PackType
    Enumerates the types of resource pack generation.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    buildFolderLocation()
    Returns the location of the build folder for resource packs.
    boolean
    cancelPlayerModelInventory()
    Checks if inventory swap packets should be cancelled for players with active models.
    @NotNull DebugConfig
    debug()
    Returns the debug configuration.
    @NotNull MountController
    defaultMountController()
    Returns the default mount controller used for entities.
    boolean
    enableStrictLoading()
    Checks if strict loading mode is enabled.
    boolean
    followMobInvisibility()
    Checks if model trackers should follow the source entity's invisibility status.
    @NotNull IndicatorConfig
    indicator()
    Returns the indicator configuration.
    @NotNull Supplier<PlatformItemStack>
    item()
    Returns a supplier for the platform item stack used as the base for model items.
    @NotNull String
    itemModel()
    Returns the item model string identifier used for the resource pack target item.
    @NotNull String
    itemNamespace()
    Returns the namespace used for the target item.
    int
    lerpFrameTime()
    Returns the interpolation frame time (lerp) in milliseconds.
    double
    maxSight()
    Returns the maximum range for sight tracing.
    boolean
    mergeWithExternalResources()
    Checks if BetterModel should attempt to merge its resource pack with external plugins/mods.
    boolean
    metrics()
    Checks if metrics collection is enabled.
    double
    minSight()
    Returns the minimum range for sight tracing.
    @NotNull ModuleConfig
    module()
    Returns the module configuration.
    @NotNull String
    namespace()
    Returns the namespace used for the generated resource pack.
    @NotNull PackConfig
    pack()
    Returns the resource pack configuration.
    int
    packetBundlingSize()
    Returns the threshold size for packet bundling.
    @NotNull BetterModelConfig.PackType
    packType()
    Returns the type of resource pack generation (Folder, Zip, or None).
    long
    playerHideDelay()
    Returns the delay in ticks before hiding a player's model after they become invisible.
    boolean
    sightTrace()
    Checks if sight tracing (visibility checking) is enabled.
    boolean
    usePurpurAfk()
    Checks if Purpur's AFK API should be used.
    boolean
    versionCheck()
    Checks if version update notifications should be sent to OPs on join.

  • Method Details

    • debug

      @NotNull @NotNull DebugConfig debug()
      Returns the debug configuration.
      Returns:
      the debug config
      Since:
      1.15.2

    • indicator

      @NotNull @NotNull IndicatorConfig indicator()
      Returns the indicator configuration.
      Returns:
      the indicator config
      Since:
      1.15.2

    • module

      @NotNull @NotNull ModuleConfig module()
      Returns the module configuration.
      Returns:
      the module config
      Since:
      1.15.2

    • pack

      @NotNull @NotNull PackConfig pack()
      Returns the resource pack configuration.
      Returns:
      the pack config
      Since:
      1.15.2

    • metrics

      boolean metrics()
      Checks if metrics collection is enabled.
      Returns:
      true if enabled, false otherwise
      Since:
      1.15.2

    • sightTrace

      boolean sightTrace()
      Checks if sight tracing (visibility checking) is enabled.
      Returns:
      true if enabled, false otherwise
      Since:
      1.15.2

    • mergeWithExternalResources

      boolean mergeWithExternalResources()
      Checks if BetterModel should attempt to merge its resource pack with external plugins/mods.
      Returns:
      true to merge, false otherwise
      Since:
      1.15.2

    • item

      @NotNull @NotNull Supplier<PlatformItemStack> item()
      Returns a supplier for the platform item stack used as the base for model items.
      Returns:
      a supplier providing the target item stack
      Since:
      2.0.0

    • itemModel

      @NotNull @NotNull String itemModel()
      Returns the item model string identifier used for the resource pack target item.
      Returns:
      the item model string
      Since:
      2.0.0

    • itemNamespace

      @NotNull @NotNull String itemNamespace()
      Returns the namespace used for the target item.
      Returns:
      the item namespace
      Since:
      1.15.2

    • maxSight

      double maxSight()
      Returns the maximum range for sight tracing.
      Returns:
      the max range
      Since:
      1.15.2

    • minSight

      double minSight()
      Returns the minimum range for sight tracing.
      Returns:
      the min range
      Since:
      1.15.2

    • namespace

      @NotNull @NotNull String namespace()
      Returns the namespace used for the generated resource pack.
      Returns:
      the namespace
      Since:
      1.15.2

    • packType

      @NotNull @NotNull BetterModelConfig.PackType packType()
      Returns the type of resource pack generation (Folder, Zip, or None).
      Returns:
      the pack type
      Since:
      1.15.2

    • buildFolderLocation

      @NotNull @NotNull String buildFolderLocation()
      Returns the location of the build folder for resource packs.
      Returns:
      the build folder path
      Since:
      1.15.2

    • followMobInvisibility

      boolean followMobInvisibility()
      Checks if model trackers should follow the source entity's invisibility status.
      Returns:
      true to follow invisibility, false otherwise
      Since:
      1.15.2

    • usePurpurAfk

      boolean usePurpurAfk()
      Checks if Purpur's AFK API should be used.
      Returns:
      true to use Purpur AFK, false otherwise
      Since:
      1.15.2

    • versionCheck

      boolean versionCheck()
      Checks if version update notifications should be sent to OPs on join.
      Returns:
      true to send notifications, false otherwise
      Since:
      1.15.2

    • defaultMountController

      @NotNull @NotNull MountController defaultMountController()
      Returns the default mount controller used for entities.
      Returns:
      the default mount controller
      Since:
      1.15.2
      See Also:

    • lerpFrameTime

      int lerpFrameTime()
      Returns the interpolation frame time (lerp) in milliseconds.
      Returns:
      the lerp frame time
      Since:
      1.15.2

    • cancelPlayerModelInventory

      boolean cancelPlayerModelInventory()
      Checks if inventory swap packets should be cancelled for players with active models.
      Returns:
      true to cancel, false otherwise
      Since:
      1.15.2

    • playerHideDelay

      long playerHideDelay()
      Returns the delay in ticks before hiding a player's model after they become invisible.
      Returns:
      the hide delay
      Since:
      1.15.2

    • packetBundlingSize

      int packetBundlingSize()
      Returns the threshold size for packet bundling.
      Returns:
      the packet bundling size
      Since:
      1.15.2

    • enableStrictLoading

      boolean enableStrictLoading()
      Checks if strict loading mode is enabled.

      Strict loading causes the platform to fail fast on model loading errors.

      Returns:
      true if strict loading is enabled, false otherwise
      Since:
      1.15.2