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
new MineRenderScene(options?): MineRenderScene;Defined in: packages/minerender/src/renderer/MineRenderScene.ts:59
Parameters
| Parameter | Type |
|---|---|
options? | DeepPartial<MineRenderSceneOptions> |
Returns
MineRenderScene
Overrides
Scene.constructorProperties
| Property | Modifier | Type | Default value | Defined in |
|---|---|---|---|---|
dirty | public | boolean | true | packages/minerender/src/renderer/MineRenderScene.ts:50 |
isMineRenderScene | readonly | true | true | packages/minerender/src/renderer/MineRenderScene.ts:42 |
options | readonly | MineRenderSceneOptions | undefined | packages/minerender/src/renderer/MineRenderScene.ts:45 |
stats | readonly | SceneStats | undefined | packages/minerender/src/renderer/MineRenderScene.ts:47 |
DEFAULT_OPTIONS | readonly | MineRenderSceneOptions | undefined | packages/minerender/src/renderer/MineRenderScene.ts:44 |
Methods
add()
add(...objects): this;Defined in: packages/minerender/src/renderer/MineRenderScene.ts:64
Adds another Object3D as child of this Object3D.
Parameters
| Parameter | Type |
|---|---|
...objects | Object3D<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
Scene.addaddBlock()
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
| Parameter | Type |
|---|---|
blockState | BlockState |
options? | Partial<BlockObjectOptions> |
parent? | Object3D |
Returns
Promise< | BlockObject | InstanceReference<BlockObject>>
addEntity()
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
| Parameter | Type |
|---|---|
entity | EntityModel |
options? | Partial<EntityObjectOptions> |
parent? | Object3D |
Returns
Promise< | EntityObject | InstanceReference<EntityObject>>
addGui()
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
| Parameter | Type |
|---|---|
layers | readonly GuiLayer[] |
options? | Partial<GuiObjectOptions> |
parent? | Object3D |
Returns
Promise<GuiObject>
addModel()
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
| Parameter | Type | Description |
|---|---|---|
model | Model | - |
options? | Partial<ModelObjectOptions> | - |
parent? | Object3D | Object 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()
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
| Parameter | Type |
|---|---|
asset | A |
objectSupplier | () => T | Promise<T> |
_options? | Partial<O> |
parent? | Object3D |
Returns
Promise<T | InstanceReference<T>>
addSkin()
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
| Parameter | Type | Description |
|---|---|---|
skin? | string | Texture 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? | Object3D | Object to attach the player to. Defaults to this scene. |
Returns
Promise<SkinObject>
initAndAdd()
initAndAdd(...object): Promise<MineRenderScene>;Defined in: packages/minerender/src/renderer/MineRenderScene.ts:112
Initializes each object before attaching it to the scene.
Parameters
| Parameter | Type |
|---|---|
...object | SceneObject[] |
Returns
Promise<MineRenderScene>
remove()
remove(...objects): this;Defined in: packages/minerender/src/renderer/MineRenderScene.ts:79
Removes a Object3D as child of this Object3D.
Parameters
| Parameter | Type |
|---|---|
...objects | Object3D<Object3DEventMap>[] |
Returns
this
Remarks
An arbitrary number of objects may be removed.
See
THREE.Group | Group for info on manually grouping objects.
Overrides
Scene.removeInherited three.js API
Members inherited from Scene are documented by three.js. MineRender overrides are listed above.