Class BlockOptions

Hierarchy

  • BlockOptions

Constructors

constructor

Properties

blockMesh fluid fluidDensity material onCustomMeshCreate onLoad onSet onUnload onUnset opaque solid viscosity

Constructors

constructor

  • Default options when registering a block type

    Parameters

    • isFluid: boolean = false

    Returns BlockOptions

Properties

blockMesh

blockMesh: any

Specifies a custom mesh for this voxel, instead of terrain

fluid

fluid: boolean

whether a nonsolid block is a fluid (buoyant, viscous..)

fluidDensity

fluidDensity: number

Fluid parameter for fluid blocks

material

material: string | string[]

The block material(s) for this voxel's faces. May be:

  • one (String) material name
  • array of 2 names: [top/bottom, sides]
  • array of 3 names: [top, bottom, sides]
  • array of 6 names: [-x, +x, -y, +y, -z, +z]

onCustomMeshCreate

onCustomMeshCreate: ((mesh, x, y, z) => void)

Type declaration

    • (mesh, x, y, z): void

    • Parameters

      • mesh: TransformNode
      • x: number
      • y: number
      • z: number

      Returns void

onLoad

onLoad: ((x, y, z) => void)

Type declaration

    • (x, y, z): void

    • Parameters

      • x: number
      • y: number
      • z: number

      Returns void

onSet

onSet: ((x, y, z) => void)

Type declaration

    • (x, y, z): void

    • Parameters

      • x: number
      • y: number
      • z: number

      Returns void

onUnload

onUnload: ((x, y, z) => void)

Type declaration

    • (x, y, z): void

    • Parameters

      • x: number
      • y: number
      • z: number

      Returns void

onUnset

onUnset: ((x, y, z) => void)

Type declaration

    • (x, y, z): void

    • Parameters

      • x: number
      • y: number
      • z: number

      Returns void

opaque

opaque: boolean

Whether the block fully obscures neighboring blocks

solid

solid: boolean

Solidity for physics purposes

viscosity

viscosity: number

Fluid parameter for fluid blocks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc