peril.ai.api

Interface Army

public interface Army

Provides information about a army consisting of Units.

Since:

2018-03-16

Version:

1.01.05

Author:

Joshua_Eddy

Method Summary

Modifier and Type	Method and Description
int	getNumberOf(Unit unit) Retrieves a number of a specific type of Unit that are currently in this Army.
int	getNumberOfUnits() Retrieves the number of Units in this Army
int	getStrength() Retrieves the combined strength of all the Units in this Army.
Unit	getStrongestUnit() Retrieves the strongest Unit in this Army.
java.util.Set<? extends Unit>	getUnits() Retrieves the Units from this Army.
Unit	getWeakestUnit() Retrieves the weakest Unit in this Army.
boolean	hasUnit(Unit unit) Retrieves a whether a specific type of Unit is currently in this Army.

Method Detail

getUnits

java.util.Set<? extends Unit> getUnits()

Retrieves the Units from this Army. This does not reflect the number of each Unit in the Army

Returns:

The Set<Unit> of Units.

getStrongestUnit

Unit getStrongestUnit()

Retrieves the strongest Unit in this Army. If there are no Units in this Army this returns null.

Returns:

Strongest Unit in this Army.

getWeakestUnit

Unit getWeakestUnit()

Retrieves the weakest Unit in this Army. If there are no Units in this Army this returns null.

Returns:

Weakest Unit in this Army.

getStrength

int getStrength()

Retrieves the combined strength of all the Units in this Army.

Returns:

The Army's total strength.

getNumberOf

int getNumberOf(Unit unit)

Retrieves a number of a specific type of Unit that are currently in this Army.

Parameters:

unit - The Unit.

Returns:

The number of the specified Unit.

hasUnit

boolean hasUnit(Unit unit)

Retrieves a whether a specific type of Unit is currently in this Army.

Parameters:

unit - Unit

Returns:

Whether a specific type of Unit is currently in this Army.

getNumberOfUnits

int getNumberOfUnits()

Retrieves the number of Units in this Army

Returns:

The number of Units.