ZHAW-IT21b_WIN
/
gruppe06-hufflepuff-projekt3-catan
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Finished Player Class (Java Doc and Code Style)

This commit is contained in:
Leonardo Brandenberger 2021-12-10 11:11:19 +01:00
parent 3661498216
commit 7f3376c1a4
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/ch/zhaw/catan/Player.java
View File

@ -4,10 +4,10 @@ import java.util.HashMap;
import java.util.List; import java.util.List;
/** /**
* This class is here in order to maintain the resources of the players, the amount of structures that they can build, * This class is here in order to maintain the resources of the players, the amount of structures that they can build.
* control to see if a player has enough to build a new structure and to add them into a faction. * And check if a player holds enough resources to build.
* *
* @author Leonardo Brandenberger, Roman Schrom, Andrin Fassbind, Stefan Amador * @author Leonardo Brandenberger, Roman Schenk, Andrin Fassbind, Stefan Amador
*/ */
public class Player { public class Player {
@ -18,7 +18,7 @@ public class Player {
/** /**
* The constructor initializes the faction and the Hashmaps resources and structureToUse. * The constructor initializes the faction and the Hashmaps resources and structureToUse.
* *
* @param faction this is the faction of the player. * @param faction faction of the player.
*/ */
public Player(Config.Faction faction) { public Player(Config.Faction faction) {
//Data fields //Data fields
@ -36,7 +36,7 @@ public class Player {
} }
/** /**
* This method returns all the resources the player has at the moment * This method returns all the resources the player has at the moment.
* *
* @return HashMap with the count of every resource * @return HashMap with the count of every resource
*/ */
@ -45,7 +45,7 @@ public class Player {
} }
/** /**
* This method returns player faction * This method returns the player's faction.
* *
* @return the faction of the player. * @return the faction of the player.
*/ */
@ -56,15 +56,15 @@ public class Player {
/** /**
* This method returns the amount of a specific resource that a player owns. * This method returns the amount of a specific resource that a player owns.
* *
* @param resource the resource that is needed. * @param resource the resource that is needed
* @return the amount of the specific resource. * @return the amount of the specific resource
*/ */
public int getSpecificResource(Config.Resource resource) { public int getSpecificResource(Config.Resource resource) {
return resources.get(resource); return resources.get(resource);
} }
/** /**
* This method adds a specific resource to resources * This method adds a specific resource to resources of the player.
* *
* @param resource to add * @param resource to add
* @param numberToAdd how much to add * @param numberToAdd how much to add
@ -91,7 +91,7 @@ public class Player {
/** /**
* This method has to be used when a player wants to build a structure. It checks if a player has enough of the specific structure * This method has to be used when a player wants to build a structure. It checks if a player has enough of the specific structure
* and resources to build one more. If the player is able to build, this method subtracts the building cost from the resources * and resources to build . If the player is able to build, this method subtracts the building cost from the resources
* in possession by the player. * in possession by the player.
* It reduces the amount of the specific structure a player can build by 1. * It reduces the amount of the specific structure a player can build by 1.
* *