Mirror Engine API / ComponentSystemRegistry
Class: ComponentSystemRegistry
Store, access and delete instances of the various ComponentSystems.
Extends
Constructors
new ComponentSystemRegistry()
new ComponentSystemRegistry(): ComponentSystemRegistry
Create a new ComponentSystemRegistry instance.
Returns
Overrides
EventHandler.constructor
Properties
anim
readonly anim: undefined | AnimComponentSystem;
Gets the AnimComponentSystem from the registry.
animation
readonly animation: undefined | AnimationComponentSystem;
Gets the AnimationComponentSystem from the registry.
audiolistener
readonly audiolistener: undefined | AudioListenerComponentSystem;
Gets the AudioListenerComponentSystem from the registry.
button
readonly button: undefined | ButtonComponentSystem;
Gets the ButtonComponentSystem from the registry.
camera
readonly camera: undefined | CameraComponentSystem;
Gets the CameraComponentSystem from the registry.
collision
readonly collision: undefined | CollisionComponentSystem;
Gets the CollisionComponentSystem from the registry.
element
readonly element: undefined | ElementComponentSystem;
Gets the ElementComponentSystem from the registry.
layoutchild
readonly layoutchild: undefined | LayoutChildComponentSystem;
Gets the LayoutChildComponentSystem from the registry.
layoutgroup
readonly layoutgroup: undefined | LayoutGroupComponentSystem;
Gets the LayoutGroupComponentSystem from the registry.
light
readonly light: undefined | LightComponentSystem;
Gets the LightComponentSystem from the registry.
model
readonly model: undefined | ModelComponentSystem;
Gets the ModelComponentSystem from the registry.
particlesystem
readonly particlesystem: undefined | ParticleSystemComponentSystem;
Gets the ParticleSystemComponentSystem from the registry.
render
readonly render: undefined | RenderComponentSystem;
Gets the RenderComponentSystem from the registry.
rigidbody
readonly rigidbody: undefined | RigidBodyComponentSystem;
Gets the RigidBodyComponentSystem from the registry.
screen
readonly screen: undefined | ScreenComponentSystem;
Gets the ScreenComponentSystem from the registry.
script
readonly script: undefined | ScriptComponentSystem;
Gets the ScriptComponentSystem from the registry.
scrollbar
readonly scrollbar: undefined | ScrollbarComponentSystem;
Gets the ScrollbarComponentSystem from the registry.
scrollview
readonly scrollview: undefined | ScrollViewComponentSystem;
Gets the ScrollViewComponentSystem from the registry.
sound
readonly sound: undefined | SoundComponentSystem;
Gets the SoundComponentSystem from the registry.
sprite
readonly sprite: undefined | SpriteComponentSystem;
Gets the SpriteComponentSystem from the registry.
Methods
fire()
fire(
name: string,
arg1?: any,
arg2?: any,
arg3?: any,
arg4?: any,
arg5?: any,
arg6?: any,
arg7?: any,
arg8?: any): EventHandler
Fire an event, all additional arguments are passed on to the event listener.
Parameters
name
string
Name of event to fire.
arg1?
any
First argument that is passed to the event handler.
arg2?
any
Second argument that is passed to the event handler.
arg3?
any
Third argument that is passed to the event handler.
arg4?
any
Fourth argument that is passed to the event handler.
arg5?
any
Fifth argument that is passed to the event handler.
arg6?
any
Sixth argument that is passed to the event handler.
arg7?
any
Seventh argument that is passed to the event handler.
arg8?
any
Eighth argument that is passed to the event handler.
Returns
Self for chaining.
Example
obj.fire('test', 'This is the message')
Inherited from
hasEvent()
hasEvent(name: string): boolean
Test if there are any handlers bound to an event name.
Parameters
name
string
The name of the event to test.
Returns
boolean
True if the object has handlers bound to the specified event name.
Example
obj.on('test', () => {}) // bind an event to 'test'
obj.hasEvent('test') // returns true
obj.hasEvent('hello') // returns false
Inherited from
off()
off(
name?: string,
callback?: HandleEventCallback,
scope?: any): EventHandler
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.
Parameters
name?
string
Name of the event to unbind.
callback?
HandleEventCallback
Function to be unbound.
scope?
any
Scope that was used as the this when the event is fired.
Returns
Self for chaining.
Example
const handler = () => {}
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 handler functions, called 'test' with scope this
Inherited from
on()
on(
name: string,
callback: HandleEventCallback,
scope?: any): EventHandle
Attach an event handler to an event.
Parameters
name
string
Name of the event to bind the callback to.
callback
HandleEventCallback
Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope?
any = ...
Object to use as 'this' when the event is fired, defaults to current this.
Returns
Can be used for removing event in the future.
Examples
obj.on('test', (a, b) => {
console.log(a + b)
})
obj.fire('test', 1, 2) // prints 3 to the console
const evt = obj.on('test', (a, b) => {
console.log(a + b)
})
// some time later
evt.off()
Inherited from
once()
once(
name: string,
callback: HandleEventCallback,
scope?: any): EventHandle
Attach an event handler to an event. This handler will be removed after being fired once.
Parameters
name
string
Name of the event to bind the callback to.
callback
HandleEventCallback
Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope?
any = ...
Object to use as 'this' when the event is fired, defaults to current this.
Returns
- can be used for removing event in the future.
Example
obj.once('test', (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