848 lines
60 KiB
HTML
848 lines
60 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="it">
|
|
<head>
|
|
<!-- Generated by javadoc (25) on Fri Jun 19 23:05:23 CEST 2026 -->
|
|
<title>Player</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="dc.created" content="2026-06-19">
|
|
<meta name="description" content="declaration: module: it.polimi.ingsw.gc14, package: it.polimi.ingsw.gc14.Model, class: Player">
|
|
<meta name="generator" content="javadoc/ClassWriter">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../resource-files/jquery-ui.min.css">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../resource-files/stylesheet.css">
|
|
<script type="text/javascript" src="../../../../../../script-files/script.js"></script>
|
|
<script type="text/javascript" src="../../../../../../script-files/jquery-3.7.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../../script-files/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">const pathtoroot = "../../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="nav-content">
|
|
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div>
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../../module-summary.html">Module</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../../search.html">Search</a></li>
|
|
<li><a href="../../../../../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div class="nav-content">
|
|
<ol class="sub-nav-list">
|
|
<li><a href="../../../../../module-summary.html">it.polimi.ingsw.gc14</a></li>
|
|
<li><a href="package-summary.html">it.polimi.ingsw.gc14.Model</a></li>
|
|
<li><a href="Player.html" class="current-selection">Player</a></li>
|
|
</ol>
|
|
<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="main-grid">
|
|
<nav role="navigation" class="toc" aria-label="Table of contents">
|
|
<div class="toc-header">Contents <input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"></div>
|
|
<ol class="toc-list" tabindex="-1">
|
|
<li><a href="#" tabindex="0">Description</a></li>
|
|
<li><a href="#field-summary" tabindex="0">Field Summary</a></li>
|
|
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
|
|
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
|
|
<li><a href="#field-detail" tabindex="0">Field Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#MAX_USERNAME_LENGTH" tabindex="0">MAX_USERNAME_LENGTH</a></li>
|
|
<li><a href="#totem" tabindex="0">totem</a></li>
|
|
<li><a href="#userName" tabindex="0">userName</a></li>
|
|
<li><a href="#buildingCards" tabindex="0">buildingCards</a></li>
|
|
<li><a href="#artists" tabindex="0">artists</a></li>
|
|
<li><a href="#builders" tabindex="0">builders</a></li>
|
|
<li><a href="#inventors" tabindex="0">inventors</a></li>
|
|
<li><a href="#gatherers" tabindex="0">gatherers</a></li>
|
|
<li><a href="#shamans" tabindex="0">shamans</a></li>
|
|
<li><a href="#hunters" tabindex="0">hunters</a></li>
|
|
<li><a href="#foodValue" tabindex="0">foodValue</a></li>
|
|
<li><a href="#prestigeValue" tabindex="0">prestigeValue</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#%3Cinit%3E(java.lang.String)" tabindex="0">Player(String)</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#getUserName()" tabindex="0">getUserName()</a></li>
|
|
<li><a href="#getTotem()" tabindex="0">getTotem()</a></li>
|
|
<li><a href="#getTotCharacters()" tabindex="0">getTotCharacters()</a></li>
|
|
<li><a href="#getNType(it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType)" tabindex="0">getNType(CharacterType)</a></li>
|
|
<li><a href="#getBuildingCards()" tabindex="0">getBuildingCards()</a></li>
|
|
<li><a href="#getArtists()" tabindex="0">getArtists()</a></li>
|
|
<li><a href="#getBuilders()" tabindex="0">getBuilders()</a></li>
|
|
<li><a href="#getInventors()" tabindex="0">getInventors()</a></li>
|
|
<li><a href="#getGatherers()" tabindex="0">getGatherers()</a></li>
|
|
<li><a href="#getShamans()" tabindex="0">getShamans()</a></li>
|
|
<li><a href="#getHunters()" tabindex="0">getHunters()</a></li>
|
|
<li><a href="#getFoodValue()" tabindex="0">getFoodValue()</a></li>
|
|
<li><a href="#getPrestigeValue()" tabindex="0">getPrestigeValue()</a></li>
|
|
<li><a href="#addFood(int)" tabindex="0">addFood(int)</a></li>
|
|
<li><a href="#setTotem(it.polimi.ingsw.gc14.Model.Totems)" tabindex="0">setTotem(Totems)</a></li>
|
|
<li><a href="#removeFood(int)" tabindex="0">removeFood(int)</a></li>
|
|
<li><a href="#addPrestige(int)" tabindex="0">addPrestige(int)</a></li>
|
|
<li><a href="#removePrestige(int)" tabindex="0">removePrestige(int)</a></li>
|
|
<li><a href="#equals(java.lang.Object)" tabindex="0">equals(Object)</a></li>
|
|
<li><a href="#hashCode()" tabindex="0">hashCode()</a></li>
|
|
<li><a href="#toString()" tabindex="0">toString()</a></li>
|
|
</ol>
|
|
</li>
|
|
</ol>
|
|
<button class="hide-sidebar"><span>Hide sidebar </span><img src="../../../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../../../resource-files/right.svg" alt="Show sidebar"><span> Show sidebar</span></button></nav>
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<h1 title="Class Player" class="title">Class Player</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">it.polimi.ingsw.gc14.Model.Player</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Player</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
|
|
implements <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
|
|
<div class="block">Default Player class; contains all identifiers and methods needed.</div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="../../../../../../serialized-form.html#it.polimi.ingsw.gc14.Model.Player">Serialized Form</a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Artist.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Artist</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#artists" class="member-name-link">artists</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Artist.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Artist</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Builder.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Builder</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#builders" class="member-name-link">builders</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Builder.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Builder</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#buildingCards" class="member-name-link">buildingCards</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The current <a href="Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards"><code>Building Cards</code></a> in the player's deck.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private int</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#foodValue" class="member-name-link">foodValue</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The current amount of <code>Food</code> the Player possesses.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Gatherer.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Gatherer</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#gatherers" class="member-name-link">gatherers</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Gatherer.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Gatherer</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Hunter.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Hunter</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#hunters" class="member-name-link">hunters</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Hunter.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Hunter</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Inventor.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Inventor</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#inventors" class="member-name-link">inventors</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Inventor.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Inventor</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private static final int</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#MAX_USERNAME_LENGTH" class="member-name-link">MAX_USERNAME_LENGTH</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The maximum length allowed for the username string.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>private int</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#prestigeValue" class="member-name-link">prestigeValue</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The current amount of <code>Prestige</code> the Player possesses.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Shaman.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Shaman</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#shamans" class="member-name-link">shamans</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Shaman.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Shaman</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>private <a href="Totems.html" title="enum class in it.polimi.ingsw.gc14.Model">Totems</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#totem" class="member-name-link">totem</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Identifier for the <code>Player</code> when displaying the game through the GUI.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#userName" class="member-name-link">userName</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Unique string identifier for players; must not be <code>null</code> and must not
|
|
exceed <a href="#MAX_USERNAME_LENGTH"><code>MAX_USERNAME_LENGTH</code></a> otherwise an <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will be thrown
|
|
when the <a href="#%3Cinit%3E(java.lang.String)"><code>constructor</code></a> is called.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">Player</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userName)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Constructor for the class <code>Player</code>.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFood(int)" class="member-name-link">addFood</a><wbr>(int value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Adds <code>value</code> amount of Food to the Player.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addPrestige(int)" class="member-name-link">addPrestige</a><wbr>(int value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Adds <code>value</code> amount of Prestige to the Player.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks equality between this <code>Player</code> and another object.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Artist.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Artist</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getArtists()" class="member-name-link">getArtists</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Builder.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Builder</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBuilders()" class="member-name-link">getBuilders</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBuildingCards()" class="member-name-link">getBuildingCards</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFoodValue()" class="member-name-link">getFoodValue</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Getter for the private attribute <a href="#foodValue"><code>foodValue</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Gatherer.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Gatherer</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGatherers()" class="member-name-link">getGatherers</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Hunter.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Hunter</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHunters()" class="member-name-link">getHunters</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Inventor.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Inventor</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInventors()" class="member-name-link">getInventors</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNType(it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType)" class="member-name-link">getNType</a><wbr>(<a href="Cards/TribeCards/CharacterType.html" title="enum class in it.polimi.ingsw.gc14.Model.Cards.TribeCards">CharacterType</a> type)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Counts the total number of cards of the specified <a href="Cards/TribeCards/CharacterType.html" title="enum class in it.polimi.ingsw.gc14.Model.Cards.TribeCards"><code>Character Type</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPrestigeValue()" class="member-name-link">getPrestigeValue</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Getter for the private attribute <a href="#prestigeValue"><code>prestigeValue</code></a>.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><wbr><<a href="Cards/TribeCards/Characters/Shaman.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Shaman</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getShamans()" class="member-name-link">getShamans</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotCharacters()" class="member-name-link">getTotCharacters</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Counts the total <a href="Cards/TribeCards/Character.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards"><code>Character Cards</code></a>
|
|
the player currently possesses.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Totems.html" title="enum class in it.polimi.ingsw.gc14.Model">Totems</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotem()" class="member-name-link">getTotem</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the totem assigned to this player.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUserName()" class="member-name-link">getUserName</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Getter for the private attribute <a href="#userName"><code>userName</code></a>.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeFood(int)" class="member-name-link">removeFood</a><wbr>(int value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Removes <code>value</code> amount of Food from the Player.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removePrestige(int)" class="member-name-link">removePrestige</a><wbr>(int value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Removes <code>value</code> amount of Prestige from the Player.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTotem(it.polimi.ingsw.gc14.Model.Totems)" class="member-name-link">setTotem</a><wbr>(<a href="Totems.html" title="enum class in it.polimi.ingsw.gc14.Model">Totems</a> totem)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the totem for this player.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Prints the <code>Player</code>'s attributes for the <code>Board</code>'s representation.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#method-summary" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="MAX_USERNAME_LENGTH">
|
|
<h3>MAX_USERNAME_LENGTH</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">int</span> <span class="element-name">MAX_USERNAME_LENGTH</span></div>
|
|
<div class="block">The maximum length allowed for the username string.</div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="../../../../../../constant-values.html#it.polimi.ingsw.gc14.Model.Player.MAX_USERNAME_LENGTH">Constant Field Values</a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="totem">
|
|
<h3>totem</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="Totems.html" title="enum class in it.polimi.ingsw.gc14.Model">Totems</a></span> <span class="element-name">totem</span></div>
|
|
<div class="block">Identifier for the <code>Player</code> when displaying the game through the GUI.</div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="Totems.html" title="enum class in it.polimi.ingsw.gc14.Model"><code>Totems</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="userName">
|
|
<h3>userName</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">userName</span></div>
|
|
<div class="block">Unique string identifier for players; must not be <code>null</code> and must not
|
|
exceed <a href="#MAX_USERNAME_LENGTH"><code>MAX_USERNAME_LENGTH</code></a> otherwise an <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will be thrown
|
|
when the <a href="#%3Cinit%3E(java.lang.String)"><code>constructor</code></a> is called.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildingCards">
|
|
<h3>buildingCards</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></span> <span class="element-name">buildingCards</span></div>
|
|
<div class="block">The current <a href="Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards"><code>Building Cards</code></a> in the player's deck.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="artists">
|
|
<h3>artists</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Artist.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Artist</a>></span> <span class="element-name">artists</span></div>
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Artist.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Artist</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="builders">
|
|
<h3>builders</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Builder.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Builder</a>></span> <span class="element-name">builders</span></div>
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Builder.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Builder</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="inventors">
|
|
<h3>inventors</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Inventor.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Inventor</a>></span> <span class="element-name">inventors</span></div>
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Inventor.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Inventor</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="gatherers">
|
|
<h3>gatherers</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Gatherer.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Gatherer</a>></span> <span class="element-name">gatherers</span></div>
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Gatherer.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Gatherer</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shamans">
|
|
<h3>shamans</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Shaman.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Shaman</a>></span> <span class="element-name">shamans</span></div>
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Shaman.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Shaman</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hunters">
|
|
<h3>hunters</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Hunter.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Hunter</a>></span> <span class="element-name">hunters</span></div>
|
|
<div class="block">The current <a href="Cards/TribeCards/Characters/Hunter.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters"><code>Hunter</code></a> cards in the player's deck.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="foodValue">
|
|
<h3>foodValue</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">foodValue</span></div>
|
|
<div class="block">The current amount of <code>Food</code> the Player possesses.
|
|
Cannot be negative.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="prestigeValue">
|
|
<h3>prestigeValue</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">prestigeValue</span></div>
|
|
<div class="block">The current amount of <code>Prestige</code> the Player possesses.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>(java.lang.String)">
|
|
<h3>Player</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Player</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userName)</span>
|
|
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div>
|
|
<div class="block">Constructor for the class <code>Player</code>. Each Player is uniquely identified by the <a href="#userName"><code>userName</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>userName</code> - Unique String identifier for a Player.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - when <code>userName</code> is empty or exceeds <a href="#MAX_USERNAME_LENGTH"><code>MAX_USERNAME_LENGTH</code></a>,
|
|
with message:
|
|
<pre><code>UserName is empty or exceeds maximum permitted length.</code></pre></dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="#userName"><code>userName</code></a></li>
|
|
<li><a href="#MAX_USERNAME_LENGTH"><code>MAX_USERNAME_LENGTH</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="getUserName()">
|
|
<h3>getUserName</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getUserName</span>()</div>
|
|
<div class="block">Getter for the private attribute <a href="#userName"><code>userName</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd><code>String</code> - The UserName</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getTotem()">
|
|
<h3>getTotem</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Totems.html" title="enum class in it.polimi.ingsw.gc14.Model">Totems</a></span> <span class="element-name">getTotem</span>()</div>
|
|
<div class="block">Returns the totem assigned to this player.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's totem.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getTotCharacters()">
|
|
<h3>getTotCharacters</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getTotCharacters</span>()</div>
|
|
<div class="block">Counts the total <a href="Cards/TribeCards/Character.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards"><code>Character Cards</code></a>
|
|
the player currently possesses.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd><code>int</code> - Total Character Cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getNType(it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType)">
|
|
<h3>getNType</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNType</span><wbr><span class="parameters">(<a href="Cards/TribeCards/CharacterType.html" title="enum class in it.polimi.ingsw.gc14.Model.Cards.TribeCards">CharacterType</a> type)</span></div>
|
|
<div class="block">Counts the total number of cards of the specified <a href="Cards/TribeCards/CharacterType.html" title="enum class in it.polimi.ingsw.gc14.Model.Cards.TribeCards"><code>Character Type</code></a>.
|
|
Character Type must not be <code>null</code></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>type</code> - the Character Type to be Counted.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd><code>int</code> - Total number of cards of given <code>type</code>.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBuildingCards()">
|
|
<h3>getBuildingCards</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></span> <span class="element-name">getBuildingCards</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's building cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getArtists()">
|
|
<h3>getArtists</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Artist.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Artist</a>></span> <span class="element-name">getArtists</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's Artist character cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getBuilders()">
|
|
<h3>getBuilders</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Builder.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Builder</a>></span> <span class="element-name">getBuilders</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's Builder character cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getInventors()">
|
|
<h3>getInventors</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Inventor.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Inventor</a>></span> <span class="element-name">getInventors</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's Inventor character cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getGatherers()">
|
|
<h3>getGatherers</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Gatherer.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Gatherer</a>></span> <span class="element-name">getGatherers</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's Gatherer character cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getShamans()">
|
|
<h3>getShamans</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Shaman.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Shaman</a>></span> <span class="element-name">getShamans</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's Shaman character cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getHunters()">
|
|
<h3>getHunters</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="Cards/TribeCards/Characters/Hunter.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards.Characters">Hunter</a>></span> <span class="element-name">getHunters</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>this player's Hunter character cards.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFoodValue()">
|
|
<h3>getFoodValue</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getFoodValue</span>()</div>
|
|
<div class="block">Getter for the private attribute <a href="#foodValue"><code>foodValue</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd><code>int</code> - The amount of Food the player possesses.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getPrestigeValue()">
|
|
<h3>getPrestigeValue</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getPrestigeValue</span>()</div>
|
|
<div class="block">Getter for the private attribute <a href="#prestigeValue"><code>prestigeValue</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd><code>int</code> - The amount of Prestige the Player possesses.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addFood(int)">
|
|
<h3>addFood</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addFood</span><wbr><span class="parameters">(int value)</span></div>
|
|
<div class="block">Adds <code>value</code> amount of Food to the Player.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - The amount of Food to be added. Should be non-negative.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="#foodValue"><code>foodValue</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setTotem(it.polimi.ingsw.gc14.Model.Totems)">
|
|
<h3>setTotem</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTotem</span><wbr><span class="parameters">(<a href="Totems.html" title="enum class in it.polimi.ingsw.gc14.Model">Totems</a> totem)</span></div>
|
|
<div class="block">Sets the totem for this player.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>totem</code> - the totem to assign.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="removeFood(int)">
|
|
<h3>removeFood</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeFood</span><wbr><span class="parameters">(int value)</span></div>
|
|
<div class="block">Removes <code>value</code> amount of Food from the Player.
|
|
<a href="#foodValue"><code>foodValue</code></a> cannot go negative: returns <code>false</code> if
|
|
<code>value</code> exceeds the current food and leaves the value unchanged.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - The amount of Food to be removed. Should be non-negative.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd><code>true</code> if the Food is successfully removed, <code>false</code> otherwise.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="#foodValue"><code>foodValue</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addPrestige(int)">
|
|
<h3>addPrestige</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addPrestige</span><wbr><span class="parameters">(int value)</span></div>
|
|
<div class="block">Adds <code>value</code> amount of Prestige to the Player.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - The amount of Prestige to be added. Should be non-negative.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="#prestigeValue"><code>prestigeValue</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="removePrestige(int)">
|
|
<h3>removePrestige</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removePrestige</span><wbr><span class="parameters">(int value)</span></div>
|
|
<div class="block">Removes <code>value</code> amount of Prestige from the Player.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - The amount of Prestige to be removed. Should be non-negative.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="#prestigeValue"><code>prestigeValue</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="equals(java.lang.Object)">
|
|
<h3>equals</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div>
|
|
<div class="block">Checks equality between this <code>Player</code> and another object.
|
|
Two players are equal if and only if they share the same <code>userName</code>.</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>obj</code> - the object to compare with.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd><code>true</code> if <code>obj</code> is a <code>Player</code> with the same username; <code>false</code> otherwise.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hashCode()">
|
|
<h3>hashCode</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toString()">
|
|
<h3>toString</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div>
|
|
<div class="block">Prints the <code>Player</code>'s attributes for the <code>Board</code>'s representation.
|
|
Uses the <code>UNICODE</code> border style.
|
|
<b>Includes:</b>
|
|
<ul>
|
|
<li><a href="#foodValue"><code>Food</code></a></li>
|
|
<li><a href="#prestigeValue"><code>Prestige</code></a></li>
|
|
<li><a href="#artists"><code>Artists</code></a></li>
|
|
<li><a href="#builders"><code>Builders</code></a></li>
|
|
<li><a href="#gatherers"><code>Gatherers</code></a></li>
|
|
<li><a href="#shamans"><code>Shamans</code></a></li>
|
|
<li><a href="#inventors"><code>Inventors</code></a></li>
|
|
<li><a href="#hunters"><code>Hunters</code></a></li>
|
|
<li><a href="#buildingCards"><code>Buildings</code></a></li>
|
|
</ul></div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd><code>String</code> - A string representation of the <code>Player</code>'s attributes.</dd>
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="../View/TUI/BorderStyle.html" title="enum class in it.polimi.ingsw.gc14.View.TUI"><code>BorderStyle</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</body>
|
|
</html>
|