com.barrybecker4.game.multiplayer.common.MultiGamePlayer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bb4-multiplayer Show documentation
bb4-games java code.
There is a newer version: 1.6
/** Copyright by Barry G. Becker, 2000-2011. Licensed under MIT License: http://www.opensource.org/licenses/MIT  */
package com.barrybecker4.game.multiplayer.common;

import com.barrybecker4.game.common.online.server.IServerConnection;
import com.barrybecker4.game.common.player.Player;
import com.barrybecker4.game.common.player.PlayerAction;
import com.barrybecker4.game.common.player.PlayerList;
import com.barrybecker4.game.multiplayer.common.online.SurrogateMultiPlayer;
import com.barrybecker4.ui.util.ColorUtil;

import java.awt.*;

/**
 * A player in a multi-player game.
 * @author Barry Becker
 */
public abstract class MultiGamePlayer extends Player {

    private static final long serialVersionUID = 1;

    private static final float SATURATION = 0.8f;
    private static final float BRIGHTNESS = 0.999f;

    protected MultiGamePlayer(String name, Color color, boolean isHuman) {
        super(name, color, isHuman);
    }

    /**
     * A key abstraction for multi game players.
     * @return this players action
     */
    public abstract PlayerAction getAction(MultiGameController controller);

    /**
     * @param action to set.
     */
    public abstract void setAction(PlayerAction action);

    /**
     * try to give a unique color based on the name
     * and knowing what the current player colors are.
     * @return new player color
     */
    public static Color getNewPlayerColor(PlayerList players) {
        boolean uniqueEnough;
        float candidateHue;

        do {
            // keep trying hues until we find one that is not within tolerance distance from another
            candidateHue = (float)Math.random();
            uniqueEnough = isHueUniqueEnough(candidateHue, players);
        } while (!uniqueEnough);

        return Color.getHSBColor(candidateHue, SATURATION, BRIGHTNESS);
    }

    /**
     * @@ this method could use some improvement
     * @param hue to check for uniqueness compared to other players.
     * @param players players playing the game.
     * @return true if hue is different enough from the others.
     */
    private static boolean isHueUniqueEnough(float hue, PlayerList players) {
        int ct = 0;
        float tolerance = 1.0f / (1.0f + 1.8f * players.size());
        while ( ct < players.size()) {
            if (players.get(ct) == null) {
                ct++;
            }
            else if (Math.abs(ColorUtil.getColorHue(players.get(ct).getColor()) - hue) > tolerance) {
                ct++;
            }
            else break;
        }
        return (ct == players.size());
    }

    public MultiPlayerMarker getPiece() {
        assert false: "no piece support for " + this.getClass().getName() + ". Use getActualPlayer().getPiece()";
        return null;
    }

    @Override
    public Player createSurrogate(IServerConnection connection) {
        return new SurrogateMultiPlayer(this, connection);
    }

}