Skip to content

Class: BlockObject ​

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

Controls the model parts selected by a blockstate. Create it through MineRenderScene.addBlock.

Extends ​

Constructors ​

Constructor ​

ts
new BlockObject(blockState, options?): BlockObject;

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

Parameters ​

ParameterType
blockStateBlockState
options?Partial<BlockObjectOptions>

Returns ​

BlockObject

Overrides ​

SceneObject.constructor

Properties ​

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_instanceCounterpublicnumber0-SceneObject._instanceCounterpackages/minerender/src/renderer/SceneObject.ts:42
blockStatereadonlyBlockStateundefined--packages/minerender/src/model/block/scene/BlockObject.ts:60
isBlockObjectreadonlytruetrue--packages/minerender/src/model/block/scene/BlockObject.ts:31
isSceneObjectreadonlytruetrue-SceneObject.isSceneObjectpackages/minerender/src/renderer/SceneObject.ts:27
optionsreadonlyBlockObjectOptionsundefinedSceneObject.options-packages/minerender/src/model/block/scene/BlockObject.ts:36
DEFAULT_OPTIONSreadonlyBlockObjectOptionsundefinedSceneObject.DEFAULT_OPTIONS-packages/minerender/src/model/block/scene/BlockObject.ts:33

Accessors ​

blockEntities ​

Get Signature ​

ts
get blockEntities(): readonly EntityObject[];

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

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

Returns ​

readonly EntityObject[]


cullMask ​

Get Signature ​

ts
get cullMask(): number;

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

World-space face mask currently applied to this block.

Returns ​

number


fluidKind ​

Get Signature ​

ts
get fluidKind(): FluidKind | undefined;

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

Returns ​

FluidKind | undefined


fluidLevel ​

Get Signature ​

ts
get fluidLevel(): number;

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

Returns ​

number


instanceCounter ​

Get Signature ​

ts
get instanceCounter(): number;

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

Number of live placements, excluding released instance slots.

Returns ​

number

Inherited from ​

SceneObject.instanceCounter


isInstanced ​

Get Signature ​

ts
get isInstanced(): boolean;

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

Returns ​

boolean

Inherited from ​

SceneObject.isInstanced


isOccluding ​

Get Signature ​

ts
get isOccluding(): boolean;

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

Returns ​

boolean


models ​

Get Signature ​

ts
get models(): readonly (
  | ModelObject
  | InstanceReference<ModelObject>)[];

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

Model placements drawn for this block, including its fluid surface.

Returns ​

readonly ( | ModelObject | InstanceReference<ModelObject>)[]


scene ​

Get Signature ​

ts
get scene(): MineRenderScene;

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

Returns ​

MineRenderScene

Set Signature ​

ts
set scene(scene): void;

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

Parameters ​
ParameterType
sceneMineRenderScene
Returns ​

void

Inherited from ​

SceneObject.scene


state ​

Get Signature ​

ts
get state(): object;

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

Selected property values. Use setState to change properties and rebuild the rendered models.

Returns ​

object

Methods ​

dispose() ​

ts
dispose(): void;

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

Frees the GPU-related resources allocated by this instance.

Returns ​

void

Remarks ​

Call this method whenever this instance is no longer used in your app. Geometries, materials and textures are potentially shared with other 3D objects and must be disposed of separately.

Overrides ​

SceneObject.dispose


disposeAndRemoveAllChildren() ​

ts
disposeAndRemoveAllChildren(): void;

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

Releases instance slots and removes children, disposing children that implement Disposable.

Returns ​

void

Inherited from ​

SceneObject.disposeAndRemoveAllChildren


getGroupByName() ​

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

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

Finds a named part, such as head, without the internal group: prefix. Returns undefined when the group does not exist.

Parameters ​

ParameterType
namestring

Returns ​

Maybe<Object3D<Object3DEventMap>>

Inherited from ​

SceneObject.getGroupByName


getInstanceReference() ​

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

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

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

Parameters ​

ParameterType
meshObject3D
indexnumber

Returns ​

Maybe<InstanceReference<SceneObject>>

Inherited from ​

SceneObject.getInstanceReference


getMatrixAt() ​

ts
getMatrixAt(index, matrix?): Matrix4;

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

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

Matrix4

Overrides ​

SceneObject.getMatrixAt


getMeshByName() ​

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

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

Finds a named mesh without the internal mesh: prefix, or returns undefined.

Parameters ​

ParameterType
namestring

Returns ​

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

Inherited from ​

SceneObject.getMeshByName


getPosition() ​

ts
getPosition(): Vector3;

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

Returns ​

Vector3

Inherited from ​

SceneObject.getPosition


getPositionAt() ​

ts
getPositionAt(index, vector?): Vector3;

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

Parameters ​

ParameterType
indexnumber
vectorVector3

Returns ​

Vector3

Inherited from ​

SceneObject.getPositionAt


getRotation() ​

ts
getRotation(): Euler;

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

Returns ​

Euler

Inherited from ​

SceneObject.getRotation


getRotationAt() ​

ts
getRotationAt(index, euler?): Euler;

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

Parameters ​

ParameterType
indexnumber
eulerEuler

Returns ​

Euler

Inherited from ​

SceneObject.getRotationAt


getScale() ​

ts
getScale(): Vector3;

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

Returns ​

Vector3

Inherited from ​

SceneObject.getScale


getScaleAt() ​

ts
getScaleAt(index, vector?): Vector3;

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

Parameters ​

ParameterType
indexnumber
vectorVector3

Returns ​

Vector3

Inherited from ​

SceneObject.getScaleAt


init() ​

ts
init(): Promise<void>;

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

Returns ​

Promise<void>

Overrides ​

SceneObject.init


isInstanceActive() ​

ts
isInstanceActive(index, reference): boolean;

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

Parameters ​

ParameterType
indexnumber
referenceInstanceReference<Instanceable>

Returns ​

boolean

Inherited from ​

SceneObject.isInstanceActive


iterateAllMeshes() ​

ts
iterateAllMeshes(cb): void;

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

Parameters ​

ParameterType
cb(mesh) => void

Returns ​

void

Inherited from ​

SceneObject.iterateAllMeshes


nextInstance() ​

ts
nextInstance(): InstanceReference<SceneObject>;

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

Allocates a placement of this instanced object, reusing a released slot when available.

Returns ​

InstanceReference<SceneObject>

Overrides ​

SceneObject.nextInstance


notifyDirty() ​

ts
notifyDirty(): void;

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

Marks ancestor scenes for redraw and emits a change event.

Returns ​

void

Inherited from ​

SceneObject.notifyDirty


recreateModels() ​

ts
recreateModels(): Promise<void>;

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

Returns ​

Promise<void>


removeFromScene() ​

ts
removeFromScene(): void;

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

Detaches the object from its parent and requests a redraw.

Returns ​

void

Overrides ​

SceneObject.removeFromScene


removeInstanceAt() ​

ts
removeInstanceAt(index): void;

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

Parameters ​

ParameterType
indexnumber

Returns ​

void

Inherited from ​

SceneObject.removeInstanceAt


resetState() ​

ts
resetState(): Promise<void>;

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

Clears selected properties and rebuilds models without reapplying property defaults.

Returns ​

Promise<void>


setCullMask() ​

ts
setCullMask(worldMask): Promise<void>;

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

Parameters ​

ParameterType
worldMasknumber

Returns ​

Promise<void>


setInstanceVisibleAt() ​

ts
setInstanceVisibleAt(index, visible): void;

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

Parameters ​

ParameterType
indexnumber
visibleboolean

Returns ​

void

Inherited from ​

SceneObject.setInstanceVisibleAt


setMatrixAt() ​

ts
setMatrixAt(index, matrix): void;

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

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

void

Overrides ​

SceneObject.setMatrixAt


setPosition() ​

ts
setPosition(position): void;

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

Sets position in scene units. For a shared model, updates every live instance.

Parameters ​

ParameterType
positionVector3

Returns ​

void

Overrides ​

SceneObject.setPosition


setPositionAt() ​

ts
setPositionAt(index, position): void;

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

Parameters ​

ParameterType
indexnumber
positionVector3

Returns ​

void

Inherited from ​

SceneObject.setPositionAt


setPositionRotationScale() ​

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

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

Updates supplied transform components. For a shared model, affects every live instance.

Parameters ​

ParameterType
position?Vector3
rotation?Euler
scale?Vector3

Returns ​

void

Inherited from ​

SceneObject.setPositionRotationScale


setPositionRotationScaleAt() ​

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

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

Parameters ​

ParameterType
indexnumber
position?Vector3
rotation?Euler
scale?Vector3

Returns ​

void

Overrides ​

SceneObject.setPositionRotationScaleAt


setRotation() ​

ts
setRotation(rotation): void;

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

Sets rotation in radians. For a shared model, updates every live instance.

Parameters ​

ParameterType
rotationEuler

Returns ​

void

Inherited from ​

SceneObject.setRotation


setRotationAt() ​

ts
setRotationAt(index, rotation): void;

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

Parameters ​

ParameterType
indexnumber
rotationEuler

Returns ​

void

Inherited from ​

SceneObject.setRotationAt


setScale() ​

ts
setScale(scale): void;

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

Sets scale factors. For a shared model, updates every live instance.

Parameters ​

ParameterType
scaleVector3

Returns ​

void

Inherited from ​

SceneObject.setScale


setScaleAt() ​

ts
setScaleAt(index, scale): void;

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

Parameters ​

ParameterType
indexnumber
scaleVector3

Returns ​

void

Inherited from ​

SceneObject.setScaleAt


setState() ​

Call Signature ​

ts
setState(string): any;

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

Updates properties and rebuilds the selected models. Accepts "facing=north,open=true", a property object, or a key and value. Properties omitted from the call keep their current values.

Parameters ​
ParameterType
stringstring
Returns ​

any

Call Signature ​

ts
setState(state): any;

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

Updates properties and rebuilds the selected models. Accepts "facing=north,open=true", a property object, or a key and value. Properties omitted from the call keep their current values.

Parameters ​
ParameterType
stateBlockStateProperties
Returns ​

any

Call Signature ​

ts
setState(key, value): any;

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

Updates properties and rebuilds the selected models. Accepts "facing=north,open=true", a property object, or a key and value. Properties omitted from the call keep their current values.

Parameters ​
ParameterType
keystring
valuestring
Returns ​

any


setVisible() ​

ts
setVisible(visible): void;

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

Sets visibility for this block's model instances and block entities.

Parameters ​

ParameterType
visibleboolean

Returns ​

void


toggleGroupVisibility() ​

ts
toggleGroupVisibility(name, visible?): boolean;

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

Changes a named group's visibility and requests a redraw.

Parameters ​

ParameterTypeDescription
namestringPart name without the group: prefix.
visible?booleanVisibility to assign. Omit it to toggle the current value.

Returns ​

boolean

The resulting visibility, or false if the group does not exist.

Inherited from ​

SceneObject.toggleGroupVisibility


toggleMeshVisibility() ​

ts
toggleMeshVisibility(name, visible?): boolean;

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

Changes a named mesh's visibility and requests a redraw.

Parameters ​

ParameterTypeDescription
namestringMesh name without the mesh: prefix.
visible?booleanVisibility to assign. Omit it to toggle the current value.

Returns ​

boolean

The resulting visibility, or false if the mesh does not exist.

Inherited from ​

SceneObject.toggleMeshVisibility


updateFluid() ​

ts
updateFluid(sample?): Promise<void>;

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

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

Parameters ​

ParameterType
sample?FluidSampler

Returns ​

Promise<void>