com.threerings.whirled.spot.data.ClusteredBodyObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vilya Show documentation

The newest version!

//
// $Id$
//
// Vilya library - tools for developing networked games
// Copyright (C) 2002-2012 Three Rings Design, Inc., All Rights Reserved
// http://code.google.com/p/vilya/
//
// 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.whirled.spot.data;

import com.threerings.crowd.data.BodyObject;

/**
 * Defines some required methods for a {@link BodyObject} that is to participate in the Whirled
 * Spot system.
 */
public interface ClusteredBodyObject
{
    /**
     * Returns the field name of the cluster oid distributed object field.
     */
    public String getClusterField ();

    /**
     * Returns the oid of the cluster to which this user currently belongs.
     */
    public int getClusterOid ();

    /**
     * Sets the oid of the cluster to which this user currently belongs.
     */
    public void setClusterOid (int clusterOid);
}