Michael Bayne
1f8c4578b7
git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3098 542714f4-19e9-0310-aa3c-eee0fc999fb1
95 lines
3.2 KiB
Java
95 lines
3.2 KiB
Java
//
|
|
// $Id: OccupantInfo.java,v 1.14 2004/08/27 02:12:33 mdb Exp $
|
|
//
|
|
// Narya library - tools for developing networked games
|
|
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
|
|
// http://www.threerings.net/code/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.io.TrackedStreamableObject;
|
|
import com.threerings.util.Name;
|
|
|
|
import com.threerings.presents.dobj.DSet;
|
|
|
|
/**
|
|
* The occupant info object contains all of the information about an
|
|
* occupant of a place that should be shared with other occupants of the
|
|
* place. These objects are stored in the place object itself and are
|
|
* updated when bodies enter and exit a place.
|
|
*
|
|
* <p> A system that builds upon the Crowd framework can extend this class
|
|
* to include extra information about their occupants. They will need to
|
|
* be sure to return the proper class from {@link
|
|
* com.threerings.crowd.server.PlaceManager#getOccupantInfoClass} and
|
|
* populate their occupant info in {@link
|
|
* com.threerings.crowd.server.PlaceManager#populateOccupantInfo}.
|
|
*
|
|
* <p> Note also that this class implements {@link Cloneable} which means
|
|
* that if derived classes add non-primitive attributes, they are
|
|
* responsible for adding the code to clone those attributes when a clone
|
|
* is requested.
|
|
*/
|
|
public class OccupantInfo extends TrackedStreamableObject
|
|
implements DSet.Entry, Cloneable
|
|
{
|
|
/** Constant value for {@link #status}. */
|
|
public static final byte ACTIVE = 0;
|
|
|
|
/** Constant value for {@link #status}. */
|
|
public static final byte IDLE = 1;
|
|
|
|
/** Constant value for {@link #status}. */
|
|
public static final byte DISCONNECTED = 2;
|
|
|
|
/** Maps status codes to human readable strings. */
|
|
public static final String[] X_STATUS = { "active", "idle", "discon" };
|
|
|
|
/** The body object id of this occupant (and our entry key). */
|
|
public Integer bodyOid;
|
|
|
|
/** The username of this occupant. */
|
|
public Name username;
|
|
|
|
/** The status of this occupant. */
|
|
public byte status = ACTIVE;
|
|
|
|
/** Access to the body object id as an int. */
|
|
public int getBodyOid ()
|
|
{
|
|
return bodyOid.intValue();
|
|
}
|
|
|
|
// documentation inherited
|
|
public Comparable getKey ()
|
|
{
|
|
return bodyOid;
|
|
}
|
|
|
|
/**
|
|
* Generates a cloned copy of this instance.
|
|
*/
|
|
public Object clone ()
|
|
{
|
|
try {
|
|
return super.clone();
|
|
} catch (CloneNotSupportedException cnse) {
|
|
throw new RuntimeException("WTF? " + cnse);
|
|
}
|
|
}
|
|
}
|