Create a new ElementComponent instance.
The ComponentSystem that created this Component.
The Entity that this Component is attached to.
The Entity that this Component is attached to.
The Entity with a ScreenComponent that this component belongs to. This is automatically set when the component is a child of a ScreenComponent.
The ComponentSystem used to create this Component.
Private _absPrivate Private _absPrivate Private _absPrivate Private _absPrivate Private _hasPrivate Private _hasPrivate The horizontal and vertical alignment of the text. Values range from 0 to 1 where [0,0] is the bottom left and [1,1] is the top right. Only works for ELEMENTTYPE_TEXT types.
Specifies where the left, bottom, right and top edges of the component are anchored relative to its parent. Each value ranges from 0 to 1. e.g. a value of [0, 0, 0, 0] means that the element will be anchored to the bottom left of its parent. A value of [1, 1, 1, 1] means it will be anchored to the top right. A split anchor is when the left-right or top-bottom pairs of the anchor are not equal. In that case the component will be resized to cover that entire area. e.g. a value of [0, 0, 1, 1] will make the component resize exactly as its parent.
pc.app.root.findByName("Inventory").element.anchor = new pc.Vec4(Math.random() * 0.1, 0, 1, 0);
pc.app.root.findByName("Inventory").element.anchor = [Math.random() * 0.1, 0, 1, 0];
When true the font size and line height will scale so that the text fits inside the height of the Element. The font size will be scaled between minFontSize and maxFontSize. The value of autoFitHeight will be ignored if autoHeight is true.
When true the font size and line height will scale so that the text fits inside the width of the Element. The font size will be scaled between minFontSize and maxFontSize. The value of autoFitWidth will be ignored if autoWidth is true.
Automatically set the height of the component to be the same as the textHeight. Only works for ELEMENTTYPE_TEXT types.
Automatically set the width of the component to be the same as the textWidth. Only works for ELEMENTTYPE_TEXT types.
Assign element to a specific batch group (see BatchGroup). Default is -1 (no group).
The distance from the bottom edge of the anchor. Can be used in combination with a split anchor to make the component's top edge always be 'top' units away from the top.
The height at which the element will be rendered. In most cases this will be the same as
height. However, in some cases the engine may calculate a different height for the element,
such as when the element is under the control of a LayoutGroupComponent. In these
scenarios, calculatedHeight may be smaller or larger than the height that was set in the
editor.
The width at which the element will be rendered. In most cases this will be the same as
width. However, in some cases the engine may calculate a different width for the element,
such as when the element is under the control of a LayoutGroupComponent. In these
scenarios, calculatedWidth may be smaller or larger than the width that was set in the
editor.
The color of the image for ELEMENTTYPE_IMAGE types or the color of the text for ELEMENTTYPE_TEXT types.
The draw order of the component. A higher value means that the component will be rendered on top of other components.
Flag for enabling markup processing. Only works for ELEMENTTYPE_TEXT types. Defaults to false.
Set how the content should be fitted and preserve the aspect ratio of the source texture or sprite. Only works for ELEMENTTYPE_IMAGE types. Can be:
The font used for rendering the text. Only works for ELEMENTTYPE_TEXT types.
The id of the font asset used for rendering the text. Only works for ELEMENTTYPE_TEXT types.
The size of the font. Only works for ELEMENTTYPE_TEXT types.
The height of the element as set in the editor. Note that in some cases this may not reflect
the true height at which the element is rendered, such as when the element is under the
control of a LayoutGroupComponent. See calculatedHeight in order to ensure you are
reading the true height at which the element will be rendered.
The localization key to use to get the localized text from Application#i18n. Only works for ELEMENTTYPE_TEXT types.
An array of layer IDs (Layer#id) to which this element should belong. Don't push, pop, splice or modify this array, if you want to change it - set a new one instead.
The distance from the left edge of the anchor. Can be used in combination with a split anchor to make the component's left edge always be 'left' units away from the left.
The height of each line of text. Only works for ELEMENTTYPE_TEXT types.
The distance from the left, bottom, right and top edges of the anchor. For example if we are using a split anchor like [0,0,1,1] and the margin is [0,0,0,0] then the component will be the same width and height as its parent.
Switch Image Element into a mask. Masks do not render into the scene, but instead limit child elements to only be rendered where this element is rendered.
Private maskedThe material to use when rendering an image. Only works for ELEMENTTYPE_IMAGE types.
The id of the material asset to use when rendering an image. Only works for ELEMENTTYPE_IMAGE types.
The maximum size that the font can scale to when autoFitWidth or autoFitHeight are true.
The maximum number of lines that the Element can wrap to. Any leftover text will be appended to the last line. Set this to null to allow unlimited lines.
The minimum size that the font can scale to when autoFitWidth or autoFitHeight are true.
The opacity of the image for ELEMENTTYPE_IMAGE types or the text for ELEMENTTYPE_TEXT types.
The text outline effect color and opacity. Only works for ELEMENTTYPE_TEXT types.
The width of the text outline effect. Only works for ELEMENTTYPE_TEXT types.
The position of the pivot of the component relative to its anchor. Each value ranges from 0 to 1 where [0,0] is the bottom left and [1,1] is the top right.
pc.app.root.findByName("Inventory").element.pivot = [Math.random() * 0.1, Math.random() * 0.1];
pc.app.root.findByName("Inventory").element.pivot = new pc.Vec2(Math.random() * 0.1, Math.random() * 0.1);
The number of pixels that map to one PlayCanvas unit. Only works for ELEMENTTYPE_IMAGE types who have a sliced sprite assigned.
Index of the last character to render. Only works for ELEMENTTYPE_TEXT types.
Index of the first character to render. Only works for ELEMENTTYPE_TEXT types.
Specifies which region of the texture to use in order to render an image. Values range from 0 to 1 and indicate u, v, width, height. Only works for ELEMENTTYPE_IMAGE types.
The distance from the right edge of the anchor. Can be used in combination with a split anchor to make the component's right edge always be 'right' units away from the right.
Reorder the text for RTL languages using a function registered by
app.systems.element.registerUnicodeConverter.
An array of 4 Vec3s that represent the bottom left, bottom right, top right and top left corners of the component relative to its parent ScreenComponent.
The text shadow effect color and opacity. Only works for ELEMENTTYPE_TEXT types.
The text shadow effect shift amount from original text. Only works for ELEMENTTYPE_TEXT types.
The spacing between the letters of the text. Only works for ELEMENTTYPE_TEXT types.
The sprite to render. Only works for ELEMENTTYPE_IMAGE types which can render either a texture or a sprite.
The id of the sprite asset to render. Only works for ELEMENTTYPE_IMAGE types which can render either a texture or a sprite.
The frame of the sprite to render. Only works for ELEMENTTYPE_IMAGE types who have a sprite assigned.
The text to render. Only works for ELEMENTTYPE_TEXT types. To override certain text styling properties on a per-character basis, the text can optionally include markup tags contained within square brackets. Supported tags are:
color - override the element's color property. Examples:[color="#ff0000"]red text[/color][color="#00ff00"]green text[/color][color="#0000ff"]blue text[/color]outline - override the element's outlineColor and outlineThickness properties. Example:[outline color="#ffffff" thickness="0.5"]text[/outline]shadow - override the element's shadowColor and shadowOffset properties. Examples:[shadow color="#ffffff" offset="0.5"]text[/shadow][shadow color="#000000" offsetX="0.1" offsetY="0.2"]text[/shadow]Note that markup tags are only processed if the text element's enableMarkup property is set to
true.
The height of the text rendered by the component. Only works for ELEMENTTYPE_TEXT types.
The width of the text rendered by the component. Only works for ELEMENTTYPE_TEXT types.
The texture to render. Only works for ELEMENTTYPE_IMAGE types.
The id of the texture asset to render. Only works for ELEMENTTYPE_IMAGE types.
The distance from the top edge of the anchor. Can be used in combination with a split anchor to make the component's bottom edge always be 'bottom' units away from the bottom.
The type of the ElementComponent. Can be:
Convert unicode characters using a function registered by app.systems.element.registerUnicodeConverter.
If true then the component will receive Mouse or Touch input events.
The width of the element as set in the editor. Note that in some cases this may not reflect
the true width at which the element is rendered, such as when the element is under the
control of a LayoutGroupComponent. See calculatedWidth in order to ensure you are
reading the true width at which the element will be rendered.
Whether to automatically wrap lines based on the element width. Only works for ELEMENTTYPE_TEXT types, and when autoWidth is set to false.
Private _calculatePrivate Recalculates these properties:
_localAnchorwidthheightAssumes these properties are up to date:
_marginIf true, call _setWidth instead
of _setCalculatedWidth
If true, call _setHeight instead
of _setCalculatedHeight
Private _setPrivate _setPrivate _setPrivate _setPrivate Patched method for setting the local position.
The x coordinate or Vec3
The y coordinate
The z coordinate
Private _setPrivate Patched method for setting the position.
The x coordinate or Vec3
The y coordinate
The z coordinate
Private _setFire an event, all additional arguments are passed on to the event listener.
Name of event to fire.
Optional arg1: anyFirst argument that is passed to the event handler.
Optional arg2: anySecond argument that is passed to the event handler.
Optional arg3: anyThird argument that is passed to the event handler.
Optional arg4: anyFourth argument that is passed to the event handler.
Optional arg5: anyFifth argument that is passed to the event handler.
Optional arg6: anySixth argument that is passed to the event handler.
Optional arg7: anySeventh argument that is passed to the event handler.
Optional arg8: anyEighth argument that is passed to the event handler.
Self for chaining.
obj.fire('test', 'This is the message');
Test if there are any handlers bound to an event name.
The name of the event to test.
True if the object has handlers bound to the specified event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
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.
Optional name: stringName of the event to unbind.
Optional callback: HandleEventCallbackFunction to be unbound.
Optional scope: objectScope that was used as the this when the event is fired.
Self for chaining.
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
Attach an event handler to an event.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
Can be used for removing event in the future.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
const evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();
Attach an event handler to an event. This handler will be removed after being fired once.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
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
Static EVENT_Fired when the mouse is pressed and released on the component or when a touch starts and ends on the component. Only fired when useInput is true. The handler is passed an ElementMouseEvent or ElementTouchEvent.
entity.element.on('click', (event) => {
console.log(`Click event on entity ${entity.name}`);
});
Static EVENT_Fired when the mouse is pressed while the cursor is on the component. Only fired when useInput is true. The handler is passed an ElementMouseEvent.
entity.element.on('mousedown', (event) => {
console.log(`Mouse down event on entity ${entity.name}`);
});
Static EVENT_Fired when the mouse cursor enters the component. Only fired when useInput is true. The handler is passed an ElementMouseEvent.
entity.element.on('mouseenter', (event) => {
console.log(`Mouse enter event on entity ${entity.name}`);
});
Static EVENT_Fired when the mouse cursor leaves the component. Only fired when useInput is true. The handler is passed an ElementMouseEvent.
entity.element.on('mouseleave', (event) => {
console.log(`Mouse leave event on entity ${entity.name}`);
});
Static EVENT_Fired when the mouse cursor is moved on the component. Only fired when useInput is true. The handler is passed an ElementMouseEvent.
entity.element.on('mousemove', (event) => {
console.log(`Mouse move event on entity ${entity.name}`);
});
Static EVENT_Fired when the mouse is released while the cursor is on the component. Only fired when useInput is true. The handler is passed an ElementMouseEvent.
entity.element.on('mouseup', (event) => {
console.log(`Mouse up event on entity ${entity.name}`);
});
Static EVENT_Fired when the mouse wheel is scrolled on the component. Only fired when useInput is true. The handler is passed an ElementMouseEvent.
entity.element.on('mousewheel', (event) => {
console.log(`Mouse wheel event on entity ${entity.name}`);
});
Static EVENT_Fired when a touch is canceled on the component. Only fired when useInput is true. The handler is passed an ElementTouchEvent.
entity.element.on('touchcancel', (event) => {
console.log(`Touch cancel event on entity ${entity.name}`);
});
Static EVENT_Fired when a touch ends on the component. Only fired when useInput is true. The handler is passed an ElementTouchEvent.
entity.element.on('touchend', (event) => {
console.log(`Touch end event on entity ${entity.name}`);
});
Static EVENT_Fired when a touch moves after it started touching the component. Only fired when useInput is true. The handler is passed an ElementTouchEvent.
entity.element.on('touchmove', (event) => {
console.log(`Touch move event on entity ${entity.name}`);
});
Static EVENT_Fired when a touch starts on the component. Only fired when useInput is true. The handler is passed an ElementTouchEvent.
entity.element.on('touchstart', (event) => {
console.log(`Touch start event on entity ${entity.name}`);
});
ElementComponents are used to construct user interfaces. An ElementComponent's type property can be configured in 3 main ways: as a text element, as an image element or as a group element. If the ElementComponent has a ScreenComponent ancestor in the hierarchy, it will be transformed with respect to the coordinate system of the screen. If there is no ScreenComponent ancestor, the ElementComponent will be transformed like any other entity.
You should never need to use the ElementComponent constructor. To add an ElementComponent to a Entity, use Entity#addComponent:
To create a simple text-based element:
Once the ElementComponent is added to the entity, you can set and get any of its properties:
Relevant 'Engine-only' examples: