Skip to content

Class: MineRenderScene ​

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:40

A Three.js scene that initializes Minecraft objects and tracks changes that need a redraw.

Extends ​

  • Scene

Constructors ​

Constructor ​

ts
new MineRenderScene(options?): MineRenderScene;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:59

Parameters ​

ParameterType
options?DeepPartial<MineRenderSceneOptions>

Returns ​

MineRenderScene

Overrides ​

ts
Scene.constructor

Properties ​

PropertyModifierTypeDefault valueDefined in
dirtypublicbooleantruepackages/minerender/src/renderer/MineRenderScene.ts:50
isMineRenderScenereadonlytruetruepackages/minerender/src/renderer/MineRenderScene.ts:42
optionsreadonlyMineRenderSceneOptionsundefinedpackages/minerender/src/renderer/MineRenderScene.ts:45
statsreadonlySceneStatsundefinedpackages/minerender/src/renderer/MineRenderScene.ts:47
DEFAULT_OPTIONSreadonlyMineRenderSceneOptionsundefinedpackages/minerender/src/renderer/MineRenderScene.ts:44

Methods ​

add() ​

ts
add(...objects): this;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:64

Adds another Object3D as child of this Object3D.

Parameters ​

ParameterType
...objectsObject3D<Object3DEventMap>[]

Returns ​

this

Remarks ​

An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

See ​

  • attach
  • THREE.Group | Group for info on manually grouping objects.

Overrides ​

ts
Scene.add

addBlock() ​

ts
addBlock(
   blockState, 
   options?, 
   parent?
): Promise<
  | BlockObject
| InstanceReference<BlockObject>>;

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

Adds the models selected by a blockstate loaded with BlockStates.get. Set options.initialState to choose block properties such as facing or axis. Use the returned object's setPosition method to move all of its model parts.

Parameters ​

ParameterType
blockStateBlockState
options?Partial<BlockObjectOptions>
parent?Object3D

Returns ​

Promise< | BlockObject | InstanceReference<BlockObject>>


addEntity() ​

ts
addEntity(
   entity, 
   options?, 
   parent?
): Promise<
  | EntityObject
| InstanceReference<EntityObject>>;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:205

Adds an entity loaded with Entities.getEntity, using its selected layers and textures.

Parameters ​

ParameterType
entityEntityModel
options?Partial<EntityObjectOptions>
parent?Object3D

Returns ​

Promise< | EntityObject | InstanceReference<EntityObject>>


addGui() ​

ts
addGui(
   layers, 
   options?, 
   parent?
): Promise<GuiObject>;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:214

Adds GUI layers in draw order. One GUI pixel equals one scene unit. Layer positions start at the top left, with positive GUI y pointing down.

Parameters ​

ParameterType
layersreadonly GuiLayer[]
options?Partial<GuiObjectOptions>
parent?Object3D

Returns ​

Promise<GuiObject>


addModel() ​

ts
addModel(
   model, 
   options?, 
   parent?
): Promise<
  | ModelObject
| InstanceReference<ModelObject>>;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:169

Adds a model loaded with Models.getMerged. Set options.instanceMeshes to false to create a separate ModelObject.

Parameters ​

ParameterTypeDescription
modelModel-
options?Partial<ModelObjectOptions>-
parent?Object3DObject to attach the model to. Defaults to this scene.

Returns ​

Promise< | ModelObject | InstanceReference<ModelObject>>

The model, or a reference to one placement of a shared model.


addSceneObject() ​

ts
addSceneObject<A, T, O>(
   asset, 
   objectSupplier, 
   _options?, 
   parent?
): Promise<T | InstanceReference<T>>;

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

Type Parameters ​

Type Parameter
A extends BasicMinecraftAsset
T extends SceneObject
O extends SceneObjectOptions

Parameters ​

ParameterType
assetA
objectSupplier() => T | Promise<T>
_options?Partial<O>
parent?Object3D

Returns ​

Promise<T | InstanceReference<T>>


addSkin() ​

ts
addSkin(
   skin?, 
   options?, 
   parent?
): Promise<SkinObject>;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:192

Loads a skin and adds an initialized player model.

Parameters ​

ParameterTypeDescription
skin?stringTexture URL, such as one returned by Skins.fromUuidOrUsername. Omit it to assign a texture later with SkinObject.setSkinTexture.
options?Partial<SkinObjectOptions>Player settings, including slim and legacy detection overrides.
parent?Object3DObject to attach the player to. Defaults to this scene.

Returns ​

Promise<SkinObject>


initAndAdd() ​

ts
initAndAdd(...object): Promise<MineRenderScene>;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:112

Initializes each object before attaching it to the scene.

Parameters ​

ParameterType
...objectSceneObject[]

Returns ​

Promise<MineRenderScene>


remove() ​

ts
remove(...objects): this;

Defined in: packages/minerender/src/renderer/MineRenderScene.ts:79

Removes a Object3D as child of this Object3D.

Parameters ​

ParameterType
...objectsObject3D<Object3DEventMap>[]

Returns ​

this

Remarks ​

An arbitrary number of objects may be removed.

See ​

THREE.Group | Group for info on manually grouping objects.

Overrides ​

ts
Scene.remove

Inherited three.js API ​

Members inherited from Scene are documented by three.js. MineRender overrides are listed above.