API Reference

Class List

pc.ButtonComponent

Extends: pc.Component

A ButtonComponent enables a group of entities to behave like a button, with different visual states for hover and press interactions.

Summary

Properties

activeIf set to false, the button will be visible but will not respond to hover or touch interactions.
fadeDurationDuration to be used when fading between tints, in milliseconds.
hitPaddingPadding to be used in hit-test calculations.
hoverSpriteAssetSprite to be used as the button image when the user hovers over it.
hoverSpriteFrameFrame to be used from the hover sprite.
hoverTintColor to be used on the button image when the user hovers over it.
imageEntityA reference to the entity to be used as the button background.
inactiveSpriteAssetSprite to be used as the button image when the button is not interactive.
inactiveSpriteFrameFrame to be used from the inactive sprite.
inactiveTintColor to be used on the button image when the button is not interactive.
pressedSpriteAssetSprite to be used as the button image when the user presses it.
pressedSpriteFrameFrame to be used from the pressed sprite.
pressedTintColor to be used on the button image when the user presses it.
transitionModeControls how the button responds when the user hovers over it/presses it.

Events

clickFired when the mouse is pressed and released on the component or when a touch starts and ends on the component.
hoverendFired when the button changes state to be not hovered
hoverstartFired when the button changes state to be hovered
mousedownFired when the mouse is pressed while the cursor is on the component.
mouseenterFired when the mouse cursor enters the component.
mouseleaveFired when the mouse cursor leaves the component.
mouseupFired when the mouse is released while the cursor is on the component.
pressedendFired when the button changes state to be not pressed
pressedstartFired when the button changes state to be pressed
touchcancelFired when a touch is cancelled on the component.
touchendFired when a touch ends on the component.
touchleaveFired when a touch leaves the component.
touchstartFired when a touch starts on the component.

Inherited

Properties

systemThe ComponentSystem used to create this Component
entityThe Entity that this Component is attached to
enabledEnables or disables the component.

Methods

fireFire an event, all additional arguments are passed on to the event listener
hasEventTest if there are any handlers bound to an event name
offDetach an event handler from an event.
onAttach an event handler to an event
onceAttach an event handler to an event.

Details

Constructor

ButtonComponent(system, entity)

Create a new ButtonComponent.

Parameters

systempc.ButtonComponentSystemThe ComponentSystem that created this Component
entitypc.EntityThe Entity that this Component is attached to.

Properties

Booleanactive

If set to false, the button will be visible but will not respond to hover or touch interactions.

NumberfadeDuration

Duration to be used when fading between tints, in milliseconds.

pc.Vec4hitPadding

Padding to be used in hit-test calculations. Can be used to expand the bounding box so that the button is easier to tap.

pc.AssethoverSpriteAsset

Sprite to be used as the button image when the user hovers over it.

NumberhoverSpriteFrame

Frame to be used from the hover sprite.

pc.ColorhoverTint

Color to be used on the button image when the user hovers over it.

pc.EntityimageEntity

A reference to the entity to be used as the button background. The entity must have an ImageElement component.

pc.AssetinactiveSpriteAsset

Sprite to be used as the button image when the button is not interactive.

NumberinactiveSpriteFrame

Frame to be used from the inactive sprite.

pc.ColorinactiveTint

Color to be used on the button image when the button is not interactive.

pc.AssetpressedSpriteAsset

Sprite to be used as the button image when the user presses it.

NumberpressedSpriteFrame

Frame to be used from the pressed sprite.

pc.ColorpressedTint

Color to be used on the button image when the user presses it.

NumbertransitionMode

Controls how the button responds when the user hovers over it/presses it.

Events

click

Fired when the mouse is pressed and released on the component or when a touch starts and ends on the component.

Parameters

eventpc.ElementMouseEvent, pc.ElementTouchEventThe event

hoverend

Fired when the button changes state to be not hovered

hoverstart

Fired when the button changes state to be hovered

mousedown

Fired when the mouse is pressed while the cursor is on the component.

Parameters

eventpc.ElementMouseEventThe event

mouseenter

Fired when the mouse cursor enters the component.

Parameters

eventpc.ElementMouseEventThe event

mouseleave

Fired when the mouse cursor leaves the component.

Parameters

eventpc.ElementMouseEventThe event

mouseup

Fired when the mouse is released while the cursor is on the component.

Parameters

eventpc.ElementMouseEventThe event

pressedend

Fired when the button changes state to be not pressed

pressedstart

Fired when the button changes state to be pressed

touchcancel

Fired when a touch is cancelled on the component.

Parameters

eventpc.ElementTouchEventThe event

touchend

Fired when a touch ends on the component.

Parameters

eventpc.ElementTouchEventThe event

touchleave

Fired when a touch leaves the component.

Parameters

eventpc.ElementTouchEventThe event

touchstart

Fired when a touch starts on the component.

Parameters

eventpc.ElementTouchEventThe event

Inherited

Properties

pc.ComponentSystemsystem

The ComponentSystem used to create this Component

pc.Entityentity

The Entity that this Component is attached to

Booleanenabled

Enables or disables the 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

nameObjectName 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

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

nameStringThe 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

nameStringName of the event to unbind
callbackpc.callbacks.HandleEventFunction to be unbound.
scopeObjectScope that was used as the this when the event is fired

Returns

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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.