fr.arakne.utils.maps.sight

Class CellSight<C extends BattlefieldCell>

java.lang.Object

fr.arakne.utils.maps.sight.CellSight<C>

Type Parameters:

C - The cell type

public final class CellSight<C extends BattlefieldCell>
extends Object

Handle the line of sight from a given cell

Constructor Summary

Constructors

Constructor and Description
CellSight(BattlefieldSight<C> battlefield, CoordinateCell<C> source)
CellSight(CoordinateCell<C> source)

Method Summary

Modifier and Type	Method and Description
Collection<C>	accessible()
Collection<C>	blocked()
void	forEach(BiConsumer<C,Boolean> cellViewConsumer) Iterate over all map cells, and check for each cells is the line of sight is free final CellSight<FightCell> sight = fighter.cell().sight(); final CoordinateCell<FightCell> to = new CoordinateCell<>(target.cell()); sight.forEach((cell, free) -> { if (free) { performActionOnAccessibleCell(cell); } });
boolean	isFree(C target) Check if the line of sight is free towards the target Usage: {@code final CellSight sight = fighter.cell().sight(); if (!
boolean	isFree(CoordinateCell<C> target) Check if the line of sight is free towards the target Usage: {@code final CellSight sight = fighter.cell().sight(); if (!
Iterator<C>	to(C target) Iterator of cells between current one and the target Note: the current cell is excluded from the iterator, but not the target.
Iterator<C>	to(CoordinateCell<C> target) Iterator of cells between current one and the target Note: the current cell is excluded from the iterator, but not the target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CellSight

public CellSight(BattlefieldSight<C> battlefield,
                 CoordinateCell<C> source)

CellSight

public CellSight(CoordinateCell<C> source)

Method Detail

isFree

public boolean isFree(CoordinateCell<C> target)

Check if the line of sight is free towards the target Usage:

 final CellSight<FightCell> sight = fighter.cell().sight();

 if (!sight.isFree(target.cell().coordinate())) {
     throw new Exception("Target is no reachable");
 }
 

Parameters:

target - The target cell

Returns:

true if line sight of sight is free

isFree

public boolean isFree(C target)

Check if the line of sight is free towards the target Usage:

 final CellSight<FightCell> sight = fighter.cell().sight();

 if (!sight.isFree(target.cell())) {
     throw new Exception("Target is no reachable");
 }
 

Parameters:

target - The target cell

Returns:

true if line sight of sight is free

to

public Iterator<C> to(C target)

Iterator of cells between current one and the target Note: the current cell is excluded from the iterator, but not the target. If the source and the target are same cells, an empty iterator is returned Usage:

 // Iterate over all cells between fighter.cell() and target.cell()
 fighter.cell().sight().to(target.cell()).forEachRemaining(cell -> {
     // cell is on the line of sight
 });
 

Parameters:

target - The target cell

Returns:

The cells iterator

to

public Iterator<C> to(CoordinateCell<C> target)

Iterator of cells between current one and the target Note: the current cell is excluded from the iterator, but not the target. If the source and the target are same cells, an empty iterator is returned Usage:

 // Iterate over all cells between fighter.cell() and target.cell()
 fighter.cell().sight().to(target.cell()).forEachRemaining(cell -> {
     // cell is on the line of sight
 });
 

Parameters:

target - The target cell

Returns:

The cells iterator

forEach

public void forEach(BiConsumer<C,Boolean> cellViewConsumer)

Iterate over all map cells, and check for each cells is the line of sight is free

 final CellSight<FightCell> sight = fighter.cell().sight();
 final CoordinateCell<FightCell> to = new CoordinateCell<>(target.cell());

 sight.forEach((cell, free) -> {
     if (free) {
         performActionOnAccessibleCell(cell);
     }
 });
 

Parameters:

cellViewConsumer - The cell consumer. Takes as first parameter the cell and at second the sight status (true if free)

See Also:

For dump accessible cells, For dump blocked cells

accessible

public Collection<C> accessible()

Returns:

Get all accessible cells from the current cell

blocked

public Collection<C> blocked()

Returns:

Get all blocked cells from the current cell