The alpha transparency of the Component. Range from 0 to 100.
Name of the current animation. - Read Only
var avatarComp = uComps.cast.toAvatar(comp);
var currentAnimation = avatarComp.animation;
The default animation that shows when the component shows.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.animationDefault = 'Run';
Set the horizontal position.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.animationOriginX = 0.5;
Set the vertical position.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.animationOriginY = 0.2;
The animation to play when this component is pressed.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.animationPress = 'Jump';
List of animation names contained in the current animation file. - Read Only
new Action('Avatar Display', avatarDisplay)
.addParameter('Animation', uActions.ParamType.AVATAR)
.addParameter('Text', uActions.ParamType.TEXT)
.register();
function avatarDisplay(comp, comp2) {
var avatarComp = uComps.cast.toAvatar(comp);
var textComp = uComps.cast.toText(comp2);
for (var i = 0; i < avatarComp.animations.length; i++) {
var animationName = avatarComp.animations[i];
textComp.text += animationName + '\r\n'
}
}
Clip the components contents using one of the options in ClippingType.
Access this Component's sub-components.
Delay the default animation from playing by a millisecond amount.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.delay = 500;
Relative path to the animation .atlas file within the ./animation folder of your project. To see the avatar animation, the animationDefault often also needs to be set.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.filename = 'person/person.atlas';
avatarComp.animationDefault = 'Idle';
Whether or not is component is enabled for the parent form. Only relevant when inside a Form Component.
Label used to identify the field this Component belongs to in a form. Only relevant when inside a Form Component.
The height of the Component.
Length of the current animation in milliseconds. - Read Only
var avatarComp = uComps.cast.toAvatar(comp);
var len = avatarComp.length;
Should the default animation loop.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.loop = true;
Shape component to be used as a mask. Can be either a Rectangle or Circle Component.
Name of bone in the animation the represents the mouth part of avatar animation.
var avatarComp = uComps.cast.toAvatar(comp);
var slotName = avatarComp.mouthSlotname;
Name of the component.
Access this Component's parent component.
Whether or not the Component has passed form validation. Only relevant when inside a Form Component.
The scale to render the animation at. Default is 1.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.scale = 0.4;
The current state of the animation - Read Only
var avatarComp = uComps.cast.toAvatar(comp);
var currentState = avatarComp.state;
Position of current animation in milliseconds.
var avatarComp = uComps.cast.toAvatar(comp);
var currentTime = avatarComp.time;
Type of the component.
Unique ID of the component.
Whether or not the Component is visible.
The width of the Component.
The x position of the Component relative to its parent.
The y position of the Component relative to its parent.
Call each callback that is registered for the given eventType
, in the order they were registered, passing the supplied data
to each.
Also works for 'on_down', 'on_up', and 'on_move'.
new Action('Canvas emit', emit)
.addParameter('Canvas', uActions.ParamType.CANVAS)
.register();
function emit(canvas) {
var ctx = uComps.cast.toCanvas(canvas);
ctx.emit('on_press', 'hello world');
}
The type of the event to emit.
Data object to pass to each callback.
Set the keyboard focus to this component.
new uActions.Action('set focus', setFocus)
.addParameter('text entry',uActions.ParamType.TEXT_ENTRY)
.register();
function setFocus(textEntry) {
textEntry.focus();
}
Get a property by name.
var uActions = require('u-actions');
new uActions.Action('get fontsize',getFontSize).register();
function getFontSize() {
var text1=uPages.current.components.getText('Text 1');
console.log(text1.get('font_size'));
}
The name of the property to get.
Returned value can be of any type, or even null.
Adds the callback
function to the end of the listeners array for eventType
.
new Action('Canvas on', on)
.addParameter('Canvas', uActions.ParamType.CANVAS)
.register();
function on(canvas) {
var ctx = uComps.cast.toCanvas(canvas);
ctx.on('on_press', on_callback);
}
function on_callback() {
print('on_callback!!!!');
}
The type of the event.
The callback function
Refresh this component to force it to be re-rendered, or for its dynamic data to be updated.
Set a properties value by name.
var uActions = require('u-actions');
new uActions.Action('set text color',setTextColor).register();
function setTextColor() {
uPages.get('follow').components.getText('Text 1').set('font_color','0x0000FFFF');
}
The name of the property to set.
The value to set. Can be of any type.
Set a number properties at once.
Data object containing property name and value pairs to set on this component.
Translate text into speach.
var avatarComp = uComps.cast.toAvatar(comp);
avatarComp.speak('This is a short sentence to test the speaking ability of the avatar', true)
Text to be spoken.
Sets whether to use the speech component.
Stop the currently playing animation.
``` var avatarComp = uComps.cast.toAvatar(comp); avatarComp.stop();
Tween a component property over time.
The number of seconds to tween for.
An objects that contains key/value pairs of the properties and values to tween.
(Optional) Tween type can be any type from "Tween.type"
The Avatar component is a virtual person interface. It is similar to the Animation component but it has the ability to move the mouth of the animation in sync with a voice file. It has a Speech Component inside it to handle making the Avatar speak.