Added: JAVADOC html in deliverables
This commit is contained in:
rubenpirreram
+639
@@ -0,0 +1,639 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="it">
|
||||
<head>
|
||||
<!-- Generated by javadoc (25) on Fri Jun 19 23:05:23 CEST 2026 -->
|
||||
<title>Board</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.GamePackage, class: Board">
|
||||
<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.GamePackage</a></li>
|
||||
<li><a href="Board.html" class="current-selection">Board</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="#slotList" tabindex="0">slotList</a></li>
|
||||
<li><a href="#tribeDeck" tabindex="0">tribeDeck</a></li>
|
||||
<li><a href="#upperListTribe" tabindex="0">upperListTribe</a></li>
|
||||
<li><a href="#lowerListTribe" tabindex="0">lowerListTribe</a></li>
|
||||
<li><a href="#upperListBuilding" tabindex="0">upperListBuilding</a></li>
|
||||
<li><a href="#lowerListBuilding" tabindex="0">lowerListBuilding</a></li>
|
||||
<li><a href="#buildingCardsAllEras" tabindex="0">buildingCardsAllEras</a></li>
|
||||
<li><a href="#nTotem" tabindex="0">nTotem</a></li>
|
||||
<li><a href="#era" tabindex="0">era</a></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
|
||||
<ol class="toc-list">
|
||||
<li><a href="#%3Cinit%3E(int)" tabindex="0">Board(int)</a></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
||||
<ol class="toc-list">
|
||||
<li><a href="#getUpperListTribe()" tabindex="0">getUpperListTribe()</a></li>
|
||||
<li><a href="#getLowerListTribe()" tabindex="0">getLowerListTribe()</a></li>
|
||||
<li><a href="#getUpperListBuilding()" tabindex="0">getUpperListBuilding()</a></li>
|
||||
<li><a href="#getLowerListBuilding()" tabindex="0">getLowerListBuilding()</a></li>
|
||||
<li><a href="#getSlotList()" tabindex="0">getSlotList()</a></li>
|
||||
<li><a href="#getTribeDeckSize()" tabindex="0">getTribeDeckSize()</a></li>
|
||||
<li><a href="#getEra()" tabindex="0">getEra()</a></li>
|
||||
<li><a href="#generateTribeDeck(int)" tabindex="0">generateTribeDeck(int)</a></li>
|
||||
<li><a href="#getPendingEvents()" tabindex="0">getPendingEvents()</a></li>
|
||||
<li><a href="#removeUpperTribeCard(it.polimi.ingsw.gc14.Model.Cards.TribeCard)" tabindex="0">removeUpperTribeCard(TribeCard)</a></li>
|
||||
<li><a href="#removeLowerTribeCard(it.polimi.ingsw.gc14.Model.Cards.TribeCard)" tabindex="0">removeLowerTribeCard(TribeCard)</a></li>
|
||||
<li><a href="#removeUpperBuildingCard(it.polimi.ingsw.gc14.Model.Cards.BuildingCard)" tabindex="0">removeUpperBuildingCard(BuildingCard)</a></li>
|
||||
<li><a href="#removeLowerBuildingCard(it.polimi.ingsw.gc14.Model.Cards.BuildingCard)" tabindex="0">removeLowerBuildingCard(BuildingCard)</a></li>
|
||||
<li><a href="#nextRound()" tabindex="0">nextRound()</a></li>
|
||||
<li><a href="#nextEra()" tabindex="0">nextEra()</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 Board" class="title">Class Board</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.GamePackage.Board</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">Board</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">Board manages all the elements during the game such as decks, upper and lower rows, totems, tiles...</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="tag-list">
|
||||
<li><a href="../../../../../../../serialized-form.html#it.polimi.ingsw.gc14.Model.GamePackage.Board">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="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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="#buildingCardsAllEras" class="member-name-link">buildingCardsAllEras</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">All building card lists grouped by era; index 0 = era 1, index 1 = era 2, etc.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private int</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#era" class="member-name-link">era</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Current era of the game</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/List.html" title="class or interface in java.util" class="external-link">List</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="#lowerListBuilding" class="member-name-link">lowerListBuilding</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Contains all the building cards of the lower list.</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#lowerListTribe" class="member-name-link">lowerListTribe</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The lower row of the tribe card.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#nTotem" class="member-name-link">nTotem</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Number of players</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#slotList" class="member-name-link">slotList</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">slotList contains the ordered list of slots (tiles).</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/Queue.html" title="class or interface in java.util" class="external-link">Queue</a><wbr><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#tribeDeck" class="member-name-link">tribeDeck</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">tribeDeck is the deck from where you draw tribe cards as characters and events.</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/List.html" title="class or interface in java.util" class="external-link">List</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"><code><a href="#upperListBuilding" class="member-name-link">upperListBuilding</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Contains all the building cards of the upper list.</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#upperListTribe" class="member-name-link">upperListTribe</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The upper row of tribe cards.</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(int)" class="member-name-link">Board</a><wbr>(int nTotem)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates and initializes a new board:
|
||||
- Generate the slotList using a method of DecksCreator</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>private <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Queue.html" title="class or interface in java.util" class="external-link">Queue</a><wbr><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateTribeDeck(int)" class="member-name-link">generateTribeDeck</a><wbr>(int nPlayers)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Creates the tribeDeck.</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="#getEra()" class="member-name-link">getEra</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/List.html" title="class or interface in java.util" class="external-link">List</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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerListBuilding()" class="member-name-link">getLowerListBuilding</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 lower row of building cards.</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLowerListTribe()" class="member-name-link">getLowerListTribe</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns the lower row of tribe cards.</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/Queue.html" title="class or interface in java.util" class="external-link">Queue</a><wbr><<a href="../Cards/TribeCards/EventCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards">EventCard</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPendingEvents()" class="member-name-link">getPendingEvents</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSlotList()" class="member-name-link">getSlotList</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Creates and returns a new list containing the slots (tiles) of the game.</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="#getTribeDeckSize()" class="member-name-link">getTribeDeckSize</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/List.html" title="class or interface in java.util" class="external-link">List</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="#getUpperListBuilding()" class="member-name-link">getUpperListBuilding</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns the upper row of building cards.</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUpperListTribe()" class="member-name-link">getUpperListTribe</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 upper row of tribe cards.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextEra()" class="member-name-link">nextEra</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Changes the era of the game:
|
||||
- Increase the era attribute</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="#nextRound()" class="member-name-link">nextRound</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Goes to the next round</div>
|
||||
</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="#removeLowerBuildingCard(it.polimi.ingsw.gc14.Model.Cards.BuildingCard)" class="member-name-link">removeLowerBuildingCard</a><wbr>(<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a> buildingCard)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Take the selected card from the lower building list of the board.</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="#removeLowerTribeCard(it.polimi.ingsw.gc14.Model.Cards.TribeCard)" class="member-name-link">removeLowerTribeCard</a><wbr>(<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a> tribeCard)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Take the selected card from the lower tribe list of the board.</div>
|
||||
</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="#removeUpperBuildingCard(it.polimi.ingsw.gc14.Model.Cards.BuildingCard)" class="member-name-link">removeUpperBuildingCard</a><wbr>(<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a> buildingCard)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Take the selected card from the upper building list of the board.</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="#removeUpperTribeCard(it.polimi.ingsw.gc14.Model.Cards.TribeCard)" class="member-name-link">removeUpperTribeCard</a><wbr>(<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a> tribeCard)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Take the selected card from the upper tribe list of the board.</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#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</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#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</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#toString()" title="class or interface in java.lang" class="external-link">toString</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="slotList">
|
||||
<h3>slotList</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a>></span> <span class="element-name">slotList</span></div>
|
||||
<div class="block">slotList contains the ordered list of slots (tiles). The slots changes based on the number of players.
|
||||
Each slot (tile) has special action as drawing from the upper/lower row or taking food.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="tribeDeck">
|
||||
<h3>tribeDeck</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/Queue.html" title="class or interface in java.util" class="external-link">Queue</a><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></span> <span class="element-name">tribeDeck</span></div>
|
||||
<div class="block">tribeDeck is the deck from where you draw tribe cards as characters and events.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="upperListTribe">
|
||||
<h3>upperListTribe</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></span> <span class="element-name">upperListTribe</span></div>
|
||||
<div class="block">The upper row of tribe cards. It contains a total of
|
||||
<code>nTotem + 4</code> tribe cards, which may include both character and event cards.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="lowerListTribe">
|
||||
<h3>lowerListTribe</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></span> <span class="element-name">lowerListTribe</span></div>
|
||||
<div class="block">The lower row of the tribe card. During the first round, there will be (num. of players + 1) character cards.
|
||||
During the following rounds, lower row will be emptied and populated with upper row's cards.
|
||||
When an Event card gets in the lower row, the event effect will be activated at the end of the round.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="upperListBuilding">
|
||||
<h3>upperListBuilding</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></span> <span class="element-name">upperListBuilding</span></div>
|
||||
<div class="block">Contains all the building cards of the upper list. When a new era starts, all its building cards are placed here.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="lowerListBuilding">
|
||||
<h3>lowerListBuilding</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></span> <span class="element-name">lowerListBuilding</span></div>
|
||||
<div class="block">Contains all the building cards of the lower list. When a new era starts, the old era's buildings are moved from the upper to the lower list.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="buildingCardsAllEras">
|
||||
<h3>buildingCardsAllEras</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="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>>></span> <span class="element-name">buildingCardsAllEras</span></div>
|
||||
<div class="block">All building card lists grouped by era; index 0 = era 1, index 1 = era 2, etc.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nTotem">
|
||||
<h3>nTotem</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name">nTotem</span></div>
|
||||
<div class="block">Number of players</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="era">
|
||||
<h3>era</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">era</span></div>
|
||||
<div class="block">Current era of the game</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>(int)">
|
||||
<h3>Board</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Board</span><wbr><span class="parameters">(int nTotem)</span></div>
|
||||
<div class="block">Creates and initializes a new board:
|
||||
- Generate the slotList using a method of DecksCreator.
|
||||
- Generate the tribeDeck.
|
||||
- Populate the lower list (if there is an event card, it's added to the upper list).
|
||||
- Populate the upper list.
|
||||
- Generate the buildingDeck using a method of DecksCreator.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>nTotem</code> - the number of players.</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="getUpperListTribe()">
|
||||
<h3>getUpperListTribe</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></span> <span class="element-name">getUpperListTribe</span>()</div>
|
||||
<div class="block">Returns the upper row of tribe cards.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the live upper tribe card list.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getLowerListTribe()">
|
||||
<h3>getLowerListTribe</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></span> <span class="element-name">getLowerListTribe</span>()</div>
|
||||
<div class="block">Returns the lower row of tribe cards.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the live lower tribe card list.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getUpperListBuilding()">
|
||||
<h3>getUpperListBuilding</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></span> <span class="element-name">getUpperListBuilding</span>()</div>
|
||||
<div class="block">Returns the upper row of building cards.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the live upper building card list.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getLowerListBuilding()">
|
||||
<h3>getLowerListBuilding</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a>></span> <span class="element-name">getLowerListBuilding</span>()</div>
|
||||
<div class="block">Returns the lower row of building cards.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the live lower building card list.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getSlotList()">
|
||||
<h3>getSlotList</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/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a>></span> <span class="element-name">getSlotList</span>()</div>
|
||||
<div class="block">Creates and returns a new list containing the slots (tiles) of the game.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>a copy of the slot list.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getTribeDeckSize()">
|
||||
<h3>getTribeDeckSize</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getTribeDeckSize</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the size of the TribeDeck</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getEra()">
|
||||
<h3>getEra</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getEra</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the game era</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="generateTribeDeck(int)">
|
||||
<h3>generateTribeDeck</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Queue.html" title="class or interface in java.util" class="external-link">Queue</a><<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a>></span> <span class="element-name">generateTribeDeck</span><wbr><span class="parameters">(int nPlayers)</span></div>
|
||||
<div class="block">Creates the tribeDeck. Loads the cards from each era, shuffle them, and then combine them in the final deck.
|
||||
In the end, two special events (Sustenance and ShamanicRitual) are added.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>nPlayers</code> - the number of players.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>a queue containing the cards in this order:
|
||||
- Era 1.
|
||||
- Era 2.
|
||||
- Era 3.
|
||||
- Special events.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getPendingEvents()">
|
||||
<h3>getPendingEvents</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/Queue.html" title="class or interface in java.util" class="external-link">Queue</a><<a href="../Cards/TribeCards/EventCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards.TribeCards">EventCard</a>></span> <span class="element-name">getPendingEvents</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the queue of events cards from the lower list that need to be activated</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="removeUpperTribeCard(it.polimi.ingsw.gc14.Model.Cards.TribeCard)">
|
||||
<h3>removeUpperTribeCard</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeUpperTribeCard</span><wbr><span class="parameters">(<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a> tribeCard)</span></div>
|
||||
<div class="block">Take the selected card from the upper tribe list of the board.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>tribeCard</code> - is the card to remove.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>true if the card is successfully removed.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="removeLowerTribeCard(it.polimi.ingsw.gc14.Model.Cards.TribeCard)">
|
||||
<h3>removeLowerTribeCard</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeLowerTribeCard</span><wbr><span class="parameters">(<a href="../Cards/TribeCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">TribeCard</a> tribeCard)</span></div>
|
||||
<div class="block">Take the selected card from the lower tribe list of the board.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>tribeCard</code> - is the card to remove.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>true if succeed in removing the card.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="removeUpperBuildingCard(it.polimi.ingsw.gc14.Model.Cards.BuildingCard)">
|
||||
<h3>removeUpperBuildingCard</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeUpperBuildingCard</span><wbr><span class="parameters">(<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a> buildingCard)</span></div>
|
||||
<div class="block">Take the selected card from the upper building list of the board.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>buildingCard</code> - is the card to remove.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>true if succeed in removing the card.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="removeLowerBuildingCard(it.polimi.ingsw.gc14.Model.Cards.BuildingCard)">
|
||||
<h3>removeLowerBuildingCard</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeLowerBuildingCard</span><wbr><span class="parameters">(<a href="../Cards/BuildingCard.html" title="class in it.polimi.ingsw.gc14.Model.Cards">BuildingCard</a> buildingCard)</span></div>
|
||||
<div class="block">Take the selected card from the lower building list of the board.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>buildingCard</code> - is the card to remove.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>true if succeed in removing the card.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextRound()">
|
||||
<h3>nextRound</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">nextRound</span>()</div>
|
||||
<div class="block">Goes to the next round.
|
||||
- Clear the lower tribe row.
|
||||
- Moves the upper tribe row to the lower one.
|
||||
- Populate the upper tribe row.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the current era after moving to the next round.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextEra()">
|
||||
<h3>nextEra</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name">nextEra</span>()</div>
|
||||
<div class="block">Changes the era of the game:
|
||||
- Increase the era attribute.
|
||||
- Clear the lower building list and replace it with the upper building list.
|
||||
- Repopulate the upper building list.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
+563
@@ -0,0 +1,563 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="it">
|
||||
<head>
|
||||
<!-- Generated by javadoc (25) on Fri Jun 19 23:05:23 CEST 2026 -->
|
||||
<title>CurrentState</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.GamePackage, class: CurrentState">
|
||||
<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.GamePackage</a></li>
|
||||
<li><a href="CurrentState.html" class="current-selection">CurrentState</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="#player" tabindex="0">player</a></li>
|
||||
<li><a href="#slot" tabindex="0">slot</a></li>
|
||||
<li><a href="#era" tabindex="0">era</a></li>
|
||||
<li><a href="#round" tabindex="0">round</a></li>
|
||||
<li><a href="#nUpper" tabindex="0">nUpper</a></li>
|
||||
<li><a href="#nLower" tabindex="0">nLower</a></li>
|
||||
<li><a href="#gameStage" tabindex="0">gameStage</a></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
|
||||
<ol class="toc-list">
|
||||
<li><a href="#%3Cinit%3E()" tabindex="0">CurrentState()</a></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
||||
<ol class="toc-list">
|
||||
<li><a href="#getCurrentPlayer()" tabindex="0">getCurrentPlayer()</a></li>
|
||||
<li><a href="#getSlot()" tabindex="0">getSlot()</a></li>
|
||||
<li><a href="#getEra()" tabindex="0">getEra()</a></li>
|
||||
<li><a href="#getRound()" tabindex="0">getRound()</a></li>
|
||||
<li><a href="#getNUpper()" tabindex="0">getNUpper()</a></li>
|
||||
<li><a href="#getNLower()" tabindex="0">getNLower()</a></li>
|
||||
<li><a href="#getGameStage()" tabindex="0">getGameStage()</a></li>
|
||||
<li><a href="#eraUpdate()" tabindex="0">eraUpdate()</a></li>
|
||||
<li><a href="#roundUpdate()" tabindex="0">roundUpdate()</a></li>
|
||||
<li><a href="#upperDrawn()" tabindex="0">upperDrawn()</a></li>
|
||||
<li><a href="#lowerDrawn()" tabindex="0">lowerDrawn()</a></li>
|
||||
<li><a href="#gameStageUpdate(it.polimi.ingsw.gc14.Model.GamePackage.GameStages)" tabindex="0">gameStageUpdate(GameStages)</a></li>
|
||||
<li><a href="#playerUpdate(it.polimi.ingsw.gc14.Model.Player,it.polimi.ingsw.gc14.Model.Slot)" tabindex="0">playerUpdate(Player, Slot)</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 CurrentState" class="title">Class CurrentState</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.GamePackage.CurrentState</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">CurrentState</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">Represents the current state of the game.
|
||||
A CurrentState object stores the current player, slot, era, round,
|
||||
remaining upper and lower cards, and the current game stage.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="tag-list">
|
||||
<li><a href="../../../../../../../serialized-form.html#it.polimi.ingsw.gc14.Model.GamePackage.CurrentState">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 int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#era" class="member-name-link">era</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The current era of the game.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#gameStage" class="member-name-link">gameStage</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The current stage of the game.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#nLower" class="member-name-link">nLower</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The number of lower cards currently available.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private int</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#nUpper" class="member-name-link">nUpper</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The number of upper cards currently available.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private <a href="../Player.html" title="class in it.polimi.ingsw.gc14.Model">Player</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#player" class="member-name-link">player</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The current player associated with the game state.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private int</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#round" class="member-name-link">round</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The current round of the game.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private <a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#slot" class="member-name-link">slot</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The current slot associated with the game state.</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()" class="member-name-link">CurrentState</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new CurrentState object with default initial values.</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="#eraUpdate()" class="member-name-link">eraUpdate</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Increments the current era by 1.</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="#gameStageUpdate(it.polimi.ingsw.gc14.Model.GamePackage.GameStages)" class="member-name-link">gameStageUpdate</a><wbr>(<a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a> stage)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Updates the current game stage.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Player.html" title="class in it.polimi.ingsw.gc14.Model">Player</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentPlayer()" class="member-name-link">getCurrentPlayer</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 current player.</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="#getEra()" class="member-name-link">getEra</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns the current era of the game.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGameStage()" class="member-name-link">getGameStage</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 current stage of the game.</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="#getNLower()" class="member-name-link">getNLower</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns the number of lower cards currently available.</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="#getNUpper()" class="member-name-link">getNUpper</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 number of upper cards currently available.</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="#getRound()" class="member-name-link">getRound</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns the current round of the game.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSlot()" class="member-name-link">getSlot</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 current slot.</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="#lowerDrawn()" class="member-name-link">lowerDrawn</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Decrements the number of lower cards by 1.</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="#playerUpdate(it.polimi.ingsw.gc14.Model.Player,it.polimi.ingsw.gc14.Model.Slot)" class="member-name-link">playerUpdate</a><wbr>(<a href="../Player.html" title="class in it.polimi.ingsw.gc14.Model">Player</a> player,
|
||||
<a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a> slot)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Updates the current player, slot, and available draws.</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="#roundUpdate()" class="member-name-link">roundUpdate</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Increments the current round by 1.</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">Returns a formatted ASCII table representation of the current game state.</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="#upperDrawn()" class="member-name-link">upperDrawn</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Decrements the number of upper cards by 1.</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#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</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#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</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="player">
|
||||
<h3>player</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../Player.html" title="class in it.polimi.ingsw.gc14.Model">Player</a></span> <span class="element-name">player</span></div>
|
||||
<div class="block">The current player associated with the game state.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="slot">
|
||||
<h3>slot</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a></span> <span class="element-name">slot</span></div>
|
||||
<div class="block">The current slot associated with the game state.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="era">
|
||||
<h3>era</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">era</span></div>
|
||||
<div class="block">The current era of the game.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="round">
|
||||
<h3>round</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">round</span></div>
|
||||
<div class="block">The current round of the game.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nUpper">
|
||||
<h3>nUpper</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">nUpper</span></div>
|
||||
<div class="block">The number of upper cards currently available.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nLower">
|
||||
<h3>nLower</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">nLower</span></div>
|
||||
<div class="block">The number of lower cards currently available.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="gameStage">
|
||||
<h3>gameStage</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">gameStage</span></div>
|
||||
<div class="block">The current stage of the game.</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>()">
|
||||
<h3>CurrentState</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CurrentState</span>()</div>
|
||||
<div class="block">Creates a new CurrentState object with default initial values.
|
||||
The initial player and slot are <code>null</code>, the era and round are set to 1,
|
||||
the number of upper and lower cards is set to 0, and the game stage is set to <code>WAITING</code>.</div>
|
||||
</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="getCurrentPlayer()">
|
||||
<h3>getCurrentPlayer</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Player.html" title="class in it.polimi.ingsw.gc14.Model">Player</a></span> <span class="element-name">getCurrentPlayer</span>()</div>
|
||||
<div class="block">Returns the current player.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the current player.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getSlot()">
|
||||
<h3>getSlot</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a></span> <span class="element-name">getSlot</span>()</div>
|
||||
<div class="block">Returns the current slot.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the current slot.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getEra()">
|
||||
<h3>getEra</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getEra</span>()</div>
|
||||
<div class="block">Returns the current era of the game.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the current era of the game.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getRound()">
|
||||
<h3>getRound</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getRound</span>()</div>
|
||||
<div class="block">Returns the current round of the game.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the current round of the game.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getNUpper()">
|
||||
<h3>getNUpper</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNUpper</span>()</div>
|
||||
<div class="block">Returns the number of upper cards currently available.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the number of upper cards currently available.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getNLower()">
|
||||
<h3>getNLower</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNLower</span>()</div>
|
||||
<div class="block">Returns the number of lower cards currently available.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the number of lower cards currently available.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getGameStage()">
|
||||
<h3>getGameStage</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">getGameStage</span>()</div>
|
||||
<div class="block">Returns the current stage of the game.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the current stage of the game.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="eraUpdate()">
|
||||
<h3>eraUpdate</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">eraUpdate</span>()</div>
|
||||
<div class="block">Increments the current era by 1.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="roundUpdate()">
|
||||
<h3>roundUpdate</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">roundUpdate</span>()</div>
|
||||
<div class="block">Increments the current round by 1.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="upperDrawn()">
|
||||
<h3>upperDrawn</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">upperDrawn</span>()</div>
|
||||
<div class="block">Decrements the number of upper cards by 1.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="lowerDrawn()">
|
||||
<h3>lowerDrawn</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">lowerDrawn</span>()</div>
|
||||
<div class="block">Decrements the number of lower cards by 1.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="gameStageUpdate(it.polimi.ingsw.gc14.Model.GamePackage.GameStages)">
|
||||
<h3>gameStageUpdate</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">gameStageUpdate</span><wbr><span class="parameters">(<a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a> stage)</span></div>
|
||||
<div class="block">Updates the current game stage.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>stage</code> - the new game stage.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="playerUpdate(it.polimi.ingsw.gc14.Model.Player,it.polimi.ingsw.gc14.Model.Slot)">
|
||||
<h3>playerUpdate</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">playerUpdate</span><wbr><span class="parameters">(<a href="../Player.html" title="class in it.polimi.ingsw.gc14.Model">Player</a> player,
|
||||
<a href="../Slot.html" title="class in it.polimi.ingsw.gc14.Model">Slot</a> slot)</span></div>
|
||||
<div class="block">Updates the current player, slot, and available draws.
|
||||
If <code>slot</code> is <code>null</code>, both <a href="#nUpper"><code>nUpper</code></a> and <a href="#nLower"><code>nLower</code></a> are reset to 0.
|
||||
Otherwise, they are set from the slot's values.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>player</code> - the new current player.</dd>
|
||||
<dd><code>slot</code> - the new current slot, or <code>null</code> when no slot is active.</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">Returns a formatted ASCII table representation of the current game state.
|
||||
Columns: Player, Round, Era, GameStage.</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>a <code>String</code> containing the ASCII table.</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
+428
@@ -0,0 +1,428 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="it">
|
||||
<head>
|
||||
<!-- Generated by javadoc (25) on Fri Jun 19 23:05:23 CEST 2026 -->
|
||||
<title>GameStages</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.GamePackage, enum: GameStages">
|
||||
<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.GamePackage</a></li>
|
||||
<li><a href="GameStages.html" class="current-selection">GameStages</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="#nested-class-summary" tabindex="0">Nested Class Summary</a></li>
|
||||
<li><a href="#enum-constant-summary" tabindex="0">Enum Constant Summary</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="#enum-constant-detail" tabindex="0">Enum Constant Details</a>
|
||||
<ol class="toc-list">
|
||||
<li><a href="#WAITING" tabindex="0">WAITING</a></li>
|
||||
<li><a href="#TOTEM_CHOICE" tabindex="0">TOTEM_CHOICE</a></li>
|
||||
<li><a href="#SLOT_CHOICE" tabindex="0">SLOT_CHOICE</a></li>
|
||||
<li><a href="#RES_ACTIONS" tabindex="0">RES_ACTIONS</a></li>
|
||||
<li><a href="#OPT_CARD_E" tabindex="0">OPT_CARD_E</a></li>
|
||||
<li><a href="#RES_EVENT" tabindex="0">RES_EVENT</a></li>
|
||||
<li><a href="#ENDING" tabindex="0">ENDING</a></li>
|
||||
<li><a href="#ENDED" tabindex="0">ENDED</a></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><a href="#field-detail" tabindex="0">Field Details</a>
|
||||
<ol class="toc-list">
|
||||
<li><a href="#displayName" tabindex="0">displayName</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">GameStages(String)</a></li>
|
||||
</ol>
|
||||
</li>
|
||||
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
||||
<ol class="toc-list">
|
||||
<li><a href="#values()" tabindex="0">values()</a></li>
|
||||
<li><a href="#valueOf(java.lang.String)" tabindex="0">valueOf(String)</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="Enum Class GameStages" class="title">Enum Class GameStages</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"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a>>
|
||||
<div class="inheritance">it.polimi.ingsw.gc14.Model.GamePackage.GameStages</div>
|
||||
</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>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a>>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">GameStages</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a>></span></div>
|
||||
<div class="block">Represents the possible stages of a game.</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="nested-class-summary" id="nested-class-summary">
|
||||
<h2>Nested Class Summary</h2>
|
||||
<div class="inherited-list">
|
||||
<h3 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#nested-class-summary" title="class or interface in java.lang" class="external-link">Enum</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><E></code></div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="constants-summary" id="enum-constant-summary">
|
||||
<h2>Enum Constant Summary</h2>
|
||||
<div class="caption"><span>Enum Constants</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Enum Constant</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code><a href="#ENDED" class="member-name-link">ENDED</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Stage indicating that the game has ended.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="#ENDING" class="member-name-link">ENDING</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Stage in which end-of-game scoring and ranking are computed.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code><a href="#OPT_CARD_E" class="member-name-link">OPT_CARD_E</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Stage in which an optional card effect can be resolved.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="#RES_ACTIONS" class="member-name-link">RES_ACTIONS</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Stage in which the mandatory actions associated with the chosen slots are resolved.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code><a href="#RES_EVENT" class="member-name-link">RES_EVENT</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Stage in which an event card is being resolved.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="#SLOT_CHOICE" class="member-name-link">SLOT_CHOICE</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Stage in which players select their action slots.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code><a href="#TOTEM_CHOICE" class="member-name-link">TOTEM_CHOICE</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Stage in which players choose their totems.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="#WAITING" class="member-name-link">WAITING</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Stage in which the game is waiting for players to join.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- =========== 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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#displayName" class="member-name-link">displayName</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The human-readable name of this stage, used in <a href="#toString()"><code>toString()</code></a>.</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 three-column-summary">
|
||||
<div class="table-header col-first">Modifier</div>
|
||||
<div class="table-header col-second">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>private </code></div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">GameStages</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> displayName)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a <code>GameStages</code> value with the given display name.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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><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">Returns the human-readable name of this stage.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</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> name)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a>[]</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Returns an array containing the constants of this enum class, in
|
||||
the order they are declared.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#method-summary" title="class or interface in java.lang" class="external-link">Enum</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.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/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.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/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></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#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">
|
||||
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
||||
<li>
|
||||
<section class="constant-details" id="enum-constant-detail">
|
||||
<h2>Enum Constant Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="WAITING">
|
||||
<h3>WAITING</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">WAITING</span></div>
|
||||
<div class="block">Stage in which the game is waiting for players to join.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="TOTEM_CHOICE">
|
||||
<h3>TOTEM_CHOICE</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">TOTEM_CHOICE</span></div>
|
||||
<div class="block">Stage in which players choose their totems.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="SLOT_CHOICE">
|
||||
<h3>SLOT_CHOICE</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">SLOT_CHOICE</span></div>
|
||||
<div class="block">Stage in which players select their action slots.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="RES_ACTIONS">
|
||||
<h3>RES_ACTIONS</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">RES_ACTIONS</span></div>
|
||||
<div class="block">Stage in which the mandatory actions associated with the chosen slots are resolved.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="OPT_CARD_E">
|
||||
<h3>OPT_CARD_E</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">OPT_CARD_E</span></div>
|
||||
<div class="block">Stage in which an optional card effect can be resolved.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="RES_EVENT">
|
||||
<h3>RES_EVENT</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">RES_EVENT</span></div>
|
||||
<div class="block">Stage in which an event card is being resolved.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="ENDING">
|
||||
<h3>ENDING</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">ENDING</span></div>
|
||||
<div class="block">Stage in which end-of-game scoring and ranking are computed.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="ENDED">
|
||||
<h3>ENDED</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">ENDED</span></div>
|
||||
<div class="block">Stage indicating that the game has ended.</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="displayName">
|
||||
<h3>displayName</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">displayName</span></div>
|
||||
<div class="block">The human-readable name of this stage, used in <a href="#toString()"><code>toString()</code></a>.</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>GameStages</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="element-name">GameStages</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> displayName)</span></div>
|
||||
<div class="block">Constructs a <code>GameStages</code> value with the given display name.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>displayName</code> - the human-readable label for this stage</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="values()">
|
||||
<h3>values</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a>[]</span> <span class="element-name">values</span>()</div>
|
||||
<div class="block">Returns an array containing the constants of this enum class, in
|
||||
the order they are declared.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>an array containing the constants of this enum class, in the order they are declared</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="valueOf(java.lang.String)">
|
||||
<h3>valueOf</h3>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></span> <span class="element-name">valueOf</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> name)</span></div>
|
||||
<div class="block">Returns the enum constant of this class with the specified name.
|
||||
The string must match <i>exactly</i> an identifier used to declare an
|
||||
enum constant in this class. (Extraneous whitespace characters are
|
||||
not permitted.)</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>the enum constant with the specified name</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> - if this enum class has no constant with the specified name</dd>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</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">Returns the human-readable name of this stage.</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/Enum.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/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a>></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>the display name (e.g. <code>"Slot"</code> for <code>SLOT_CHOICE</code>)</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="it">
|
||||
<head>
|
||||
<!-- Generated by javadoc (25) on Fri Jun 19 23:05:23 CEST 2026 -->
|
||||
<title>it.polimi.ingsw.gc14.Model.GamePackage</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.GamePackage">
|
||||
<meta name="generator" content="javadoc/PackageWriter">
|
||||
<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="package-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">Package</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#package">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" class="current-selection">it.polimi.ingsw.gc14.Model.GamePackage</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</div>
|
||||
<ol class="toc-list" tabindex="-1">
|
||||
<li><a href="#" tabindex="0">Description</a></li>
|
||||
<li><a href="#related-package-summary" tabindex="0">Related Packages</a></li>
|
||||
<li><a href="#class-summary" tabindex="0">Classes and Interfaces</a></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">
|
||||
<div class="header">
|
||||
<h1 title="Package it.polimi.ingsw.gc14.Model.GamePackage" class="title">Package it.polimi.ingsw.gc14.Model.GamePackage</h1>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="horizontal-scroll">
|
||||
<div class="package-signature">package <span class="element-name">it.polimi.ingsw.gc14.Model.GamePackage</span></div>
|
||||
</div>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
<div id="related-package-summary">
|
||||
<div class="caption"><span>Related Packages</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">it.polimi.ingsw.gc14.Model</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><a href="../Cards/package-summary.html">it.polimi.ingsw.gc14.Model.Cards</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><a href="../Orders/package-summary.html">it.polimi.ingsw.gc14.Model.Orders</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div id="class-summary">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div>
|
||||
<div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0">
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Board.html" title="class in it.polimi.ingsw.gc14.Model.GamePackage">Board</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Board manages all the elements during the game such as decks, upper and lower rows, totems, tiles...</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CurrentState.html" title="class in it.polimi.ingsw.gc14.Model.GamePackage">CurrentState</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Represents the current state of the game.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="GameStages.html" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab3">
|
||||
<div class="block">Represents the possible stages of a game.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
+89
@@ -0,0 +1,89 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="it">
|
||||
<head>
|
||||
<!-- Generated by javadoc (25) on Fri Jun 19 23:05:23 CEST 2026 -->
|
||||
<title>it.polimi.ingsw.gc14.Model.GamePackage Class Hierarchy</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="tree: module: it.polimi.ingsw.gc14, package: it.polimi.ingsw.gc14.Model.GamePackage">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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="package-tree-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><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">Tree</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#tree">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" class="current-selection">it.polimi.ingsw.gc14.Model.GamePackage</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">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">Hierarchy For Package it.polimi.ingsw.gc14.Model.GamePackage</h1>
|
||||
</div>
|
||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
||||
<ul class="horizontal contents-list">
|
||||
<li><a href="../../../../../../../overview-tree.html">All Packages</a></li>
|
||||
</ul>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">it.polimi.ingsw.gc14.Model.GamePackage.<a href="Board.html" class="type-name-link" title="class in it.polimi.ingsw.gc14.Model.GamePackage">Board</a> (implements java.io.<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>)</li>
|
||||
<li class="circle">it.polimi.ingsw.gc14.Model.GamePackage.<a href="CurrentState.html" class="type-name-link" title="class in it.polimi.ingsw.gc14.Model.GamePackage">CurrentState</a> (implements java.io.<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>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<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>)
|
||||
<ul>
|
||||
<li class="circle">it.polimi.ingsw.gc14.Model.GamePackage.<a href="GameStages.html" class="type-name-link" title="enum class in it.polimi.ingsw.gc14.Model.GamePackage">GameStages</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user