Class: BlockObject

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:22

Extends

• SceneObject

Constructors

Constructor

new BlockObject(blockState, options?): BlockObject;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:49

Parameters

Parameter	Type
blockState	BlockState
options?	Partial<BlockObjectOptions>

Returns

BlockObject

Overrides

SceneObject.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
_instanceCounter	public	number	0	-	SceneObject._instanceCounter	packages/minerender/src/renderer/SceneObject.ts:41
blockState	readonly	BlockState	undefined	-	-	packages/minerender/src/model/block/scene/BlockObject.ts:49
isBlockObject	readonly	true	true	-	-	packages/minerender/src/model/block/scene/BlockObject.ts:24
isSceneObject	readonly	true	true	-	SceneObject.isSceneObject	packages/minerender/src/renderer/SceneObject.ts:26
options	readonly	BlockObjectOptions	undefined	SceneObject.options	-	packages/minerender/src/model/block/scene/BlockObject.ts:29
DEFAULT_OPTIONS	readonly	BlockObjectOptions	undefined	SceneObject.DEFAULT_OPTIONS	-	packages/minerender/src/model/block/scene/BlockObject.ts:26

Accessors

blockEntities

Get Signature

get blockEntities(): readonly EntityObject[];

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:99

Entity models drawn for this block instead of its block model; they are scene children, unlike the block.

Returns

readonly EntityObject[]

---

fluidKind

Get Signature

get fluidKind(): FluidKind | undefined;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:216

Returns

FluidKind | undefined

---

fluidLevel

Get Signature

get fluidLevel(): number;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:220

Returns

number

---

instanceCounter

Get Signature

get instanceCounter(): number;

Defined in: packages/minerender/src/renderer/SceneObject.ts:243

Returns

number

Inherited from

SceneObject.instanceCounter

---

isInstanced

Get Signature

get isInstanced(): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:239

Returns

boolean

Inherited from

SceneObject.isInstanced

---

isOccluding

Get Signature

get isOccluding(): boolean;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:149

Returns

boolean

---

scene

Get Signature

get scene(): MineRenderScene;

Defined in: packages/minerender/src/renderer/SceneObject.ts:57

Returns

MineRenderScene

Set Signature

set scene(scene): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:52

Parameters

Parameter	Type
scene	MineRenderScene

Returns

void

Inherited from

SceneObject.scene

---

state

Get Signature

get state(): object;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:212

Returns

object

Methods

dispose()

dispose(): void;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:64

Returns

void

Overrides

SceneObject.dispose

---

disposeAndRemoveAllChildren()

disposeAndRemoveAllChildren(): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:490

Returns

void

Inherited from

SceneObject.disposeAndRemoveAllChildren

---

getGroupByName()

getGroupByName(name): Maybe<Object3D<Object3DEventMap>>;

Defined in: packages/minerender/src/renderer/SceneObject.ts:108

Get a group by its name

Parameters

Parameter	Type
name	string

Returns

Maybe<Object3D<Object3DEventMap>>

Inherited from

SceneObject.getGroupByName

---

getInstanceReference()

getInstanceReference(mesh, index): Maybe<InstanceReference<SceneObject>>;

Defined in: packages/minerender/src/renderer/SceneObject.ts:270

Returns the live reference for a raycast hit on this object's instance mesh.

Parameters

Parameter	Type
mesh	Object3D
index	number

Returns

Maybe<InstanceReference<SceneObject>>

Inherited from

SceneObject.getInstanceReference

---

getMatrixAt()

getMatrixAt(index, matrix?): Matrix4;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:428

Parameters

Parameter	Type
index	number
matrix	Matrix4

Returns

Matrix4

Overrides

SceneObject.getMatrixAt

---

getMeshByName()

getMeshByName(name): Maybe<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>;

Defined in: packages/minerender/src/renderer/SceneObject.ts:178

Get a mesh by its name

Parameters

Parameter	Type
name	string

Returns

Maybe<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>

Inherited from

SceneObject.getMeshByName

---

getPosition()

getPosition(): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:421

Returns

Vector3

Inherited from

SceneObject.getPosition

---

getPositionAt()

getPositionAt(index, vector?): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:360

Parameters

Parameter	Type
index	number
vector	Vector3

Returns

Vector3

Inherited from

SceneObject.getPositionAt

---

getRotation()

getRotation(): Euler;

Defined in: packages/minerender/src/renderer/SceneObject.ts:440

Returns

Euler

Inherited from

SceneObject.getRotation

---

getRotationAt()

getRotationAt(index, euler?): Euler;

Defined in: packages/minerender/src/renderer/SceneObject.ts:372

Parameters

Parameter	Type
index	number
euler	Euler

Returns

Euler

Inherited from

SceneObject.getRotationAt

---

getScale()

getScale(): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:459

Returns

Vector3

Inherited from

SceneObject.getScale

---

getScaleAt()

getScaleAt(index, vector?): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:384

Parameters

Parameter	Type
index	number
vector	Vector3

Returns

Vector3

Inherited from

SceneObject.getScaleAt

---

init()

init(): Promise<void>;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:55

Returns

Promise<void>

Overrides

SceneObject.init

---

isInstanceActive()

isInstanceActive(index, reference): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:274

Parameters

Parameter	Type
index	number
reference	InstanceReference<Instanceable>

Returns

boolean

Inherited from

SceneObject.isInstanceActive

---

iterateAllMeshes()

iterateAllMeshes(cb): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:191

Parameters

Parameter	Type
cb	(mesh) => void

Returns

void

Inherited from

SceneObject.iterateAllMeshes

---

nextInstance()

nextInstance(): InstanceReference<SceneObject>;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:250

Returns

InstanceReference<SceneObject>

Overrides

SceneObject.nextInstance

---

notifyDirty()

notifyDirty(): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:65

Returns

void

Inherited from

SceneObject.notifyDirty

---

recreateModels()

recreateModels(): Promise<void>;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:265

Returns

Promise<void>

---

removeFromScene()

removeFromScene(): void;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:69

Returns

void

Overrides

SceneObject.removeFromScene

---

removeInstanceAt()

removeInstanceAt(index): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:278

Parameters

Parameter	Type
index	number

Returns

void

Inherited from

SceneObject.removeInstanceAt

---

resetState()

resetState(): Promise<void>;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:353

Returns

Promise<void>

---

setCullMask()

setCullMask(worldMask): Promise<void>;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:174

Parameters

Parameter	Type
worldMask	number

Returns

Promise<void>

---

setMatrixAt()

setMatrixAt(index, matrix): void;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:448

Parameters

Parameter	Type
index	number
matrix	Matrix4

Returns

void

Overrides

SceneObject.setMatrixAt

---

setPosition()

setPosition(position): void;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:468

Parameters

Parameter	Type
position	Vector3

Returns

void

Overrides

SceneObject.setPosition

---

setPositionAt()

setPositionAt(index, position): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:355

Parameters

Parameter	Type
index	number
position	Vector3

Returns

void

Inherited from

SceneObject.setPositionAt

---

setPositionRotationScale()

setPositionRotationScale(
   position?, 
   rotation?, 
   scale?
): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:391

Parameters

Parameter	Type
position?	Vector3
rotation?	Euler
scale?	Vector3

Returns

void

Inherited from

SceneObject.setPositionRotationScale

---

setPositionRotationScaleAt()

setPositionRotationScaleAt(
   index, 
   position?, 
   rotation?, 
   scale?
): void;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:424

Parameters

Parameter	Type
index	number
position?	Vector3
rotation?	Euler
scale?	Vector3

Returns

void

Overrides

SceneObject.setPositionRotationScaleAt

---

setRotation()

setRotation(rotation): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:429

Parameters

Parameter	Type
rotation	Euler

Returns

void

Inherited from

SceneObject.setRotation

---

setRotationAt()

setRotationAt(index, rotation): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:367

Parameters

Parameter	Type
index	number
rotation	Euler

Returns

void

Inherited from

SceneObject.setRotationAt

---

setScale()

setScale(scale): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:448

Parameters

Parameter	Type
scale	Vector3

Returns

void

Inherited from

SceneObject.setScale

---

setScaleAt()

setScaleAt(index, scale): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:379

Parameters

Parameter	Type
index	number
scale	Vector3

Returns

void

Inherited from

SceneObject.setScaleAt

---

setState()

Call Signature

setState(string): any;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:360

Parameters

Parameter	Type
string	string

Returns

any

Call Signature

setState(state): any;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:361

Parameters

Parameter	Type
state	BlockStateProperties

Returns

any

Call Signature

setState(key, value): any;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:362

Parameters

Parameter	Type
key	string
value	string

Returns

any

---

toggleGroupVisibility()

toggleGroupVisibility(name, visible?): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:117

Toggle visibility of a group

Parameters

Parameter	Type	Description
name	string	name of the group
visible?	boolean	set the visibility directly, if not set toggles it

Returns

boolean

Inherited from

SceneObject.toggleGroupVisibility

---

toggleMeshVisibility()

toggleMeshVisibility(name, visible?): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:187

Toggle visibility of a mesh

Parameters

Parameter	Type	Description
name	string	name of the mesh
visible?	boolean	set the visibility directly, if not set toggles it

Returns

boolean

Inherited from

SceneObject.toggleMeshVisibility

---

updateFluid()

updateFluid(sample?): Promise<void>;

Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:225

Refreshes fluid surfaces from relative neighbors; standalone previews use air around the block.

Parameters

Parameter	Type
sample?	FluidSampler

Returns

Promise<void>