Class SideAccess

java.lang.Object

VASSAL.counters.SideAccess

All Implemented Interfaces:

PieceAccess

public class SideAccess
extends Object
implements PieceAccess

Access is granted if PlayerRoster.getMySide() matches

Author:

rkinney

Nested Class Summary

Nested classes/interfaces inherited from interface VASSAL.counters.PieceAccess

PieceAccess.GlobalAccess

Constructor Summary

Constructors

Constructor	Description
SideAccess()

Method Summary

Modifier and Type	Method	Description
boolean	currentPlayerCanModify(String ownerId)	Return true if the current player can take (or relinquish) control of this piece
boolean	currentPlayerHasAccess(String id)	Return true if the current player can access this piece, given that the piece is owned by the player with the given id
String	getCurrentPlayerId()	Return a String identifying the current player
static SideAccess	getInstance()

Methods inherited from class java.lang.Object

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

Constructor Details

SideAccess

public SideAccess()

Method Details

getInstance

public static SideAccess getInstance()

getCurrentPlayerId

public String getCurrentPlayerId()

Description copied from interface: PieceAccess

Return a String identifying the current player

Specified by:

getCurrentPlayerId in interface PieceAccess

currentPlayerHasAccess

public boolean currentPlayerHasAccess(String id)

Description copied from interface: PieceAccess

Return true if the current player can access this piece, given that the piece is owned by the player with the given id

Specified by:

currentPlayerHasAccess in interface PieceAccess

currentPlayerCanModify

public boolean currentPlayerCanModify(String ownerId)

Description copied from interface: PieceAccess

Return true if the current player can take (or relinquish) control of this piece

Specified by:

currentPlayerCanModify in interface PieceAccess