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
new BlockObject(blockState, options?): BlockObject;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:60
Parameters
| Parameter | Type |
|---|---|
blockState | BlockState |
options? | Partial<BlockObjectOptions> |
Returns
BlockObject
Overrides
Properties
| Property | Modifier | Type | Default value | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|---|
_instanceCounter | public | number | 0 | - | SceneObject._instanceCounter | packages/minerender/src/renderer/SceneObject.ts:42 |
blockState | readonly | BlockState | undefined | - | - | packages/minerender/src/model/block/scene/BlockObject.ts:60 |
isBlockObject | readonly | true | true | - | - | packages/minerender/src/model/block/scene/BlockObject.ts:31 |
isSceneObject | readonly | true | true | - | SceneObject.isSceneObject | packages/minerender/src/renderer/SceneObject.ts:27 |
options | readonly | BlockObjectOptions | undefined | SceneObject.options | - | packages/minerender/src/model/block/scene/BlockObject.ts:36 |
DEFAULT_OPTIONS | readonly | BlockObjectOptions | undefined | SceneObject.DEFAULT_OPTIONS | - | packages/minerender/src/model/block/scene/BlockObject.ts:33 |
Accessors
blockEntities
Get Signature
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
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
get fluidKind(): FluidKind | undefined;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:265
Returns
FluidKind | undefined
fluidLevel
Get Signature
get fluidLevel(): number;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:269
Returns
number
instanceCounter
Get Signature
get instanceCounter(): number;Defined in: packages/minerender/src/renderer/SceneObject.ts:246
Number of live placements, excluding released instance slots.
Returns
number
Inherited from
isInstanced
Get Signature
get isInstanced(): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:241
Returns
boolean
Inherited from
isOccluding
Get Signature
get isOccluding(): boolean;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:185
Returns
boolean
models
Get Signature
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
get scene(): MineRenderScene;Defined in: packages/minerender/src/renderer/SceneObject.ts:58
Returns
Set Signature
set scene(scene): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:53
Parameters
| Parameter | Type |
|---|---|
scene | MineRenderScene |
Returns
void
Inherited from
state
Get Signature
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()
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
disposeAndRemoveAllChildren()
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()
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
| Parameter | Type |
|---|---|
name | string |
Returns
Maybe<Object3D<Object3DEventMap>>
Inherited from
getInstanceReference()
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
| 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:495
Parameters
| Parameter | Type |
|---|---|
index | number |
matrix | Matrix4 |
Returns
Matrix4
Overrides
getMeshByName()
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
| Parameter | Type |
|---|---|
name | string |
Returns
Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>
Inherited from
getPosition()
getPosition(): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:457
Returns
Vector3
Inherited from
getPositionAt()
getPositionAt(index, vector?): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:394
Parameters
| Parameter | Type |
|---|---|
index | number |
vector | Vector3 |
Returns
Vector3
Inherited from
getRotation()
getRotation(): Euler;Defined in: packages/minerender/src/renderer/SceneObject.ts:477
Returns
Euler
Inherited from
getRotationAt()
getRotationAt(index, euler?): Euler;Defined in: packages/minerender/src/renderer/SceneObject.ts:406
Parameters
| Parameter | Type |
|---|---|
index | number |
euler | Euler |
Returns
Euler
Inherited from
getScale()
getScale(): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:497
Returns
Vector3
Inherited from
getScaleAt()
getScaleAt(index, vector?): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:418
Parameters
| Parameter | Type |
|---|---|
index | number |
vector | Vector3 |
Returns
Vector3
Inherited from
init()
init(): Promise<void>;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:68
Returns
Promise<void>
Overrides
isInstanceActive()
isInstanceActive(index, reference): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:278
Parameters
| Parameter | Type |
|---|---|
index | number |
reference | InstanceReference<Instanceable> |
Returns
boolean
Inherited from
iterateAllMeshes()
iterateAllMeshes(cb): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:193
Parameters
| Parameter | Type |
|---|---|
cb | (mesh) => void |
Returns
void
Inherited from
nextInstance()
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
notifyDirty()
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
recreateModels()
recreateModels(): Promise<void>;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:321
Returns
Promise<void>
removeFromScene()
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
removeInstanceAt()
removeInstanceAt(index): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:282
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
void
Inherited from
resetState()
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()
setCullMask(worldMask): Promise<void>;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:218
Parameters
| Parameter | Type |
|---|---|
worldMask | number |
Returns
Promise<void>
setInstanceVisibleAt()
setInstanceVisibleAt(index, visible): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:347
Parameters
| Parameter | Type |
|---|---|
index | number |
visible | boolean |
Returns
void
Inherited from
SceneObject.setInstanceVisibleAt
setMatrixAt()
setMatrixAt(index, matrix): void;Defined in: packages/minerender/src/model/block/scene/BlockObject.ts:515
Parameters
| Parameter | Type |
|---|---|
index | number |
matrix | Matrix4 |
Returns
void
Overrides
setPosition()
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
| Parameter | Type |
|---|---|
position | Vector3 |
Returns
void
Overrides
setPositionAt()
setPositionAt(index, position): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:389
Parameters
| Parameter | Type |
|---|---|
index | number |
position | Vector3 |
Returns
void
Inherited from
setPositionRotationScale()
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
| 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:491
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:466
Sets rotation in radians. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
rotation | Euler |
Returns
void
Inherited from
setRotationAt()
setRotationAt(index, rotation): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:401
Parameters
| Parameter | Type |
|---|---|
index | number |
rotation | Euler |
Returns
void
Inherited from
setScale()
setScale(scale): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:486
Sets scale factors. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
scale | Vector3 |
Returns
void
Inherited from
setScaleAt()
setScaleAt(index, scale): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:413
Parameters
| Parameter | Type |
|---|---|
index | number |
scale | Vector3 |
Returns
void
Inherited from
setState()
Call Signature
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
| Parameter | Type |
|---|---|
string | string |
Returns
any
Call Signature
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
| Parameter | Type |
|---|---|
state | BlockStateProperties |
Returns
any
Call Signature
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
| Parameter | Type |
|---|---|
key | string |
value | string |
Returns
any
setVisible()
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
| Parameter | Type |
|---|---|
visible | boolean |
Returns
void
toggleGroupVisibility()
toggleGroupVisibility(name, visible?): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:120
Changes a named group's visibility and requests a redraw.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Part name without the group: prefix. |
visible? | boolean | Visibility 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()
toggleMeshVisibility(name, visible?): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:189
Changes a named mesh's visibility and requests a redraw.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Mesh name without the mesh: prefix. |
visible? | boolean | Visibility 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()
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
| Parameter | Type |
|---|---|
sample? | FluidSampler |
Returns
Promise<void>