Skip to content

Class: EntityObject ​

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:23

Renders selected entity layers as named part groups. Create it through MineRenderScene.addEntity.

Extends ​

Constructors ​

Constructor ​

ts
new EntityObject(entity, options?): EntityObject;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:41

Parameters ​

ParameterType
entityEntityModel
options?Partial<EntityObjectOptions>

Returns ​

EntityObject

Overrides ​

SceneObject.constructor

Properties ​

PropertyModifierTypeDefault valueDescriptionOverridesInherited fromDefined in
_instanceCounterpublicnumber0--SceneObject._instanceCounterpackages/minerender/src/renderer/SceneObject.ts:42
agepublicnumber0Entity age in ticks, as vanilla's ageInTicks; drives the scrolling render modes.--packages/minerender/src/entity/scene/EntityObject.ts:37
entityreadonlyEntityModelundefined---packages/minerender/src/entity/scene/EntityObject.ts:41
isEntityObjectreadonlytruetrue---packages/minerender/src/entity/scene/EntityObject.ts:25
isSceneObjectreadonlytruetrue--SceneObject.isSceneObjectpackages/minerender/src/renderer/SceneObject.ts:27
optionsreadonlyEntityObjectOptionsundefined-SceneObject.options-packages/minerender/src/entity/scene/EntityObject.ts:28
DEFAULT_OPTIONSreadonlyEntityObjectOptionsundefined-SceneObject.DEFAULT_OPTIONS-packages/minerender/src/entity/scene/EntityObject.ts:27

Accessors ​

activeAnimations ​

Get Signature ​

ts
get activeAnimations(): readonly EntityAnimation[];

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:113

Clips playing together, in the order passed to playAnimations.

Returns ​

readonly EntityAnimation[]


animation ​

Get Signature ​

ts
get animation(): Maybe<EntityAnimation>;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:108

The first active clip, until playback is stopped or the object is disposed.

Returns ​

Maybe<EntityAnimation>


animationTime ​

Get Signature ​

ts
get animationTime(): number;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:131

Seconds since the animation started, before looping.

Returns ​

number


animationWeights ​

Get Signature ​

ts
get animationWeights(): readonly number[];

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:122

Weights of the active clips, in the same order as activeAnimations.

Returns ​

readonly 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


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

Methods ​

advanceAnimation() ​

ts
advanceAnimation(deltaSeconds): void;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:196

Advances the animation by a frame delta in seconds, scaled by its speed. Has no effect without an animation.

Parameters ​

ParameterType
deltaSecondsnumber

Returns ​

void


dispose() ​

ts
dispose(): void;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:58

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/entity/scene/EntityObject.ts:62

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

Returns ​

void

Overrides ​

SceneObject.disposeAndRemoveAllChildren


getGroupByName() ​

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

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:209

Finds a part name without group:. Supply layerName to restrict the search to one draw.

Parameters ​

ParameterType
namestring
layerName?string

Returns ​

Maybe<Object3D<Object3DEventMap>>

Overrides ​

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


getLayerGroup() ​

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

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:204

Finds a selected draw by its layer key, such as main or main#2, or returns undefined.

Parameters ​

ParameterType
namestring

Returns ​

Maybe<Object3D<Object3DEventMap>>


getMatrixAt() ​

ts
getMatrixAt(index, matrix?): Matrix4;

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

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

Matrix4

Inherited from ​

SceneObject.getMatrixAt


getMeshByName() ​

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

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:215

Finds a mesh name without mesh:. Supply layerName to restrict the search to one draw.

Parameters ​

ParameterType
namestring
layerName?string

Returns ​

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

Overrides ​

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(material?): Promise<void>;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:49

An optional shared material replaces texture loading for every selected draw; its owner retains disposal.

Parameters ​

ParameterType
material?Material<MaterialEventMap>

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/renderer/SceneObject.ts:255

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

Returns ​

InstanceReference<SceneObject>

Inherited from ​

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


playAnimation() ​

ts
playAnimation(animation, options?): void;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:141

Plays a clip from Entities.getAnimations, replacing all active clips. Offsets apply to the baked pose in the clip's layer (main by default) and its repeated draws. A main clip also poses every selected layer without a clip of its own. The object owns no clock: call advanceAnimation per frame, or setAnimationTime.

Parameters ​

ParameterType
animationEntityAnimation
options?EntityAnimationOptions

Returns ​

void


playAnimations() ​

ts
playAnimations(animations, options?): void;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:149

Plays clips with a shared clock, adding their weighted offsets within each geometry layer. Weights default to 1 and are not normalized. Selected layers without their own clip follow main.

Parameters ​

ParameterType
animationsreadonly EntityAnimation[]
options?EntityAnimationOptions

Returns ​

void


removeFromScene() ​

ts
removeFromScene(): void;

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

Detaches the object from its parent and requests a redraw.

Returns ​

void

Inherited from ​

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


setAnimationTime() ​

ts
setAnimationTime(seconds): void;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:190

Poses the object at an explicit time in seconds. Has no effect without an animation.

Parameters ​

ParameterType
secondsnumber

Returns ​

void


setAnimationWeights() ​

ts
setAnimationWeights(weights): void;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:175

Changes weights in active clip order, notifying the scene without restarting the shared clock. Has no effect without an animation.

Parameters ​

ParameterType
weightsreadonly number[]

Returns ​

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/renderer/SceneObject.ts:333

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

void

Inherited from ​

SceneObject.setMatrixAt


setPosition() ​

ts
setPosition(position): void;

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

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

Parameters ​

ParameterType
positionVector3

Returns ​

void

Inherited from ​

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/renderer/SceneObject.ts:368

Parameters ​

ParameterType
indexnumber
position?Vector3
rotation?Euler
scale?Vector3

Returns ​

void

Inherited from ​

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


stopAnimation() ​

ts
stopAnimation(): void;

Defined in: packages/minerender/src/entity/scene/EntityObject.ts:183

Stops all clips and restores the poses from before playback.

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