Packagecom.worlize.api.model
Classpublic class ThisRoom
InheritanceThisRoom Inheritance Room Inheritance flash.events.EventDispatcher

Product Version : Worlize APIv.1

Represents the current room ("this" room).

Extends the Room class with properties and methods relevant to observing actions occurring in the current room and manipulating its state.

See also

com.worlize.api.model.Room
com.worlize.api.model.RoomObject
com.worlize.api.model.User
com.worlize.api.model.LooseProp


Public Properties
 PropertyDefined By
  dimLevel : uint
A number representing how dim the room is.
ThisRoom
 Inheritedguid : String
[read-only] The room's Global Unique Identifier
Room
  height : int
[read-only] The room's height.
ThisRoom
 Inheritedlocked : Boolean
[read-only] True if the room is locked
Room
  looseProps : Vector.<LooseProp>
[read-only] A list of loose props in the room.
ThisRoom
  mouseX : Number
[read-only] The horizontal position of the mouse cursor relative to the room's coordinate space
ThisRoom
  mouseY : Number
[read-only] The vertical position of the mouse cursor relative to the room's coordinate space
ThisRoom
 Inheritedname : String
[read-only] The room's name.
Room
  objects : Vector.<RoomObject>
[read-only] A list of objects (apps) in the room.
ThisRoom
 InheritedownerGuid : String
[read-only] The User GUID of the room's owner
Room
  users : Vector.<User>
[read-only] A list of users in the room.
ThisRoom
  width : int
[read-only] The room's width.
ThisRoom
Public Methods
 MethodDefined By
  
addLooseProp(propGuid:String, x:int, y:int):void
Add a new loose prop to the room.
ThisRoom
  
announce(text:String):void
Displays a disembodied white chat balloon for all users in the room.
ThisRoom
  
announceLocal(text:String):void
Displays a disembodied white chat balloon only for the current user.
ThisRoom
  
broadcastMessage(message:Object, toUserGuids:Array = null):void
Send a message to all objects in the room.
ThisRoom
  
broadcastMessageLocal(message:Object):void
Send a message to all objects in the room for only the current user.
ThisRoom
  
Remove all loose props from the room.
ThisRoom
  
Look up a LooseProp object by its id.
ThisRoom
  
Look up a RoomObject object by its instanceGuid.
ThisRoom
  
getUserByGuid(guid:String):User
Look up a User object by GUID.
ThisRoom
  
lock():void
Lock the room.
ThisRoom
  
unlock():void
Unlock the room.
ThisRoom
Events
 Event Summary Defined By
  Dispatched when incoming chat is received from any user in the room.ThisRoom
  Dispatched after the room has been locked.ThisRoom
  Dispatched continuously as the user moves their mouse over the room background.ThisRoom
  Dispatched after an object has been added to the room.ThisRoom
  Dispatched after an object in the room has been moved.ThisRoom
  Dispatched after an object has been removed from the room.ThisRoom
  Dispatched after an object in the room has been resized.ThisRoom
  Dispatched after an object in the room has changed state.ThisRoom
  Dispatched when the user sends an outgoing chat message, before it is sent to the server.ThisRoom
  Dispatched after a loose prop has been added to the room.ThisRoom
  Dispatched after a loose prop has changed its stacking order.ThisRoom
  Dispatched after a loose prop has been moved.ThisRoom
  Dispatched after a loose prop has been removed from the room.ThisRoom
  Dispatched after all loose props have been removed from the room.ThisRoom
  Dispatched after the room has been unlocked.ThisRoom
  Dispatched after a user's avatar has changed.ThisRoom
  Dispatched after a user's text baloon background color has changed.ThisRoom
  Dispatched after the color of a user's default "gummy" avatar has changed.ThisRoom
  Dispatched after a user has entered the room.ThisRoom
  Dispatched after a user has left the room.ThisRoom
  Dispatched after a user's avatar has moved.ThisRoom
  Dispatched after a user's privileges have changedThisRoom
Property Detail
dimLevelproperty
dimLevel:uint

Product Version : Worlize APIv.1

A number representing how dim the room is.

This is a value from 0 to 100, where 0 is full black, and 100 is full brightness


Implementation
    public function get dimLevel():uint
    public function set dimLevel(value:uint):void
heightproperty 
height:int  [read-only]

Product Version : Worlize APIv.1

The room's height.


Implementation
    public function get height():int
loosePropsproperty 
looseProps:Vector.<LooseProp>  [read-only]

Product Version : Worlize APIv.2

A list of loose props in the room.


Implementation
    public function get looseProps():Vector.<LooseProp>
mouseXproperty 
mouseX:Number  [read-only]

Product Version : Worlize APIv.1

The horizontal position of the mouse cursor relative to the room's coordinate space


Implementation
    public function get mouseX():Number
mouseYproperty 
mouseY:Number  [read-only]

Product Version : Worlize APIv.1

The vertical position of the mouse cursor relative to the room's coordinate space


Implementation
    public function get mouseY():Number
objectsproperty 
objects:Vector.<RoomObject>  [read-only]

Product Version : Worlize APIv.1

A list of objects (apps) in the room.


Implementation
    public function get objects():Vector.<RoomObject>
usersproperty 
users:Vector.<User>  [read-only]

Product Version : Worlize APIv.1

A list of users in the room.


Implementation
    public function get users():Vector.<User>
widthproperty 
width:int  [read-only]

Product Version : Worlize APIv.1

The room's width.


Implementation
    public function get width():int
Method Detail
addLooseProp()method
public function addLooseProp(propGuid:String, x:int, y:int):void

Product Version : Worlize APIv.2

Add a new loose prop to the room.

This does not immediately add the new loose prop, but rather sends the request to the server to have the new loose prop added. The new prop will trigger a LoosePropEvent.PROP_ADDED event once the server update is received.

Parameters

propGuid:String — the GUID of the prop you would like to add
 
x:int — the horizonal position of the center of the prop in the room
 
y:int — the vertical position of the center of the prop in the room

See also

announce()method 
public function announce(text:String):void

Product Version : Worlize APIv.1

Displays a disembodied white chat balloon for all users in the room.

The text will appear in the chat log without a username.

The text appears in the top left corner by default. You may position the text by prepending an @ symbol followed by x and y coordinates to the text

Parameters

text:String — the text to display in the chat balloon.

See also


Example
Display a specifically positioned chat bubble for all users in the room
         
         var api:WorlizeAPI = WorlizeAPI.getInstance();
         api.thisRoom.announce("@100,200 OMG, a disembodied chat bubble!");
         
         
announceLocal()method 
public function announceLocal(text:String):void

Product Version : Worlize APIv.1

Displays a disembodied white chat balloon only for the current user.

Only the current user will see balloons produced with announceLocal(). Other users will not see them and the text will not be routed through the server.

The text will appear in the chat log without a username.

The text appears in the top left corner by default. You may position the text by prepending an @ symbol followed by x and y coordinates to the text

Parameters

text:String — the text to display in the chat balloon.

See also


Example
Display a specifically positioned chat bubble for only the current user in the room
         
         var api:WorlizeAPI = WorlizeAPI.getInstance();
         api.thisRoom.announceLocal("@100,200 OMG, a disembodied chat bubble!");
         
         
broadcastMessage()method 
public function broadcastMessage(message:Object, toUserGuids:Array = null):void

Product Version : Worlize APIv.1

Send a message to all objects in the room.

Broadcasts any AMF3-serializable object to all objects (apps) in the room, facilitating inter-app communications and events.

To restrict the message to only be sent to a subset of users, specify an array of user guids as the second parameter

Parameters

message:Object — an AMF3-serializable object
 
toUserGuids:Array (default = null) — (optional) an array of user guids to which the message should be sent

See also


Example
A color-picker app broadcasts the chosen color to any other app that might be interested, for all users in the room.
         
         var api:WorlizeAPI = WorlizeAPI.getInstance();
         
         var myNewColor:uint = 0xFF0000; // Replace with color from picker
         var message:Object = {
             name: "colorSelected",
             color: myNewColor
         };
         api.thisRoom.broadcastMessage(message);
         
         
broadcastMessageLocal()method 
public function broadcastMessageLocal(message:Object):void

Product Version : Worlize APIv.1

Send a message to all objects in the room for only the current user.

Like broadcastMessage() but the message is not routed through the server and is delivered only to objects running on the current user's machine.

Parameters

message:Object — an AMF3-serializable object

See also


Example
A color-picker app broadcasts the chosen color to any other app that might be interested, for only the current user.
         
         var api:WorlizeAPI = WorlizeAPI.getInstance();
         
         var myNewColor:uint = 0xFF0000; // Replace with color from picker
         var message:Object = {
             name: "colorSelected",
             color: myNewColor
         };
         api.thisRoom.broadcastMessageLocal(message);
         
         
clearLooseProps()method 
public function clearLooseProps():void

Product Version : Worlize APIv.2

Remove all loose props from the room.

This does not immediately remove the loose props, but rather sends the request to the server to have the loose props removed. The props will be cleared once confirmation has been received from the server, and a LoosePropEvent.PROPS_CLEARED event will be dispatched, after dispatching a LoosePropEvent.PROP_REMOVED event for each loose prop that was in the room.

See also

getLoosePropById()method 
public function getLoosePropById(id:uint):LooseProp

Product Version : Worlize APIv.2

Look up a LooseProp object by its id.

Parameters

id:uint — the loose prop's id

Returns
LooseProp — a LooseProp object

See also

com.worlize.model.LooseProp.id
getObjectByGuid()method 
public function getObjectByGuid(guid:String):RoomObject

Product Version : Worlize APIv.1

Look up a RoomObject object by its instanceGuid.

Parameters

guid:String — the object's instanceGuid

Returns
RoomObject — a RoomObject object
getUserByGuid()method 
public function getUserByGuid(guid:String):User

Product Version : Worlize APIv.1

Look up a User object by GUID.

Parameters

guid:String — the user's guid

Returns
User — a User object
lock()method 
public function lock():void

Product Version : Worlize APIv.1

Lock the room.

Subsequent visitors will be denied entrance to the room as long as it remains locked. Rooms will automatically unlock when they become empty.

The owner of a room may always enter, even if it is locked.

See also

unlock()method 
public function unlock():void

Product Version : Worlize APIv.1

Unlock the room.

Subsequent visitors will be allowed entrance to the room.

Rooms will automatically unlock when they become empty. The owner of a room may always enter, even if it is locked.

See also

Event Detail
incomingChat Event
Event Object Type: com.worlize.api.event.ChatEvent
ChatEvent.type property = com.worlize.api.event.ChatEvent.INCOMING_CHAT

Product Version : Worlize API.v1

Dispatched when incoming chat is received from any user in the room.

This event will be triggered by all incoming chat, including chat from the current user, after it has been received from the server. That means that when the current user chats, both outgoingChat and incomingChat events will be dispatched, in that order.

The ChatEvent.INCOMING_CHAT constant defines the value of the type property of the event object for a incomingChat event.

The text property can be modified to change the chat text before it is displayed on screen.

This event is cancelable. Call preventDefault() on the event object to prevent the text from appearing on screen.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
isWhisperTrue if the event represents a private message
originalTextThe original chat text, unmodified. This value can be relied upon to contain the true chat text, as opposed to the text property that may have been modified by another app or event handler.
recipientThe user who is the recipient of a whisper. If the chat is not a whisper, will be set to null. See com.worlize.api.model.User.
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.
textThe chat text. Can be modified to affect the actual message before it is displayed on screen.
userThe user who is sending the chat. See com.worlize.api.model.User.
locked Event  
Event Object Type: com.worlize.api.event.RoomEvent
RoomEvent.type property = com.worlize.api.event.RoomEvent.LOCKED

Product Version : Worlize API.v1

Dispatched after the room has been locked.

The RoomEvent.LOCKED constant defines the value of the type property of the event object for a locked 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 that locked the room. See com.worlize.api.model.User.
mouseMove Event  
Event Object Type: flash.events.MouseEvent
MouseEvent.type property = flash.events.MouseEvent

Product Version : Worlize API.v1

Dispatched continuously as the user moves their mouse over the room background.

Since embedded apps don't have access to the screen area outside the boundaries of their own rectangle, listen to this event to track mouse movement outside the app's boundaries.

objectAdded Event  
Event Object Type: com.worlize.api.event.RoomEvent
RoomEvent.type property = com.worlize.api.event.RoomEvent.OBJECT_ADDED

Product Version : Worlize API.v1

Dispatched after an object has been added to the room.

The RoomEvent.OBJECT_ADDED constant defines the value of the type property of the event object for a objectAdded 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.
roomObjectThe object associated with the event. See com.worlize.api.model.RoomObject.
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.
objectMoved Event  
Event Object Type: com.worlize.api.event.RoomObjectEvent
RoomObjectEvent.type property = com.worlize.api.event.RoomObjectEvent.OBJECT_MOVED

Product Version : Worlize API.v1

Dispatched after an object in the room has been moved.

The RoomObjectEvent.OBJECT_MOVED constant defines the value of the type property of the event object for a objectMoved 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.
roomObjectThe object associated with the event. See com.worlize.api.model.RoomObject.
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.
objectRemoved Event  
Event Object Type: com.worlize.api.event.RoomEvent
RoomEvent.type property = com.worlize.api.event.RoomEvent.OBJECT_REMOVED

Product Version : Worlize API.v1

Dispatched after an object has been removed from the room.

The RoomEvent.OBJECT_REMOVED constant defines the value of the type property of the event object for a objectRemoved 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.
roomObjectThe object associated with the event. See com.worlize.api.model.RoomObject.
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.
objectResized Event  
Event Object Type: com.worlize.api.event.RoomObjectEvent
RoomObjectEvent.type property = com.worlize.api.event.RoomObjectEvent.OBJECT_RESIZED

Product Version : Worlize API.v1

Dispatched after an object in the room has been resized.

The RoomObjectEvent.OBJECT_RESIZED constant defines the value of the type property of the event object for a objectResized 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.
roomObjectThe object associated with the event. See com.worlize.api.model.RoomObject.
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.
objectStateChanged Event  
Event Object Type: com.worlize.api.event.RoomObjectEvent
RoomObjectEvent.type property = com.worlize.api.event.RoomObjectEvent.OBJECT_STATE_CHANGED

Product Version : Worlize API.v1

Dispatched after an object in the room has changed state.

The RoomObjectEvent.OBJECT_STATE_CHANGED constant defines the value of the type property of the event object for a objectStateChanged 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.
roomObjectThe object associated with the event. See com.worlize.api.model.RoomObject.
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.
outgoingChat Event  
Event Object Type: com.worlize.api.event.ChatEvent
ChatEvent.type property = com.worlize.api.event.ChatEvent.OUTGOING_CHAT

Product Version : Worlize API.v1

Dispatched when the user sends an outgoing chat message, before it is sent to the server.

Be aware that when the current user chats, both outgoingChat and incomingChat events will be dispatched, in that order.

The ChatEvent.OUTGOING_CHAT constant defines the value of the type property of the event object for a outgoingChat event.

The text property can be modified to change the chat text before it is sent.

This event is cancelable. Call preventDefault() on the event object to prevent the chat message from being sent.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
isWhisperTrue if the event represents a private message
originalTextThe original chat text, unmodified. This value can be relied upon to contain the true chat text, as opposed to the text property that may have been modified by another app or event handler.
recipientThe user who is the recipient of a whisper. If the chat is not a whisper, will be set to null. See com.worlize.api.model.User.
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.
textThe chat text. Can be modified to affect the actual message that is sent.
userThe user who is sending the chat. See com.worlize.api.model.User.
propAdded Event  
Event Object Type: com.worlize.api.event.LoosePropEvent
LoosePropEvent.type property = com.worlize.api.event.LoosePropEvent.PROP_ADDED

Product Version : Worlize APIv.2

Dispatched after a loose prop has been added to the room.

The LoosePropEvent.PROP_ADDED constant defines the value of the type property of the event object for a propAdded event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
loosePropA LooseProp instance representing the new loose prop that was added.
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.
propLayerChanged Event  
Event Object Type: com.worlize.api.event.LoosePropEvent
LoosePropEvent.type property = com.worlize.api.event.LoosePropEvent.PROP_LAYER_CHANGED

Product Version : Worlize APIv.2

Dispatched after a loose prop has changed its stacking order.

The LoosePropEvent.PROP_LAYER_CHANGED constant defines the value of the type property of the event object for a propLayerChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
loosePropA LooseProp instance representing the loose prop that was moved in the stacking order.
oldIndexThe LooseProp's previous position in the stacking order.
newIndexThe LooseProp's new position in the stacking order.
deltaThe change between the LooseProp's old and new position in the stacking order. Will be a positive integer when the prop is brought forward and a negative integer when sent backward.
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.
propMoved Event  
Event Object Type: com.worlize.api.event.LoosePropEvent
LoosePropEvent.type property = com.worlize.api.event.LoosePropEvent.PROP_MOVED

Product Version : Worlize APIv.2

Dispatched after a loose prop has been moved.

The LoosePropEvent.PROP_MOVED constant defines the value of the type property of the event object for a propMoved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
loosePropA LooseProp instance representing the loose prop that was moved.
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.
propRemoved Event  
Event Object Type: com.worlize.api.event.LoosePropEvent
LoosePropEvent.type property = com.worlize.api.event.LoosePropEvent.PROP_REMOVED

Product Version : Worlize APIv.2

Dispatched after a loose prop has been removed from the room.

The LoosePropEvent.PROP_REMOVED constant defines the value of the type property of the event object for a propRemoved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
loosePropA LooseProp instance representing the loose prop that was removed.
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.
propsCleared Event  
Event Object Type: com.worlize.api.event.LoosePropEvent
LoosePropEvent.type property = com.worlize.api.event.LoosePropEvent.PROPS_CLEARED

Product Version : Worlize APIv.2

Dispatched after all loose props have been removed from the room.

The LoosePropEvent.PROPS_CLEARED constant defines the value of the type property of the event object for a propsCleared event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
loosePropA LooseProp instance representing the loose prop that was moved.
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.
unlocked Event  
Event Object Type: com.worlize.api.event.RoomEvent
RoomEvent.type property = com.worlize.api.event.RoomEvent.UNLOCKED

Product Version : Worlize API.v1

Dispatched after the room has been unlocked.

The RoomEvent.UNLOCKED constant defines the value of the type property of the event object for a unlocked 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 that unlocked the room. See com.worlize.api.model.User.
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 a 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 a 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 a 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.
userEntered Event  
Event Object Type: com.worlize.api.event.RoomEvent
RoomEvent.type property = com.worlize.api.event.RoomEvent.USER_ENTERED

Product Version : Worlize API.v1

Dispatched after a user has entered the room.

The RoomEvent.USER_ENTERED constant defines the value of the type property of the event object for a userEntered 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.
userLeft Event  
Event Object Type: com.worlize.api.event.RoomEvent
RoomEvent.type property = com.worlize.api.event.RoomEvent.USER_ENTERED

Product Version : Worlize API.v1

Dispatched after a user has left the room.

The RoomEvent.USER_ENTERED constant defines the value of the type property of the event object for a userEntered 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 a 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 a 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.