ScreenComponent(system, entity) 

Create a new ScreenComponent.

Parameters

system	ScreenComponentSystem	The ComponentSystem that created this Component.
entity	Entity	The Entity that this Component is attached to.

booleancull 

If true then elements inside this screen will be not be rendered when outside of the screen (only valid when screenSpace is true).

numberpriority 

Priority determines the order in which Screen components in the same layer are rendered. Number must be an integer between 0 and 255. Priority is set into the top 8 bits of the drawOrder property in an element.

Vec2referenceResolution 

The resolution that the ScreenComponent is designed for. This is only taken into account when screenSpace is true and scaleMode is SCALEMODE_BLEND. If the actual resolution is different then the ScreenComponent will be scaled according to the scaleBlend value.

Vec2resolution 

The width and height of the ScreenComponent. When screenSpace is true the resolution will always be equal to GraphicsDevice#width x GraphicsDevice#height.

numberscaleBlend 

A value between 0 and 1 that is used when scaleMode is equal to SCALEMODE_BLEND. Scales the ScreenComponent with width as a reference (when value is 0), the height as a reference (when value is 1) or anything in between.

stringscaleMode 

Can either be SCALEMODE_NONE or SCALEMODE_BLEND. See the description of referenceResolution for more information.

booleanscreenSpace 

If true then the ScreenComponent will render its child ElementComponents in screen space instead of world space. Enable this to create 2D user interfaces.

syncDrawOrder() 

Set the drawOrder of each child ElementComponent so that ElementComponents which are last in the hierarchy are rendered on top. Draw Order sync is queued and will be updated by the next update loop.

booleanenabled 

Enables or disables the component.

Entityentity 

The Entity that this Component is attached to.

ComponentSystemsystem 

The ComponentSystem used to create this Component.

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

name	string	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

name

string

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.

const 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 handler functions, called 'test' with scope this

Parameters

name	string	Name of the event to unbind.
callback	HandleEventCallback	Function to be unbound.
scope	object	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

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	object	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

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	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.