Package ch.sahits.game.openpatrician.model.city.guild

Interface IGuild

All Known Implementing Classes:

Guild

public interface IGuild

Model for the guild. The guild model provides information that are related to a guild in a specific city. For common guild information shared by all guilds, see the GuildSettings.

Author:

Andi Hotz, (c) Sahits GmbH, 2016 Created on Nov 06, 2016

See Also:

GuildSettings

Method Summary

Modifier and Type	Method	Description
java.util.List<IAuction>	getAuctions()	Retreve the all auctions.
ICity	getCity()	Retrieve the city where the guild is located.
java.util.List<IPlayer>	getMembers()	Retrieve all members of the guild.
void	join(IPlayer player)	A player joins the guild.
void	resetAuction(IAuction auction)	Once the auction has happened the value must be reset.

Method Detail

getCity

ICity getCity()

Retrieve the city where the guild is located.

Returns:

city where the guild is located.

getMembers

java.util.List<IPlayer> getMembers()

Retrieve all members of the guild.

Returns:

member players of the guild

join

void join(IPlayer player)

A player joins the guild. The entrance fee is not deduced here.

Parameters:

player - who joins the guild

getAuctions

java.util.List<IAuction> getAuctions()

Retreve the all auctions.

Returns:

List of auctions in the guild.

resetAuction

void resetAuction(IAuction auction)

Once the auction has happened the value must be reset.

Parameters:

auction - to be removed