Packagenet.user1.reactor.ui
Classpublic class AvatarPane
InheritanceAvatarPane Inheritance flash.display.Sprite

Since : ReactorGUI 1.0.0

A visual container that displays Avatar objects for a specified room. For each client that joins the specified room and also defines an attribute named PositionBroadcaster.DEFAULT_POSITION_LIST_ATTRIBUTE_NAME scoped to the room, the AvatarPane automatically adds a corresponding Avatar.



Public Methods
 MethodDefined By
  
AvatarPane(defaultAvatarIconClass:Class, defaultAvatarSpeed:int = 100, room:Room = null)
Constructor
AvatarPane
  
Returns an Array of all Avatar objects currently in this AvatarPane's avatar list.
AvatarPane
  
getAvatar(clientID:String):Avatar
Returns the Avatar object for the specified clientID.
AvatarPane
  
hideSelf():void
Instructs this AvatarPane to keep the current client's Avatar object hidden.
AvatarPane
  
setRoom(room:Room):void
Specifies the Room object for which this AvatarPane will provide avatar visuals.
AvatarPane
  
showSelf():void
Instructs this AvatarPane to allow the current client's Avatar object to be shown.
AvatarPane
  
useCustomContainer(value:Boolean):void
Determines whether this AvatarPane adds Avatar objects as its own display children.
AvatarPane
Constructor Description
AvatarPane()Constructor
public function AvatarPane(defaultAvatarIconClass:Class, defaultAvatarSpeed:int = 100, room:Room = null)

Constructor

Parameters
defaultAvatarIconClass:Class — The icon to use for avatars in the room.
 
defaultAvatarSpeed:int (default = 100) — The default speed for avatars in the room.
 
room:Room (default = null) — The underlying Room object that will provide data for this AvatarPane.
Method Descriptions
getAllAvatars()method
public function getAllAvatars():Array

Since : ReactorGUI 1.0.0

Returns an Array of all Avatar objects currently in this AvatarPane's avatar list.

Returns
Array
getAvatar()method 
public function getAvatar(clientID:String):Avatar

Since : ReactorGUI 1.0.0

Returns the Avatar object for the specified clientID.

Parameters

clientID:String

Returns
Avatar
hideSelf()method 
public function hideSelf():void

Since : ReactorGUI 1.0.0

Instructs this AvatarPane to keep the current client's Avatar object hidden.

setRoom()method 
public function setRoom(room:Room):void

Since : ReactorGUI 1.0.0

Specifies the Room object for which this AvatarPane will provide avatar visuals.

Parameters

room:Room

showSelf()method 
public function showSelf():void

Since : ReactorGUI 1.0.0

Instructs this AvatarPane to allow the current client's Avatar object to be shown.

useCustomContainer()method 
public function useCustomContainer(value:Boolean):void

Since : ReactorGUI 1.0.0

Determines whether this AvatarPane adds Avatar objects as its own display children. When set to false, this AvatarPane will not automatically add Avatar objects; instead, the application must add Avatar objects to a DisplayObjectContainer of its choosing by listening for the AvatarPaneEvent.ADD_AVATAR and AvatarPaneEvent.REMOVE_AVATAR events.

Parameters

value:Boolean