Michael Bayne
a9720fd905
git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3099 542714f4-19e9-0310-aa3c-eee0fc999fb1
57 lines
1.9 KiB
Java
57 lines
1.9 KiB
Java
//
|
|
// $Id: TurnGameObject.java,v 1.7 2004/08/27 02:20:15 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.parlor.turn;
|
|
|
|
import com.threerings.util.Name;
|
|
|
|
/**
|
|
* Games that wish to support turn-based play must implement this
|
|
* interface with their {@link GameObject}.
|
|
*/
|
|
public interface TurnGameObject
|
|
{
|
|
/**
|
|
* Returns the distributed object field name of the
|
|
* <code>turnHolder</code> field in the object that implements this
|
|
* interface.
|
|
*/
|
|
public String getTurnHolderFieldName ();
|
|
|
|
/**
|
|
* Returns the username of the player who is currently taking their
|
|
* turn in this turn-based game or <code>null</code> if no user
|
|
* currently holds the turn.
|
|
*/
|
|
public Name getTurnHolder ();
|
|
|
|
/**
|
|
* Requests that the <code>turnHolder</code> field be set to the specified
|
|
* value.
|
|
*/
|
|
public void setTurnHolder (Name turnHolder);
|
|
|
|
/**
|
|
* Returns the array of player names involved in the game.
|
|
*/
|
|
public Name[] getPlayers ();
|
|
}
|