java.lang.Object

net.minecraftforge.client.model.generators.ConfiguredModel

public final class ConfiguredModel extends Object

Represents a model with blockstate configurations, e.g. rotation, uvlock, and random weight.

Can be manually constructed, created by static factory such as allYRotations(ModelFile, int, boolean), or created by builder via builder().

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ConfiguredModel.Builder<T>

A builder for ConfiguredModels, which can contain a callback for processing the finished result.
Field Summary

Fields

Modifier and Type

Field

Description

static final int

DEFAULT_WEIGHT

The default random weight of configured models, used by convenience overloads.

final ModelFile

model

final int

rotationX

final int

rotationY

final boolean

uvLock

final int

weight
Constructor Summary

Constructors

Constructor

Description

ConfiguredModel(ModelFile model)

Construct a new ConfiguredModel with the default rotation (0, 0), uvlock (false), and default random weight.

ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock)

Construct a new ConfiguredModel with the default random weight.

ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock, int weight)

Construct a new ConfiguredModel.
Method Summary

Modifier and Type

Method

Description

static ConfiguredModel[]

allRotations(ModelFile model, boolean uvlock)

static ConfiguredModel[]

allRotations(ModelFile model, boolean uvlock, int weight)

static ConfiguredModel[]

allYRotations(ModelFile model, int x, boolean uvlock)

static ConfiguredModel[]

allYRotations(ModelFile model, int x, boolean uvlock, int weight)

static ConfiguredModel.Builder<?>

builder()

Create a new unowned ConfiguredModel.Builder.

(package private) static ConfiguredModel.Builder<MultiPartBlockStateBuilder.PartBuilder>

builder(MultiPartBlockStateBuilder outer)

(package private) static ConfiguredModel.Builder<VariantBlockStateBuilder>

builder(VariantBlockStateBuilder outer, VariantBlockStateBuilder.PartialBlockstate state)

(package private) static void

checkRotation(int rotationX, int rotationY)

(package private) static void

checkWeight(int weight)

(package private) com.google.gson.JsonObject

toJSON(boolean includeWeight)

private static IntStream

validRotations()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- DEFAULT_WEIGHT
  
  public static final int DEFAULT_WEIGHT
  
  The default random weight of configured models, used by convenience overloads.
  See Also:
  
  Constant Field Values
- model
  
  public final ModelFile model
- rotationX
  
  public final int rotationX
- rotationY
  
  public final int rotationY
- uvLock
  
  public final boolean uvLock
- weight
  
  public final int weight
Constructor Details
- ConfiguredModel
  
  public ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock, int weight)
  
  Construct a new ConfiguredModel.
  
  Parameters:
  
  model - the underlying model
  
  rotationX - x-rotation to apply to the model
  
  rotationY - y-rotation to apply to the model
  
  uvLock - if uvlock should be enabled
  
  weight - the random weight of the model
  
  Throws:
  
  NullPointerException - if model is null
  
  IllegalArgumentException - if x and/or y rotation are not valid (see BlockModelRotation)
  
  IllegalArgumentException - if weight is less than or equal to zero
- ConfiguredModel
  
  public ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock)
  
  Construct a new ConfiguredModel with the default random weight.
  
  Parameters:
  
  model - the underlying model
  
  rotationX - x-rotation to apply to the model
  
  rotationY - y-rotation to apply to the model
  
  uvLock - if uvlock should be enabled
  
  Throws:
  
  NullPointerException - if model is null
  
  IllegalArgumentException - if x and/or y rotation are not valid (see BlockModelRotation)
- ConfiguredModel
  
  public ConfiguredModel(ModelFile model)
  
  Construct a new ConfiguredModel with the default rotation (0, 0), uvlock (false), and default random weight.
  
  Throws:
  
  NullPointerException - if model is null
Method Details
- validRotations
  
  private static IntStream validRotations()
- allYRotations
  
  public static ConfiguredModel[] allYRotations(ModelFile model, int x, boolean uvlock)
- allYRotations
  
  public static ConfiguredModel[] allYRotations(ModelFile model, int x, boolean uvlock, int weight)
- allRotations
  
  public static ConfiguredModel[] allRotations(ModelFile model, boolean uvlock)
- allRotations
  
  public static ConfiguredModel[] allRotations(ModelFile model, boolean uvlock, int weight)
- checkRotation
  
  static void checkRotation(int rotationX, int rotationY)
- checkWeight
  
  static void checkWeight(int weight)
- toJSON
  
  com.google.gson.JsonObject toJSON(boolean includeWeight)
- builder
  
  public static ConfiguredModel.Builder<?> builder()
  
  Create a new unowned ConfiguredModel.Builder.
  Returns:
  
  the builder
  
  See Also:
  
  ConfiguredModel.Builder
- builder
  
  static ConfiguredModel.Builder<VariantBlockStateBuilder> builder(VariantBlockStateBuilder outer, VariantBlockStateBuilder.PartialBlockstate state)
- builder
  
  static ConfiguredModel.Builder<MultiPartBlockStateBuilder.PartBuilder> builder(MultiPartBlockStateBuilder outer)

Class ConfiguredModel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

DEFAULT_WEIGHT

model

rotationX

rotationY

uvLock

weight

Constructor Details

ConfiguredModel

ConfiguredModel

ConfiguredModel

Method Details

validRotations

allYRotations

allYRotations

allRotations

allRotations

checkRotation

checkWeight

toJSON

builder

builder

builder