Package | net.user1.reactor.ui |
Class | public class AvatarPane |
Inheritance | AvatarPane ![]() |
Since : | ReactorGUI 1.0.0 |
Method | Defined By | ||
---|---|---|---|
AvatarPane(defaultAvatarIconClass:Class, defaultAvatarSpeed:int = 100, room:Room = null)
Constructor
| AvatarPane | ||
getAllAvatars():Array
Returns an Array of all Avatar objects currently in this AvatarPane's
avatar list. | AvatarPane | ||
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 |
AvatarPane | () | Constructor |
public function AvatarPane(defaultAvatarIconClass:Class, defaultAvatarSpeed:int = 100, room:Room = null)
Constructor
ParametersdefaultAvatarIconClass: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.
|
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.
ReturnsArray |
getAvatar | () | method |
public function getAvatar(clientID:String):Avatar
Since : | ReactorGUI 1.0.0 |
Returns the Avatar object for the specified clientID.
Parameters
clientID:String |
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 |