//
// $Id: DropGameUtil.java,v 1.2 2004/08/27 02:20:31 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.puzzle.drop.util;

import java.awt.event.KeyEvent;

import com.threerings.util.KeyTranslatorImpl;

import com.threerings.puzzle.drop.client.DropControllerDelegate;
import com.threerings.puzzle.util.PuzzleGameUtil;

/**
 * Drop puzzle game related utilities.
 */
public class DropGameUtil
{
    /**
     * Returns a key translator configured with mappings suitable for a
     * drop puzzle game.
     */
    public static KeyTranslatorImpl getKeyTranslator ()
    {
        // start with the standard puzzle key mappings
        KeyTranslatorImpl xlate = PuzzleGameUtil.getKeyTranslator();

        // add all press key mappings
        xlate.addPressCommand(KeyEvent.VK_LEFT,
                              DropControllerDelegate.MOVE_BLOCK_LEFT,
                              MOVE_RATE, MOVE_DELAY);
        xlate.addPressCommand(KeyEvent.VK_RIGHT,
                              DropControllerDelegate.MOVE_BLOCK_RIGHT,
                              MOVE_RATE, MOVE_DELAY);
        xlate.addPressCommand(KeyEvent.VK_UP,
                              DropControllerDelegate.ROTATE_BLOCK_CCW, 0);
        xlate.addPressCommand(KeyEvent.VK_DOWN,
                              DropControllerDelegate.ROTATE_BLOCK_CW, 0);
        xlate.addPressCommand(KeyEvent.VK_SPACE,
                              DropControllerDelegate.START_DROP_BLOCK, 0);

        // add all release key mappings
        xlate.addReleaseCommand(KeyEvent.VK_SPACE,
                                DropControllerDelegate.END_DROP_BLOCK);

        return xlate;
    }

    /** The move key repeat rate in moves per second. */
    protected static final int MOVE_RATE = 7;

    /** The delay in milliseconds before the move keys begin to repeat. */
    protected static final long MOVE_DELAY = 300L;
}
