Electrotank.Electroserver5.Api.GetRoomsInZoneResponse Class Reference

This the response to the GetRoomsInZoneRequest. More...

Inheritance diagram for Electrotank.Electroserver5.Api.GetRoomsInZoneResponse:

Public Member Functions
	GetRoomsInZoneResponse ()
	GetRoomsInZoneResponse (TBase t)
override TBase	ToThrift ()
override TBase	NewThrift ()
override void	FromThrift (TBase t_)
Public Member Functions inherited from Electrotank.Electroserver5.Api.EsResponse
	EsResponse ()

Properties
int	ZoneId [get, set]
	Id of the zone that contains these rooms. More...
string	ZoneName [get, set]
	Name of the zone that contains these rooms. More...
List< RoomListEntry >	Entries [get, set]
	List of RoomListEntry objects that describe the rooms in the zone. More...

Detailed Description

This the response to the GetRoomsInZoneRequest.

This response contains a list of RoomListEntry object, each describing a room in that zone.

      This example shows how to request the rooms in a zone, listen for the response to that request, and print out the results.

private var _es:ElectroServer;

private function initialize():void {
        _es.engine.addEventListener(MessageType.GetRoomsInZoneResponse.name, onGetRoomsInZoneResponse);

        var griz:GetRoomsInZoneRequest = new GetRoomsInZoneRequest();
        griz.zoneName = "GameZone";
        _es.engine.send(griz);
}

private function onGetRoomsInZoneResponse(e:GetRoomsInZoneResponse):void {
        trace("Zone: "+e.zoneName + ", " + e.zoneName.toString());
        for each (var rle:RoomListEntry in e.entries) {
                trace("Room: "+rle.roomName + ", " + rle.roomId.toString());
        }
}

Constructor & Destructor Documentation

Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.GetRoomsInZoneResponse

(

)

Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.GetRoomsInZoneResponse

(

TBase

t

)

Member Function Documentation

override void Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.FromThrift ( TBase  t_ )

virtual

Implements Electrotank.Electroserver5.Api.EsMessage.

override TBase Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.NewThrift ( )

virtual

Implements Electrotank.Electroserver5.Api.EsMessage.

override TBase Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.ToThrift ( )

virtual

Implements Electrotank.Electroserver5.Api.EsMessage.

Property Documentation

List<RoomListEntry> Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.Entries

getset

List of RoomListEntry objects that describe the rooms in the zone.

int Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.ZoneId

getset

Id of the zone that contains these rooms.

string Electrotank.Electroserver5.Api.GetRoomsInZoneResponse.ZoneName

getset

Name of the zone that contains these rooms.