| Package | com.multiuserserver.client |
| Class | public class MultiuserServerClientInfo |
This class is usually accessed via the info property of the MultiuserServerClient class, .
Changing the properties of this object while connected will have no affect on the current connection and should be avoided.
Availability: 2.0.0
See also
| Property | Defined by | ||
|---|---|---|---|
| application : String
The name of the server-side application to which you are connected,
or were connected to before the connection was closed.
| MultiuserServerClientInfo | ||
| clientIndex : int
Index of the client in the server's application.clients Array: think of this as the user ID you
have been allocated; -1 indicates that you have not been allocated an ID.
| MultiuserServerClientInfo | ||
| clientsPerRoom : uint
The maximum number of client that can be in the current room at any one time.
| MultiuserServerClientInfo | ||
| connectData : *
Client-specific data that will be passed to the MultiuserServerEvent.CLIENT_CONNECT event.
| MultiuserServerClientInfo | ||
| ip : String
The IP address on which you are connected, or were connected to before
the connection was closed.
| MultiuserServerClientInfo | ||
| language : String
The language, or other application sub-division, in which you are connected,
or were connected to before the connection was closed (Read-only)
Availability: 2.0.0 | MultiuserServerClientInfo | ||
| port : uint
The port on which you are connected, or were connected to before the
connection was closed.
| MultiuserServerClientInfo | ||
| room : int
The room number into which you have been allocated, or were most recently allocated before
the connection was closed; -1 indicates that no room has been allocated.
| MultiuserServerClientInfo | ||
| roomToAvoid : int
The client will NOT be allocated a space in the specified room, even if that room has an available space;
-1 indicates that no room will be avoided.
| MultiuserServerClientInfo | ||
| roomToUse : int
The server will try to allocate the client to the specifed room ONLY, and will fail if the room is already full;
-1 indicates that no room preference has been stated.
| MultiuserServerClientInfo | ||
| Method | Defined by | ||
|---|---|---|---|
|
MultiuserServerClientInfo(ip:String, port:int, application:String, clientsPerRoom:uint, language:String = "default", roomToAvoid:int = -1, roomToUse:int = -1, connectData:int = null, clientIndex:int = -1, room:* = -1)
| MultiuserServerClientInfo | ||
| MultiuserServerClientInfo | |||
| application | property |
public var application:StringThe name of the server-side application to which you are connected, or were connected to before the connection was closed. (Read-only)
Availability: 2.0.0
This property can be used as the source for data binding.
| clientIndex | property |
public var clientIndex:intIndex of the client in the server's application.clients Array: think of this as the user ID you have been allocated; -1 indicates that you have not been allocated an ID. (Read-only)
Availability: 2.0.0
This property can be used as the source for data binding.
| clientsPerRoom | property |
public var clientsPerRoom:uintThe maximum number of client that can be in the current room at any one time. (Read-only)
Availability: 2.0.0
This property can be used as the source for data binding.
| connectData | property |
public var connectData:*Client-specific data that will be passed to the MultiuserServerEvent.CLIENT_CONNECT event.
This property can be used as the source for data binding.
| ip | property |
public var ip:StringThe IP address on which you are connected, or were connected to before the connection was closed. (Read-only)
Availability: 2.0.0
This property can be used as the source for data binding.
| language | property |
public var language:StringThe language, or other application sub-division, in which you are connected, or were connected to before the connection was closed (Read-only)
Availability: 2.0.0
This property can be used as the source for data binding.
| port | property |
public var port:uintThe port on which you are connected, or were connected to before the connection was closed. (Read-only)
Availability: 2.0.0
This property can be used as the source for data binding.
| room | property |
public var room:intThe room number into which you have been allocated, or were most recently allocated before the connection was closed; -1 indicates that no room has been allocated. (Read-only)
Availability: 2.0.0
This property can be used as the source for data binding.
| roomToAvoid | property |
public var roomToAvoid:intThe client will NOT be allocated a space in the specified room, even if that room has an available space; -1 indicates that no room will be avoided. If both roomToUse and roomToAvoid are specified, roomToAvoid will be ignored.
This property can be used as the source for data binding.
| roomToUse | property |
public var roomToUse:intThe server will try to allocate the client to the specifed room ONLY, and will fail if the room is already full; -1 indicates that no room preference has been stated.
This property can be used as the source for data binding.
| MultiuserServerClientInfo | () | constructor |
public function MultiuserServerClientInfo(ip:String, port:int, application:String, clientsPerRoom:uint, language:String = "default", roomToAvoid:int = -1, roomToUse:int = -1, connectData:int = null, clientIndex:int = -1, room:* = -1)Parameters
ip:String |
|
port:int |
|
application:String |
|
clientsPerRoom:uint |
|
language:String (default = "default") |
|
roomToAvoid:int (default = -1) |
|
roomToUse:int (default = -1) |
|
connectData:int (default = null) |
|
clientIndex:int (default = -1) |
|
room:* (default = -1) |
| clone | () | method |