Package VASSAL.build

Interface GpIdSupport

All Known Implementing Classes:

BasicModule, GameModule, ModuleExtension, ModulePlugin

public interface GpIdSupport

GameModule and ModuleExtension are the top-level components and must provide some Namespace services for generated GamePiece Identifiers. Each Extension must have a unique Namespace String. Each PieceSlot is allocated a unique number in a series maintained for each top level component. Each GamePiece generated is tied to it's originating PieceSlot by the NameSpace Id and the PieceSlot Id.

Method Summary

Modifier and Type	Method	Description
String	generateGpId()	Generate a new PieceSlot Id, unique to this top-level component.
int	getNextGpId()	Accessors to check and update the next GpId if necessary.
void	setNextGpId(int id)

Method Details

generateGpId

String generateGpId()

Generate a new PieceSlot Id, unique to this top-level component.

Returns:

PieceSlot Id

getNextGpId

int getNextGpId()

Accessors to check and update the next GpId if necessary.

setNextGpId

void setNextGpId(int id)