API Reference

Class List

RenderComponent

Extends: Component

Enables an Entity to render a Mesh or a primitive shape. This component attaches MeshInstance geometry to the Entity.

Summary

Properties

asset

The render asset for the render component (only applies to type 'asset') - can also be an asset id.

batchGroupId

Assign meshes to a specific batch group (see BatchGroup).

castShadows

If true, attached meshes will cast shadows for lights that have shadow casting enabled.

castShadowsLightmap

If true, the meshes will cast shadows when rendering lightmaps.

customAabb

If set, the object space bounding box is used as a bounding box for visibility culling of attached mesh instances.

isStatic

Mark meshes as non-movable (optimization).

layers

An array of layer IDs (Layer#id) to which the meshes should belong.

lightmapSizeMultiplier

Lightmap resolution multiplier.

lightmapped

If true, the meshes will be lightmapped after using lightmapper.

material

The material Material that will be used to render the meshes (not used on renders of type 'asset').

materialAssets

The material assets that will be used to render the meshes.

meshInstances

An array of meshInstances contained in the component.

receiveShadows

If true, shadows will be cast on attached meshes.

renderStyle

Set rendering of all MeshInstances to the specified render style.

rootBone

A reference to the entity to be used as the root bone for any skinned meshes that are rendered by this component.

type

The type of the render.

Methods

hide

Stop rendering MeshInstances without removing them from the scene hierarchy.

show

Enable rendering of the render MeshInstances if hidden using RenderComponent#hide.

Inherited

Properties

enabled

Enables or disables the component.

entity

The Entity that this Component is attached to.

system

The ComponentSystem used to create this Component.

Methods

fire

Fire an event, all additional arguments are passed on to the event listener.

hasEvent

Test if there are any handlers bound to an event name.

off

Detach an event handler from an event.

on

Attach an event handler to an event.

once

Attach an event handler to an event.

Details

Constructor

RenderComponent(system, entity)

Create a new RenderComponent.

Parameters

systemRenderComponentSystem

The ComponentSystem that created this Component.

entityEntity

The Entity that this Component is attached to.

Properties

Asset, numberasset

The render asset for the render component (only applies to type 'asset') - can also be an asset id.

numberbatchGroupId

Assign meshes to a specific batch group (see BatchGroup). Default value is -1 (no group).

booleancastShadows

If true, attached meshes will cast shadows for lights that have shadow casting enabled.

booleancastShadowsLightmap

If true, the meshes will cast shadows when rendering lightmaps.

BoundingBoxcustomAabb

If set, the object space bounding box is used as a bounding box for visibility culling of attached mesh instances. This is an optimization, allowing oversized bounding box to be specified for skinned characters in order to avoid per frame bounding box computations based on bone positions.

booleanisStatic

Mark meshes as non-movable (optimization).

number[]layers

An array of layer IDs (Layer#id) to which the meshes should belong. Don't push/pop/splice or modify this array, if you want to change it - set a new one instead.

numberlightmapSizeMultiplier

Lightmap resolution multiplier.

booleanlightmapped

If true, the meshes will be lightmapped after using lightmapper.bake().

Materialmaterial

The material Material that will be used to render the meshes (not used on renders of type 'asset').

Asset[], number[]materialAssets

The material assets that will be used to render the meshes. Each material corresponds to the respective mesh instance.

MeshInstance[]meshInstances

An array of meshInstances contained in the component. If meshes are not set or loaded for component it will return null.

booleanreceiveShadows

If true, shadows will be cast on attached meshes.

numberrenderStyle

Set rendering of all MeshInstances to the specified render style. Can be one of the following:

EntityrootBone

A reference to the entity to be used as the root bone for any skinned meshes that are rendered by this component.

stringtype

The type of the render. Can be one of the following:

  • "asset": The component will render a render asset
  • "box": The component will render a box (1 unit in each dimension)
  • "capsule": The component will render a capsule (radius 0.5, height 2)
  • "cone": The component will render a cone (radius 0.5, height 1)
  • "cylinder": The component will render a cylinder (radius 0.5, height 1)
  • "plane": The component will render a plane (1 unit in each dimension)
  • "sphere": The component will render a sphere (radius 0.5)

Methods

hide()

Stop rendering MeshInstances without removing them from the scene hierarchy. This method sets the MeshInstance#visible property of every MeshInstance to false. Note, this does not remove the mesh instances from the scene hierarchy or draw call list. So the render component still incurs some CPU overhead.

show()

Enable rendering of the render MeshInstances if hidden using RenderComponent#hide. This method sets all the MeshInstance#visible property on all mesh instances to true.

Inherited

Properties

booleanenabled

Enables or disables the component.

Entityentity

The Entity that this Component is attached to.

ComponentSystemsystem

The ComponentSystem used to create this Component.

Methods

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

nameobject

Name of event to fire.

arg1*

First argument that is passed to the event handler.

arg2*

Second argument that is passed to the event handler.

arg3*

Third argument that is passed to the event handler.

arg4*

Fourth argument that is passed to the event handler.

arg5*

Fifth argument that is passed to the event handler.

arg6*

Sixth argument that is passed to the event handler.

arg7*

Seventh argument that is passed to the event handler.

arg8*

Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name)

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

namestring

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope])

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all hander functions, called 'test' with scope this

Parameters

namestring

Name of the event to unbind.

callbackcallbacks.HandleEvent

Function to be unbound.

scopeobject

Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope])

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

namestring

Name of the event to bind the callback to.

callbackcallbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.

once(name, callback, [scope])

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

namestring

Name of the event to bind the callback to.

callbackcallbacks.HandleEvent

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.