All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.threerings.puzzle.data.PuzzleObject Maven / Gradle / Ivy

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.puzzle.data;

import javax.annotation.Generated;
import com.threerings.parlor.game.data.GameObject;

/**
 * Extends the basic {@link GameObject} to add individual player status. Puzzle games typically
 * contain numerous players that may be knocked out of the game while the overall game continues
 * on, thereby necessitating this second level of game status.
 */
public class PuzzleObject extends GameObject
    implements PuzzleCodes
{
    // AUTO-GENERATED: FIELDS START
    /** The field name of the puzzleGameService field. */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public static final String PUZZLE_GAME_SERVICE = "puzzleGameService";

    /** The field name of the difficulty field. */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public static final String DIFFICULTY = "difficulty";

    /** The field name of the summaries field. */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public static final String SUMMARIES = "summaries";

    /** The field name of the seed field. */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public static final String SEED = "seed";
    // AUTO-GENERATED: FIELDS END

    /** Provides general puzzle game invocation services. */
    public PuzzleGameMarshaller puzzleGameService;

    /** The puzzle difficulty level. */
    public int difficulty;

    /** Summaries of the boards of all players in this puzzle (may be null if the puzzle doesn't
     * support individual player boards). */
    public BoardSummary[] summaries;

    /** The seed used to germinate the boards. */
    public long seed;

    // AUTO-GENERATED: METHODS START
    /**
     * Requests that the puzzleGameService 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.
     */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public void setPuzzleGameService (PuzzleGameMarshaller value)
    {
        PuzzleGameMarshaller ovalue = this.puzzleGameService;
        requestAttributeChange(
            PUZZLE_GAME_SERVICE, value, ovalue);
        this.puzzleGameService = value;
    }

    /**
     * Requests that the difficulty 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.
     */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public void setDifficulty (int value)
    {
        int ovalue = this.difficulty;
        requestAttributeChange(
            DIFFICULTY, Integer.valueOf(value), Integer.valueOf(ovalue));
        this.difficulty = value;
    }

    /**
     * Requests that the summaries 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.
     */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public void setSummaries (BoardSummary[] value)
    {
        BoardSummary[] ovalue = this.summaries;
        requestAttributeChange(
            SUMMARIES, value, ovalue);
        this.summaries = (value == null) ? null : value.clone();
    }

    /**
     * Requests that the indexth element of
     * summaries 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.
     */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public void setSummariesAt (BoardSummary value, int index)
    {
        BoardSummary ovalue = this.summaries[index];
        requestElementUpdate(
            SUMMARIES, index, value, ovalue);
        this.summaries[index] = value;
    }

    /**
     * Requests that the seed 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.
     */
    @Generated(value={"com.threerings.presents.tools.GenDObjectTask"})
    public void setSeed (long value)
    {
        long ovalue = this.seed;
        requestAttributeChange(
            SEED, Long.valueOf(value), Long.valueOf(ovalue));
        this.seed = value;
    }
    // AUTO-GENERATED: METHODS END
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy