Class: MineRenderScene

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

Extends

• Scene

Constructors

Constructor

new MineRenderScene(options?): MineRenderScene;

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

Parameters

Parameter	Type
options?	DeepPartial<MineRenderSceneOptions>

Returns

MineRenderScene

Overrides

Scene.constructor

Properties

Property	Modifier	Type	Default value	Defined in
dirty	public	boolean	true	packages/minerender/src/renderer/MineRenderScene.ts:31
isMineRenderScene	readonly	true	true	packages/minerender/src/renderer/MineRenderScene.ts:23
options	readonly	MineRenderSceneOptions	undefined	packages/minerender/src/renderer/MineRenderScene.ts:26
stats	readonly	SceneStats	undefined	packages/minerender/src/renderer/MineRenderScene.ts:28
DEFAULT_OPTIONS	readonly	MineRenderSceneOptions	undefined	packages/minerender/src/renderer/MineRenderScene.ts:25

Methods

add()

add(...objects): this;

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

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

See

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

Overrides

Scene.add

---

addBlock()

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

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

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:157

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:161

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:137

Parameters

Parameter	Type
model	Model
options?	Partial<ModelObjectOptions>
parent?	Object3D

Returns

Promise< | ModelObject | InstanceReference<ModelObject>>

---

addSceneObject()

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

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

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:145

Parameters

Parameter	Type
skin?	string
options?	Partial<SkinObjectOptions>
parent?	Object3D

Returns

Promise<SkinObject>

---

initAndAdd()

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

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

Parameters

Parameter	Type
...object	SceneObject[]

Returns

Promise<MineRenderScene>

---

remove()

remove(...objects): this;

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

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.remove

Inherited three.js API

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