Added: JAVADOC html in deliverables

This commit is contained in:
rubenpirreram
2026-06-19 23:09:49 +02:00
parent 1b155e7056
commit db65e0a8be
222 changed files with 55370 additions and 25 deletions
@@ -0,0 +1,182 @@
<!DOCTYPE HTML>
<html lang="it">
<head>
<!-- Generated by javadoc (25) on Fri Jun 19 23:05:23 CEST 2026 -->
<title>M-Index</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="index: M">
<meta name="generator" content="javadoc/IndexWriter">
<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="index-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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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="../it.polimi.ingsw.gc14/module-summary.html">Module</a></li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list"></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>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">J</a>&nbsp;<a href="index-11.html">K</a>&nbsp;<a href="index-12.html">L</a>&nbsp;<a href="index-13.html">M</a>&nbsp;<a href="index-14.html">N</a>&nbsp;<a href="index-15.html">O</a>&nbsp;<a href="index-16.html">P</a>&nbsp;<a href="index-17.html">Q</a>&nbsp;<a href="index-18.html">R</a>&nbsp;<a href="index-19.html">S</a>&nbsp;<a href="index-20.html">T</a>&nbsp;<a href="index-21.html">U</a>&nbsp;<a href="index-22.html">V</a>&nbsp;<a href="index-23.html">W</a>&nbsp;<a href="index-24.html">X</a>&nbsp;<a href="index-25.html">Y</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized&nbsp;Form</a>
<h2 class="title" id="I:M">M</h2>
<dl class="index">
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/ClientLauncherGUI.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class it.polimi.ingsw.gc14.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/ClientLauncherGUI.html" title="class in it.polimi.ingsw.gc14">ClientLauncherGUI</a></dt>
<dd>
<div class="block">Launches the GUI application.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/ClientLauncherTUI.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class it.polimi.ingsw.gc14.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/ClientLauncherTUI.html" title="class in it.polimi.ingsw.gc14">ClientLauncherTUI</a></dt>
<dd>
<div class="block">Launches the TUI client.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/ServerLauncher.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - Static method in class it.polimi.ingsw.gc14.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/ServerLauncher.html" title="class in it.polimi.ingsw.gc14">ServerLauncher</a></dt>
<dd>
<div class="block">Initializes all server components, wires them together, restores a saved
game if available, and starts the event-processing loop and both network
servers.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/MainFXMLController.html" class="type-name-link" title="class in it.polimi.ingsw.gc14.View.GUI">MainFXMLController</a> - Class in <a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/package-summary.html">it.polimi.ingsw.gc14.View.GUI</a></dt>
<dd>
<div class="block">FXML controller for the main game scene.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/MainFXMLController.html#%3Cinit%3E()" class="member-name-link">MainFXMLController()</a> - Constructor for class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/MainFXMLController.html" title="class in it.polimi.ingsw.gc14.View.GUI">MainFXMLController</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/TCP/Server/HeartbeatHandler.html#mainHandler" class="member-name-link">mainHandler</a> - Variable in class it.polimi.ingsw.gc14.Network.TCP.Server.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/TCP/Server/HeartbeatHandler.html" title="class in it.polimi.ingsw.gc14.Network.TCP.Server">HeartbeatHandler</a></dt>
<dd>
<div class="block">Main client handler associated with this heartbeat connection.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/MainFXMLController.html#mainHBox" class="member-name-link">mainHBox</a> - Variable in class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/MainFXMLController.html" title="class in it.polimi.ingsw.gc14.View.GUI">MainFXMLController</a></dt>
<dd>
<div class="block">Root HBox containing all main scene elements.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/TotemFXMLController.html#mainHBox" class="member-name-link">mainHBox</a> - Variable in class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/TotemFXMLController.html" title="class in it.polimi.ingsw.gc14.View.GUI">TotemFXMLController</a></dt>
<dd>
<div class="block">HBox containing the totem card widgets.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/TCP/Client/TCPClient.html#mainPort" class="member-name-link">mainPort</a> - Variable in class it.polimi.ingsw.gc14.Network.TCP.Client.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/TCP/Client/TCPClient.html" title="class in it.polimi.ingsw.gc14.Network.TCP.Client">TCPClient</a></dt>
<dd>
<div class="block">TCP port</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/GUI.html#mainScene" class="member-name-link">mainScene</a> - Variable in class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/GUI.html" title="class in it.polimi.ingsw.gc14.View.GUI">GUI</a></dt>
<dd>
<div class="block">The main game scene.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/LeaderboardFXMLController.html#mainVBox" class="member-name-link">mainVBox</a> - Variable in class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/LeaderboardFXMLController.html" title="class in it.polimi.ingsw.gc14.View.GUI">LeaderboardFXMLController</a></dt>
<dd>
<div class="block">Main vertical container holding the outcome label and ranking rows.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/LimitedMap.html#map" class="member-name-link">map</a> - Variable in class it.polimi.ingsw.gc14.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/LimitedMap.html" title="class in it.polimi.ingsw.gc14">LimitedMap</a></dt>
<dd>
<div class="block">The underlying thread-safe hash map storing all key-value pairs.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/Orders/OrderPlayer.html#markAsPlayed()" class="member-name-link">markAsPlayed()</a> - Method in class it.polimi.ingsw.gc14.Model.Orders.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/Orders/OrderPlayer.html" title="class in it.polimi.ingsw.gc14.Model.Orders">OrderPlayer</a></dt>
<dd>
<div class="block">Marks this player as having played in the current order sequence.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/FireParticleSystem.html#MAX_PARTICLES" class="member-name-link">MAX_PARTICLES</a> - Static variable in class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/FireParticleSystem.html" title="class in it.polimi.ingsw.gc14.View.GUI">FireParticleSystem</a></dt>
<dd>
<div class="block">Maximum number of live particles at any given time.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/NetworkConfig.html#MAX_PLAYERS" class="member-name-link">MAX_PLAYERS</a> - Static variable in class it.polimi.ingsw.gc14.Network.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/NetworkConfig.html" title="class in it.polimi.ingsw.gc14.Network">NetworkConfig</a></dt>
<dd>
<div class="block">Maximum number of players allowed in a game.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/Player.html#MAX_USERNAME_LENGTH" class="member-name-link">MAX_USERNAME_LENGTH</a> - Static variable in class it.polimi.ingsw.gc14.Model.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/Player.html" title="class in it.polimi.ingsw.gc14.Model">Player</a></dt>
<dd>
<div class="block">The maximum length allowed for the username string.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html#mb" class="member-name-link">mb</a> - Variable in enum class it.polimi.ingsw.gc14.View.TUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html" title="enum class in it.polimi.ingsw.gc14.View.TUI">BorderStyle</a></dt>
<dd>
<div class="block">Corner (tl/tr/bl/br), line (h/v), outer junction (ml/mr/mt/mb/x), and separator junction (sl/sr/sx) characters.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html#mb()" class="member-name-link">mb()</a> - Method in enum class it.polimi.ingsw.gc14.View.TUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html" title="enum class in it.polimi.ingsw.gc14.View.TUI">BorderStyle</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/NetworkConfig.html#MIN_PLAYERS" class="member-name-link">MIN_PLAYERS</a> - Static variable in class it.polimi.ingsw.gc14.Network.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/NetworkConfig.html" title="class in it.polimi.ingsw.gc14.Network">NetworkConfig</a></dt>
<dd>
<div class="block">Minimum number of players required to start a game.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Controller/ClientController.html#miniModel" class="member-name-link">miniModel</a> - Variable in class it.polimi.ingsw.gc14.Controller.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Controller/ClientController.html" title="class in it.polimi.ingsw.gc14.Controller">ClientController</a></dt>
<dd>
<div class="block">Local mini model representing the client-side game state.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/GUI.html#miniModel" class="member-name-link">miniModel</a> - Variable in class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/GUI.html" title="class in it.polimi.ingsw.gc14.View.GUI">GUI</a></dt>
<dd>
<div class="block">Latest mini model received from the server.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/MiniModel.html" class="type-name-link" title="class in it.polimi.ingsw.gc14.Model">MiniModel</a> - Class in <a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/package-summary.html">it.polimi.ingsw.gc14.Model</a></dt>
<dd>
<div class="block">Lightweight representation of the game model shared with clients.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/MiniModel.html#%3Cinit%3E(java.util.Map,it.polimi.ingsw.gc14.Model.OrderLogicCard,it.polimi.ingsw.gc14.Model.GamePackage.CurrentState,java.util.List,java.util.List,java.util.ArrayList,java.util.ArrayList,java.util.ArrayList,java.util.ArrayList,java.util.ArrayList)" class="member-name-link">MiniModel(Map, OrderLogicCard, CurrentState, List, List, ArrayList, ArrayList, ArrayList, ArrayList, ArrayList)</a> - Constructor for class it.polimi.ingsw.gc14.Model.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Model/MiniModel.html" title="class in it.polimi.ingsw.gc14.Model">MiniModel</a></dt>
<dd>
<div class="block">Constructs a complete mini model from the current server-side game data.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html#ml" class="member-name-link">ml</a> - Variable in enum class it.polimi.ingsw.gc14.View.TUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html" title="enum class in it.polimi.ingsw.gc14.View.TUI">BorderStyle</a></dt>
<dd>
<div class="block">Corner (tl/tr/bl/br), line (h/v), outer junction (ml/mr/mt/mb/x), and separator junction (sl/sr/sx) characters.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Controller/GameController.html#model" class="member-name-link">model</a> - Variable in class it.polimi.ingsw.gc14.Controller.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Controller/GameController.html" title="class in it.polimi.ingsw.gc14.Controller">GameController</a></dt>
<dd>
<div class="block">The game model managed by this controller.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/TUI.html#model" class="member-name-link">model</a> - Variable in class it.polimi.ingsw.gc14.View.TUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/TUI.html" title="class in it.polimi.ingsw.gc14.View.TUI">TUI</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html#mr" class="member-name-link">mr</a> - Variable in enum class it.polimi.ingsw.gc14.View.TUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html" title="enum class in it.polimi.ingsw.gc14.View.TUI">BorderStyle</a></dt>
<dd>
<div class="block">Corner (tl/tr/bl/br), line (h/v), outer junction (ml/mr/mt/mb/x), and separator junction (sl/sr/sx) characters.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html#mt" class="member-name-link">mt</a> - Variable in enum class it.polimi.ingsw.gc14.View.TUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html" title="enum class in it.polimi.ingsw.gc14.View.TUI">BorderStyle</a></dt>
<dd>
<div class="block">Corner (tl/tr/bl/br), line (h/v), outer junction (ml/mr/mt/mb/x), and separator junction (sl/sr/sx) characters.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html#mt()" class="member-name-link">mt()</a> - Method in enum class it.polimi.ingsw.gc14.View.TUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/TUI/BorderStyle.html" title="enum class in it.polimi.ingsw.gc14.View.TUI">BorderStyle</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/MainFXMLController.html#myHand" class="member-name-link">myHand</a> - Variable in class it.polimi.ingsw.gc14.View.GUI.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/View/GUI/MainFXMLController.html" title="class in it.polimi.ingsw.gc14.View.GUI">MainFXMLController</a></dt>
<dd>
<div class="block">HBox displaying the local player's card piles.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/RMI/Client/RMIClient.html#myIp" class="member-name-link">myIp</a> - Variable in class it.polimi.ingsw.gc14.Network.RMI.Client.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Network/RMI/Client/RMIClient.html" title="class in it.polimi.ingsw.gc14.Network.RMI.Client">RMIClient</a></dt>
<dd>
<div class="block">Local IP address advertised to the RMI runtime so callbacks are routed correctly.</div>
</dd>
<dt><a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Controller/ClientController.html#myUsername" class="member-name-link">myUsername</a> - Variable in class it.polimi.ingsw.gc14.Controller.<a href="../it.polimi.ingsw.gc14/it/polimi/ingsw/gc14/Controller/ClientController.html" title="class in it.polimi.ingsw.gc14.Controller">ClientController</a></dt>
<dd>
<div class="block">Username associated with this client.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">J</a>&nbsp;<a href="index-11.html">K</a>&nbsp;<a href="index-12.html">L</a>&nbsp;<a href="index-13.html">M</a>&nbsp;<a href="index-14.html">N</a>&nbsp;<a href="index-15.html">O</a>&nbsp;<a href="index-16.html">P</a>&nbsp;<a href="index-17.html">Q</a>&nbsp;<a href="index-18.html">R</a>&nbsp;<a href="index-19.html">S</a>&nbsp;<a href="index-20.html">T</a>&nbsp;<a href="index-21.html">U</a>&nbsp;<a href="index-22.html">V</a>&nbsp;<a href="index-23.html">W</a>&nbsp;<a href="index-24.html">X</a>&nbsp;<a href="index-25.html">Y</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a><span class="vertical-separator">|</span><a href="../serialized-form.html">Serialized&nbsp;Form</a></main>
</div>
</body>
</html>