Player (ConvexMerger v1.2 API)

java.lang.Object
- dev.roanh.convexmerger.player.Player

All Implemented Interfaces:

Identity

Direct Known Subclasses:

ExampleAnimation.DummyPlayer, GreedyPlayer, HumanPlayer, LocalPlayer, ResultOverlay.AveragePlayer
```
public abstract class Player
extends java.lang.Object
implements Identity
```
Abstract base class for player instances.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Player.MergeOption` Class describing a possible merge that a player could perform.
`class`	`Player.PlayerStats` Class holding various game related player statistics.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`ai` If this player is an AI or not.
`private double`	`area` The total area claimed by this player.
`private int`	`id` The ID of this player.
`private boolean`	`local` Whether this player is local or acting as remote proxy.
`private java.lang.String`	`name` The name for this player.
`private ScoreAnimation`	`scoreAnimation` The score animation for this player.
`protected GameState`	`state` The game this player is associated with.
`protected Player.PlayerStats`	`stats` The game stats for this player.
`private Theme.PlayerTheme`	`theme` The theme for this player.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Player(boolean local, boolean ai, java.lang.String name)
Constructs a new player instance.

Constructors
Modifier	Constructor and Description
`protected`	`Player(boolean local, boolean ai, java.lang.String name)` Constructs a new player instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArea(double area)` Adds some claimed area to this player.
`boolean`	`equals(java.lang.Object other)`
`abstract boolean`	`executeMove()` Executes a move for this player.
`protected Player.MergeOption`	`findBestMergeFrom(ConvexObject obj)` Finds the best possible merge (largest relative area gain) from the given object for this player.
`protected ConvexObject`	`findLargestUnownedObject()` Finds the largest unowned object left in the current game state.
`protected ConvexObject`	`findLargestUnownedObject(java.util.Comparator<java.lang.Double> comparator)` Finds the largest unowned object left in the current game state according to the given comparator.
`double`	`getArea()` Gets the total area claimed by this player.
`int`	`getID()` Gets the ID of this entity.
`java.lang.String`	`getName()` Gets the name of this player.
`PlayerProxy`	`getProxy()` Gets a proxy for this player.
`ScoreAnimation`	`getScoreAnimation()` Getst the animation rendering the score for this player.
`Player.PlayerStats`	`getStats()` Gets the game stats for this player.
`Theme.PlayerTheme`	`getTheme()` Gets the color theme for this player.
`int`	`hashCode()`
`protected boolean`	`hasMergeFrom(ConvexObject obj)` Checks if there exists a possible valid merge from the given object to any other object.
`void`	`init(GameState game, Theme.PlayerTheme theme)` Initialises this player with the given game state and theme.
`boolean`	`isAI()` Checks if this player is an AI.
`boolean`	`isLocal()` Checks if this player is executing locally or acting as a remote proxy.
`boolean`	`owns(ConvexObject obj)` Checks if this player owns the given object.
`void`	`removeArea(double area)` Removes some claimed area from this player.
`void`	`setID(int id)` Sets the ID of this entity.
`protected void`	`setName(java.lang.String name)` Sets the name of this player.
`java.util.stream.Stream<ConvexObject>`	`stream()` Streams all the objects owned by this player.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
private int id
```
    The ID of this player.
  - state
```
protected GameState state
```
    The game this player is associated with.
  - stats
```
protected Player.PlayerStats stats
```
    The game stats for this player.
  - scoreAnimation
```
private ScoreAnimation scoreAnimation
```
    The score animation for this player.
  - name
```
private java.lang.String name
```
    The name for this player.
  - ai
```
private boolean ai
```
    If this player is an AI or not.
  - theme
```
private Theme.PlayerTheme theme
```
    The theme for this player.
  - area
```
private double area
```
    The total area claimed by this player.
  - local
```
private boolean local
```
    Whether this player is local or acting as remote proxy.
- Constructor Detail
  - Player
```
protected Player(boolean local,
                 boolean ai,
                 java.lang.String name)
```
    Constructs a new player instance.
    
    Parameters:
    
    local - Whether this player is local or acting as remote proxy.
    
    ai - Whether this player is an AI.
    
    name - The name of this player.
- Method Detail
  - init
```
public void init(GameState game,
                 Theme.PlayerTheme theme)
```
    Initialises this player with the given game state and theme.
    
    Parameters:
    
    game - The game this player is now a part of.
    
    theme - The color theme for this player.
  - executeMove
```
public abstract boolean executeMove()
                             throws java.lang.InterruptedException
```
    Executes a move for this player.
    
    Returns:
    
    True if the move was executed successfully, false if no possible move was found (game end).
    
    Throws:
    
    java.lang.InterruptedException - When the player was interrupted while making its move. Signalling that the game was aborted.
  - isLocal
```
public boolean isLocal()
```
    Checks if this player is executing locally or acting as a remote proxy.
    
    Returns:
    
    True if this player is local.
  - getTheme
```
public Theme.PlayerTheme getTheme()
```
    Gets the color theme for this player.
    
    Returns:
    
    The color theme for this player.
  - isAI
```
public boolean isAI()
```
    Checks if this player is an AI.
    
    Returns:
    
    True if this player is an AI.
  - addArea
```
public void addArea(double area)
```
    Adds some claimed area to this player.
    
    Parameters:
    
    area - The area that was claimed.
  - removeArea
```
public void removeArea(double area)
```
    Removes some claimed area from this player.
    
    Parameters:
    
    area - The area to remove.
  - getArea
```
public double getArea()
```
    Gets the total area claimed by this player.
    
    Returns:
    
    The total claimed area for this player.
  - getName
```
public java.lang.String getName()
```
    Gets the name of this player.
    
    Returns:
    
    The name of this player.
  - owns
```
public boolean owns(ConvexObject obj)
```
    Checks if this player owns the given object.
    
    Parameters:
    
    obj - The object to check.
    
    Returns:
    
    True if this player owns the given object.
  - getScoreAnimation
```
public ScoreAnimation getScoreAnimation()
```
    Getst the animation rendering the score for this player.
    
    Returns:
    
    The score rendering animation for this player.
  - stream
```
public java.util.stream.Stream<ConvexObject> stream()
```
    Streams all the objects owned by this player.
    
    Returns:
    
    A stream of all the objects owned by this player.
  - findLargestUnownedObject
```
protected ConvexObject findLargestUnownedObject()
```
    Finds the largest unowned object left in the current game state.
    
    Returns:
    
    The largest unowned object or null if there are no unowned object left in the game.
  - findLargestUnownedObject
```
protected ConvexObject findLargestUnownedObject(java.util.Comparator<java.lang.Double> comparator)
```
    Finds the largest unowned object left in the current game state according to the given comparator.
    
    Parameters:
    
    comparator - The comparator to use to compare object sizes.
    
    Returns:
    
    The largest unowned object or null if there are no unowned object left in the game.
  - setName
```
protected void setName(java.lang.String name)
```
    Sets the name of this player.
    
    Parameters:
    
    name - The new player name.
  - hasMergeFrom
```
protected boolean hasMergeFrom(ConvexObject obj)
```
    Checks if there exists a possible valid merge from the given object to any other object. The given object does not need to be owned by this player.
    
    Parameters:
    
    obj - The object to check merges for.
    
    Returns:
    
    True if a merge exists from the given object.
  - findBestMergeFrom
```
protected Player.MergeOption findBestMergeFrom(ConvexObject obj)
```
    Finds the best possible merge (largest relative area gain) from the given object for this player.
    
    Parameters:
    
    obj - The object to check from.
    
    Returns:
    
    The best possible merge option or null if there are no possible merges left in the game.
  - getProxy
```
public PlayerProxy getProxy()
```
    Gets a proxy for this player.
    
    Returns:
    
    The proxy for this player.
  - getStats
```
public Player.PlayerStats getStats()
```
    Gets the game stats for this player.
    
    Returns:
    
    The game stats for this player.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getID
```
public int getID()
```
    Description copied from interface: Identity
    
    Gets the ID of this entity.
    
    Specified by:
    
    getID in interface Identity
    
    Returns:
    
    The ID of this entity.
  - setID
```
public void setID(int id)
```
    Description copied from interface: Identity
    
    Sets the ID of this entity.
    
    Specified by:
    
    setID in interface Identity
    
    Parameters:
    
    id - The new ID of this entity, must be unique.

Class Player

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

state

stats

scoreAnimation

name

ai

theme

area

local

Constructor Detail

Player

Method Detail

init

executeMove

isLocal

getTheme

isAI

addArea

removeArea

getArea

getName

owns

getScoreAnimation

stream

findLargestUnownedObject

findLargestUnownedObject

setName

hasMergeFrom

findBestMergeFrom

getProxy

getStats

hashCode

equals

toString

getID

setID