com.threerings.parlor.turn.data.TurnGameObject 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.parlor.turn.data;

import com.threerings.util.Name;

import com.threerings.parlor.game.data.GameObject;

/**
 * Games that wish to support turn-based play must implement this
 * interface with their {@link GameObject}.
 */
public interface TurnGameObject
{
    /** A special value used to communicate to the client that the current
     * turn holder was replaced (perhaps due to disconnection or departure
     * and being replaced by an AI). */
    public static final Name TURN_HOLDER_REPLACED =
        new Name("__TURN_HOLDER_REPLACED__");

    /**
     * Returns the distributed object field name of the
     * turnHolder 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 null if no user
     * currently holds the turn.
     */
    public Name getTurnHolder ();

    /**
     * Requests that the turnHolder 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 ();

    /**
     * Returns true if the game is in play, false if not. If a game is not in
     * play after a turn has ended, the next turn will not be started.
     */
    public boolean isInPlay ();
}