narya/src/as/com/threerings/crowd/data/PlaceObject.as

//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2010 Three Rings Design, Inc., All Rights Reserved
// http://code.google.com/p/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.crowd.data {

import com.threerings.util.Iterator;
import com.threerings.util.Name;

import com.threerings.io.ObjectInputStream;
import com.threerings.io.ObjectOutputStream;

import com.threerings.presents.dobj.DObject;
import com.threerings.presents.dobj.DSet;
import com.threerings.presents.dobj.OidList;

import com.threerings.crowd.chat.data.SpeakMarshaller;
//import com.threerings.crowd.chat.data.SpeakObject;

/**
 * A distributed object that contains information on a place that is
 * occupied by bodies. This place might be a chat room, a game room, an
 * island in a massively multiplayer piratical universe, anything that has
 * occupants that might want to chat with one another.
 */
public class PlaceObject extends DObject
{
    // AUTO-GENERATED: FIELDS START
    /** The field name of the <code>occupants</code> field. */
    public static const OCCUPANTS :String = "occupants";

    /** The field name of the <code>occupantInfo</code> field. */
    public static const OCCUPANT_INFO :String = "occupantInfo";

    /** The field name of the <code>speakService</code> field. */
    public static const SPEAK_SERVICE :String = "speakService";
    // AUTO-GENERATED: FIELDS END

    /**
     * Allows the client to call methods on the manager.
     */
    public var manager :ManagerCaller;

    /**
     * Tracks the oid of the body objects of all of the occupants of this
     * place.
     */
    public var occupants :OidList = new OidList();

    /**
     * Contains an info record (of type {@link OccupantInfo}) for each
     * occupant that contains information about that occupant that needs
     * to be known by everyone in the place. <em>Note:</em> Don't obtain
     * occupant info records directly from this set when on the server,
     * use <code>PlaceManager.getOccupantInfo()</code> instead (along with
     * <code>PlaceManager.updateOccupantInfo()</code>) because it does
     * some special processing to ensure that readers and updaters don't
     * step on one another even if they make rapid fire changes to a
     * user's occupant info.
     */
    public var occupantInfo :DSet = new DSet();

    /** Used to generate speak requests on this place object. */
    public var speakService :SpeakMarshaller;

    /**
     * We need a constructor here in actionscript to set up the
     * ManagerCaller.
     */
    public function PlaceObject ()
    {
        super();
        manager = new ManagerCaller(this);
    }

    /**
     * Looks up a user's occupant info by name.
     *
     * @return the occupant info record for the named user or null if no
     * user in the room has that username.
     */
    public function getOccupantInfo (username :Name) :OccupantInfo
    {
        var itr :Iterator = occupantInfo.iterator();
        while (itr.hasNext()) {
            var info :OccupantInfo = (itr.next() as OccupantInfo);
            if (info.username.equals(username)) {
                return info;
            }
        }
        return null;
    }

//    // AUTO-GENERATED: METHODS START
//    /**
//     * Requests that <code>oid</code> be added to the <code>occupants</code>
//     * oid list. The list will not change until the event is actually
//     * propagated through the system.
//     */
//    public function addToOccupants (oid :int) :void
//    {
//        requestOidAdd(OCCUPANTS, oid);
//    }
//
//    /**
//     * Requests that <code>oid</code> be removed from the
//     * <code>occupants</code> oid list. The list will not change until the
//     * event is actually propagated through the system.
//     */
//    public function removeFromOccupants (oid :int) :void
//    {
//        requestOidRemove(OCCUPANTS, oid);
//    }
//
//    /**
//     * Requests that the specified entry be added to the
//     * <code>occupantInfo</code> set. The set will not change until the event is
//     * actually propagated through the system.
//     */
//    public function addToOccupantInfo (elem :DSet_Entry) :void
//    {
//        requestEntryAdd(OCCUPANT_INFO, elem);
//    }
//
//    /**
//     * Requests that the entry matching the supplied key be removed from
//     * the <code>occupantInfo</code> set. The set will not change until the
//     * event is actually propagated through the system.
//     */
//    public function removeFromOccupantInfo (key :Object) :void
//    {
//        requestEntryRemove(OCCUPANT_INFO, key);
//    }
//
//    /**
//     * Requests that the specified entry be updated in the
//     * <code>occupantInfo</code> set. The set will not change until the event is
//     * actually propagated through the system.
//     */
//    public function updateOccupantInfo (elem :DSet_Entry) :void
//    {
//        requestEntryUpdate(OCCUPANT_INFO, elem);
//    }
//
//    /**
//     * Requests that the <code>occupantInfo</code> field be set to the
//     * specified value. Generally one only adds, updates and removes
//     * entries of a distributed set, but certain situations call for a
//     * complete replacement of the set value. The local value will be
//     * updated immediately and an event will be propagated through the
//     * system to notify all listeners that the attribute did
//     * change. Proxied copies of this object (on clients) will apply the
//     * value change when they received the attribute changed notification.
//     */
//    public function setOccupantInfo (value :DSet) :void
//    {
//        requestAttributeChange(OCCUPANT_INFO, value, this.occupantInfo);
//        this.occupantInfo = (value == null) ? null : value;
//    }
//
//    /**
//     * Requests that the <code>speakService</code> field be set to the
//     * specified value. The local value will be updated immediately and an
//     * event will be propagated through the system to notify all listeners
//     * that the attribute did change. Proxied copies of this object (on
//     * clients) will apply the value change when they received the
//     * attribute changed notification.
//     */
//    public function setSpeakService (value :SpeakMarshaller) :void
//    {
//        var ovalue :SpeakMarshaller = this.speakService;
//        requestAttributeChange(
//            SPEAK_SERVICE, value, ovalue);
//        this.speakService = value;
//    }
//    // AUTO-GENERATED: METHODS END
//
//    // documentation inherited
//    override public function writeObject (out :ObjectOutputStream) :void
//    {
//        super.writeObject(out);
//        out.writeObject(occupants);
//        out.writeObject(occupantInfo);
//        out.writeObject(speakService);
//    }

    // documentation inherited
    override public function readObject (ins :ObjectInputStream) :void
    {
        super.readObject(ins);
        occupants = OidList(ins.readObject());
        occupantInfo = DSet(ins.readObject());
        speakService = SpeakMarshaller(ins.readObject());
    }
}
}