API Reference

public record Celestial(
    CelestialTransformProvider transformProvider,
    CelestialType type,
    double size,
    double gravity,
    float r,
    float g,
    float b,
    @NotNull CelestialProperties properties
)

Vector3dc getPosition(long ticks, float partialTick, Registry<Celestial> registry)
Vector3dc getPosition(long ticks, Registry<Celestial> registry)

Quaterniondc getRotation(long ticks, float partialTick, Registry<Celestial> registry)

OBB getOBB(long ticks, Registry<Celestial> registry)
OBB getOBB(long ticks, float subticks, Registry<Celestial> registry)

double getActualSize()   // equivalent to size()

Celestial getNearestStar(long gameTime, float partialTick, Registry<Celestial> registry)
// Returns this if this is a star. Throws IllegalStateException if no stars exist.

public static final Codec<Celestial> CODEC

boolean castsLight()    // true for stars/light sources
boolean castsShadow()   // true for opaque bodies
boolean isVisitable()   // true if players can land on it
@NotNull CelestialRenderer getRenderer()
@NotNull ResourceLocation getID()
@NotNull Codec<? extends CelestialProperties> propertiesCodec()

static CelestialType get(ResourceLocation id)       // look up by ID
static void register(CelestialType type)            // register a custom type

Vector3d getPosition(long ticks, float subticks, Registry<Celestial> registry)
Quaterniondc getRotation(long ticks, float subticks, Registry<Celestial> registry)
ResourceLocation getType()

static void register(ResourceLocation type, Codec<? extends CelestialTransformProvider> codec)

Codec<CelestialTransformProvider> DISPATCH_CODEC   // dispatch codec for JSON

public StaticTransformProvider(double x, double y, double z)
public StaticTransformProvider(double x, double y, double z, double xRot, double yRot, double zRot)

public OrbitingTransformProvider(
    ResourceLocation parentID,
    int seed,
    double orbitDistance,
    double orbitTime,
    double dayLength
)

public record StarProperties(int r0, int g0, int b0, int r1, int g1, int b1)

public record PlanetProperties(Atmosphere atmosphere)

public record Atmosphere(
    double density,
    double thickness,
    boolean precipitation,
    boolean isBreathable,
    PlanetColorPalette color
)

Vector3dc getPosition()
Quaterniondc getRotation()

@Nullable static VantagePoint get(Level level, Vector3dc posInLevel, long ticks, float partialTick)
// Returns null if the level has no space-level association

@Nullable static Pair<Celestial, Double> nearestCelestialWhere(
    Registry<Celestial> registry,
    Vector3dc position,
    long ticks,
    float partialTick,
    Predicate<CelestialType> predicate
)
// Returns the nearest matching celestial and its distance squared, or null

@Nullable static Pair<Celestial, Double> celestialRaycast(
    Registry<Celestial> registry,
    long ticks,
    float partialTick,
    Vector3d origin,
    Vector3d direction,
    Predicate<CelestialType> predicate
)
// Returns the first hit celestial and distance squared along the ray, or null

public static final ResourceKey<Registry<Celestial>> CELESTIALS_KEY

// Get the celestial registry for a level
public static Registry<Celestial> getCelestialRegistry(Level level)

// Get the celestial whose ID matches the level's dimension (e.g. minecraft:overworld → Overworld celestial)
@Nullable public static Celestial getCelestialForLevel(Level level)