Packagecom.worlize.api.model
Classpublic class User
InheritanceUser Inheritance flash.events.EventDispatcher
Subclasses ThisUser

Product Version : Worlize APIv.1

Represents a Worlize User

See also

com.worlize.api.model.ThisUser


Public Properties
 PropertyDefined By
  avatar : Avatar
[read-only] The user's current avatar
User
  balloonColor : int
[read-only] The background color index of the user's chat baloons.
User
  canAuthor : Boolean
[read-only] True if the user has permission to author the current room.
User
  color : int
[read-only] The color index of the user's default "gummy" avatar.
User
  guid : String
[read-only] The user's Globally Unique Identifier
User
  name : String
[read-only] The user's username.
User
  privileges : Array
[read-only] A list of strings representing the user's current permissions.
User
  x : int
[read-only] The horizontal position of the user's avatar in the room's coordinate space.
User
  y : int
[read-only] The vertical position of the user's avatar in the room's coordinate space.
User
Public Methods
 MethodDefined By
  
Constructor.
User
Events
 Event Summary Defined By
  Dispatched after the user's avatar has changed.User
  Dispatched after the user's text baloon background color has changed.User
  Dispatched after the color of the user's default "gummy" avatar has changed.User
  Dispatched after the user's avatar has moved.User
  Dispatched after the user's privileges have changedUser
Property Detail
avatarproperty
avatar:Avatar  [read-only]

Product Version : Worlize APIv.1

The user's current avatar


Implementation
    public function get avatar():Avatar
balloonColorproperty 
balloonColor:int  [read-only]

Product Version : Worlize APIv.1

The background color index of the user's chat baloons.

Valid values range from 0 to 15, inclusive

The current colors are as follows, but subject to change:

IndexColor
0#FF9999 - Red
1#FF9966 - Orange
2#FFCC88 - Gold
3#FFEE99 - Yellow
4#D0F29F - Yellow-Green
5#B9F29F - Green
6#AFF2AE - Green 2
7#C4F4DE - Green-Cyan
8#A9EEF1 - Cyan
9#8DD2FF - Cyan-Blue
10#86ABFF - Blue
11#8F86FF - Blue-Violet
12#AB86FF - Violet
13#EF86FF - Magenta
14#FF86E4 - Magenta-Rose
15#FF86B1 - Rose


Implementation
    public function get balloonColor():int
canAuthorproperty 
canAuthor:Boolean  [read-only]

Product Version : Worlize APIv.1

True if the user has permission to author the current room.


Implementation
    public function get canAuthor():Boolean
colorproperty 
color:int  [read-only]

Product Version : Worlize APIv.1

The color index of the user's default "gummy" avatar.

Valid values range from 0 to 12, inclusive


Implementation
    public function get color():int
guidproperty 
guid:String  [read-only]

Product Version : Worlize APIv.1

The user's Globally Unique Identifier


Implementation
    public function get guid():String

See also

nameproperty 
name:String  [read-only]

Product Version : Worlize APIv.1

The user's username.


Implementation
    public function get name():String
privilegesproperty 
privileges:Array  [read-only]

Product Version : Worlize APIv.1

A list of strings representing the user's current permissions.


Implementation
    public function get privileges():Array
xproperty 
x:int  [read-only]

Product Version : Worlize APIv.1

The horizontal position of the user's avatar in the room's coordinate space.


Implementation
    public function get x():int
yproperty 
y:int  [read-only]

Product Version : Worlize APIv.1

The vertical position of the user's avatar in the room's coordinate space.


Implementation
    public function get y():int
Constructor Detail
User()Constructor
public function User()

Product Version : Worlize APIv.1

Constructor.

Event Detail
userAvatarChanged Event
Event Object Type: com.worlize.api.event.UserEvent
UserEvent.type property = com.worlize.api.event.UserEvent.USER_AVATAR_CHANGED

Product Version : Worlize API.v1

Dispatched after the user's avatar has changed.

The UserEvent.USER_AVATAR_CHANGED constant defines the value of the type property of the event object for a userAvatarChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.
userBalloonColorChanged Event  
Event Object Type: com.worlize.api.event.UserEvent
UserEvent.type property = com.worlize.api.event.UserEvent.USER_BALLOON_COLOR_CHANGED

Product Version : Worlize API.v1

Dispatched after the user's text baloon background color has changed.

The UserEvent.USER_BALLOON_COLOR_CHANGED constant defines the value of the type property of the event object for a userBalloonColorChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.
userColorChanged Event  
Event Object Type: com.worlize.api.event.UserEvent
UserEvent.type property = com.worlize.api.event.UserEvent.USER_COLOR_CHANGED

Product Version : Worlize API.v1

Dispatched after the color of the user's default "gummy" avatar has changed.

The UserEvent.USER_COLOR_CHANGED constant defines the value of the type property of the event object for a userColorChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.
userMoved Event  
Event Object Type: com.worlize.api.event.UserEvent
UserEvent.type property = com.worlize.api.event.UserEvent.USER_MOVED

Product Version : Worlize API.v1

Dispatched after the user's avatar has moved.

The UserEvent.USER_MOVED constant defines the value of the type property of the event object for a userMoved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.
userPrivilegesChanged Event  
Event Object Type: com.worlize.api.event.UserEvent
UserEvent.type property = com.worlize.api.event.UserEvent.USER_PRIVILEGES_CHANGED

Product Version : Worlize API.v1

Dispatched after the user's privileges have changed

The UserEvent.USER_PRIVILEGES_CHANGED constant defines the value of the type property of the event object for a userPrivilegesChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.