Skip to content

Go: Custom dimensions

Functions

AddGeneratedDimension

Go
1
func AddGeneratedDimension(name, spec string, materials, biomes []string, fill func(*ChunkRequest) bool) (int32, error)

AddGeneratedDimension registers a dimension whose terrain fill writes, and returns its id.

fill runs on the host's chunk worker threads, several at once: it must be safe to run concurrently, give the same answer for the same chunk forever, and call nothing on this package but the request itself. Returning false leaves the chunk to air. materials[0] must be "minecraft:air". The function is kept for the dimension's whole life.

  • Parameters:
    • name : string
    • spec : string
    • materials : []string
    • biomes : []string
    • fill : func(*ChunkRequest) bool
  • Return type: (int32, error)
  • Slots: md_add_dimension_generated

DimensionsAvailable

Go
1
func DimensionsAvailable() (bool, error)

DimensionsAvailable reports whether this host can register custom dimensions.

AddDimension

Go
1
func AddDimension(name, spec string) (int32, error)

AddDimension registers a dimension from spec SNBT and returns its id.

  • Parameters:
    • name : string
    • spec : string
  • Return type: (int32, error)
  • Slots: md_add_dimension

DimensionID

Go
1
func DimensionID(name string) (int32, error)

DimensionID is the id of a registered dimension.

ListDimensions

Go
1
func ListDimensions() ([]string, error)

ListDimensions lists the registered custom dimensions.

SetDimensionRule

Go
1
func SetDimensionRule(dim, rule int32, allow bool) error

SetDimensionRule sets one rule, a PIER_DIMRULE_* value, for one dimension.

DimensionRule

Go
1
func DimensionRule(dim, rule int32) (allow, set bool, err error)

DimensionRule reads one rule; set is false when the dimension follows vanilla for it, which a host older than the rule also answers.

  • Parameters:
    • dim : int32
    • rule : int32
  • Return type: (allow, set bool, err error)
  • Slots: md_get_dimension_rule

ChunkRequest

Go
1
2
3
4
5
6
type ChunkRequest struct {
    Dim, ChunkX, ChunkZ int32
    MinY, Height        int32
    Materials           []uint16
    Biomes              []uint16
}

ChunkRequest is one chunk a supplied-terrain generator fills. Materials has 256*Height entries indexed (x*16+z)*Height + (y-MinY), and Biomes 256, one per column; both hold indices into the palettes given at registration, and material 0 is air.