225 lines
22 KiB
HTML
225 lines
22 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>All Classes and Interfaces (server API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="class index">
|
|
<meta name="generator" content="javadoc/AllClassesIndexWriter">
|
|
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="script.js"></script>
|
|
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="all-classes-index-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "./";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<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="server/module-summary.html">Module</a></li>
|
|
<li>Package</li>
|
|
<li>Class</li>
|
|
<li><a href="overview-tree.html">Tree</a></li>
|
|
<li><a href="index-all.html">Index</a></li>
|
|
<li><a href="help-doc.html#all-classes">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<div class="header">
|
|
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
|
|
</div>
|
|
<div id="all-classes-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button></div>
|
|
<div id="all-classes-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
|
|
<div class="table-header col-first">Class</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/AbstractAction.html" title="class in fr.lnl.game.server.games.action">AbstractAction</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/elements/AbstractBox.html" title="class in fr.lnl.game.server.games.grid.elements">AbstractBox</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">AbstractBox is instantiable (not an abstract class), but when it's the case, instance doesn't represent anything,
|
|
it's only to see if there is a lock on this position or not</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/build/AbstractGridFactoryBuilder.html" title="class in fr.lnl.game.server.games.grid.build">AbstractGridFactoryBuilder</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/listener/AbstractModelListening.html" title="class in fr.lnl.game.server.listener">AbstractModelListening</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/player/AbstractPlayer.html" title="class in fr.lnl.game.server.games.player">AbstractPlayer</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/action/Action.html" title="interface in fr.lnl.game.server.games.action">Action</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/elements/Bomb.html" title="class in fr.lnl.game.server.games.grid.elements">Bomb</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Bomb are elements which explode when someone walks on it or after a countdown, the explosion area is on multiple cases</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/grid/elements/Box.html" title="interface in fr.lnl.game.server.games.grid.elements">Box</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="server/fr/lnl/game/server/games/player/ClassPlayer.html" title="enum class in fr.lnl.game.server.games.player">ClassPlayer</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
|
|
<div class="block">ClassPlayer contains all data about the cost of an action or the cost of a damage</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/player/ComputerPlayer.html" title="class in fr.lnl.game.server.games.player">ComputerPlayer</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Super class of all Computer players</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/grid/elements/CountdownBox.html" title="interface in fr.lnl.game.server.games.grid.elements">CountdownBox</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
|
|
<div class="block">A box implemented by CountdownBox is a box which do an action a certain time after being placed</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="server/fr/lnl/game/server/utils/CrashException.html" title="class in fr.lnl.game.server.utils">CrashException</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
|
<div class="block">Represent an unrecoverable error in the program, force program to stop</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/DeployShield.html" title="class in fr.lnl.game.server.games.action">DeployShield</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Used when a player want to protect himself from taking damage (shield state is reset to false at next player turn)</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/action/Direction.html" title="interface in fr.lnl.game.server.games.action">Direction</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="server/fr/lnl/game/server/games/action/Direction4Axis.html" title="enum class in fr.lnl.game.server.games.action">Direction4Axis</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
|
|
<div class="block">Enum used to chose where to move, shot, etc.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="server/fr/lnl/game/server/games/action/Direction8Axis.html" title="enum class in fr.lnl.game.server.games.action">Direction8Axis</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/DropBomb.html" title="class in fr.lnl.game.server.games.action">DropBomb</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Used when player want to drop a <a href="server/fr/lnl/game/server/games/grid/elements/Bomb.html" title="class in fr.lnl.game.server.games.grid.elements"><code>Bomb</code></a>, bomb explode when someone walks on it and after 3 turns</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/DropMine.html" title="class in fr.lnl.game.server.games.action">DropMine</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Used when player want to drop a <a href="server/fr/lnl/game/server/games/grid/elements/Mine.html" title="class in fr.lnl.game.server.games.grid.elements"><code>Mine</code></a>, Mine only explode when someone walks on it</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/DropObject.html" title="class in fr.lnl.game.server.games.action">DropObject</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Super class used by <a href="server/fr/lnl/game/server/games/action/DropMine.html" title="class in fr.lnl.game.server.games.action"><code>DropMine</code></a> and <a href="server/fr/lnl/game/server/games/action/DropBomb.html" title="class in fr.lnl.game.server.games.action"><code>DropBomb</code></a></div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/elements/EnergyBall.html" title="class in fr.lnl.game.server.games.grid.elements">EnergyBall</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">An EnergyBall is a box which give back a bit of player energy after it walks on the ball</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/utils/ErrorMessage.html" title="class in fr.lnl.game.server.utils">ErrorMessage</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Contain everything related to error messages, theirs errors are the fault of the end-user (like we demand an integer
|
|
and user give us a floating point number
|
|
Theirs error doesn't cause the program to stop, it'll demand a correct value</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/elements/Explosive.html" title="class in fr.lnl.game.server.games.grid.elements">Explosive</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Super class of <a href="server/fr/lnl/game/server/games/grid/elements/Bomb.html" title="class in fr.lnl.game.server.games.grid.elements"><code>Bomb</code></a> and <a href="server/fr/lnl/game/server/games/grid/elements/Mine.html" title="class in fr.lnl.game.server.games.grid.elements"><code>Mine</code></a></div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/weapon/Firearm.html" title="class in fr.lnl.game.server.games.weapon">Firearm</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/Game.html" title="class in fr.lnl.game.server.games">Game</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/Grid.html" title="class in fr.lnl.game.server.games.grid">Grid</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Class managing the board</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/grid/build/GridFactoryBuilder.html" title="interface in fr.lnl.game.server.games.grid.build">GridFactoryBuilder</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
|
<div class="block">Factory pattern</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/player/HumanPlayer.html" title="class in fr.lnl.game.server.games.player">HumanPlayer</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Instance of Human Player.<br>
|
|
A human player choose an action to execute by using mouse or keyboard.<br>
|
|
Human Player don't implement choseAction cause this method is executed on client part</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/grid/elements/InteractiveBox.html" title="interface in fr.lnl.game.server.games.grid.elements">InteractiveBox</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
|
<div class="block">A box implemented by InteractiveBox is a box which do an action when someone walks on it</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/build/LockGridFactoryBuilder.html" title="class in fr.lnl.game.server.games.grid.build">LockGridFactoryBuilder</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/utils/Maths.html" title="class in fr.lnl.game.server.utils">Maths</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/elements/Mine.html" title="class in fr.lnl.game.server.games.grid.elements">Mine</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">A mine is an element which explose when someone walks on it, the explosion area is on 1 case only</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/listener/ModelListener.html" title="interface in fr.lnl.game.server.listener">ModelListener</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
|
|
<div class="block">Model implemented by <a href="server/fr/lnl/game/server/listener/AbstractModelListening.html" title="class in fr.lnl.game.server.listener"><code>AbstractModelListening</code></a></div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/Move.html" title="class in fr.lnl.game.server.games.action">Move</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Used when the player want to move in a direction, it can move in a direction when there is another player or a wall</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="server/fr/lnl/game/server/games/action/NoMoreBulletInWeaponException.html" title="class in fr.lnl.game.server.games.action">NoMoreBulletInWeaponException</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
|
<div class="block">This exception is throw when player has no remaining bullet</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/Nothing.html" title="class in fr.lnl.game.server.games.action">Nothing</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">This action is used when player doesn't want to move and/or loose energy</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="server/fr/lnl/game/server/games/action/NotValidDirectionException.html" title="class in fr.lnl.game.server.games.action">NotValidDirectionException</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
|
|
<div class="block">throw when action instantiated and the chosen direction in constructor isn't valid</div>
|
|
</div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/utils/Pair.html" title="class in fr.lnl.game.server.utils">Pair</a><<a href="server/fr/lnl/game/server/utils/Pair.html" title="type parameter in Pair">A</a>,<wbr><a href="server/fr/lnl/game/server/utils/Pair.html" title="type parameter in Pair">B</a>></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Tuple associating storing two value of undefined type.<br>
|
|
Unlike Python, value in this Tuple can be modified (but the type of its new value need to be the same)</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/player/Player.html" title="interface in fr.lnl.game.server.games.player">Player</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/utils/Point.html" title="class in fr.lnl.game.server.utils">Point</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">Point extends from Pair, basically a simpler ways to use Pair when using grid position</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/player/RandomComputerPlayer.html" title="class in fr.lnl.game.server.games.player">RandomComputerPlayer</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/ReunionSameAction.html" title="class in fr.lnl.game.server.games.action">ReunionSameAction</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">When we generate action, we generate one per available direction (like in <a href="server/fr/lnl/game/server/games/action/Move.html" title="class in fr.lnl.game.server.games.action"><code>Move</code></a>) but to improve human
|
|
readability, we list every same Action here</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/ServerMain.html" title="class in fr.lnl.game.server">ServerMain</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/action/Shot.html" title="class in fr.lnl.game.server.games.action">Shot</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/player/StrategyComputerPlayer.html" title="class in fr.lnl.game.server.games.player">StrategyComputerPlayer</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div>
|
|
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="server/fr/lnl/game/server/games/grid/elements/Wall.html" title="class in fr.lnl.game.server.games.grid.elements">Wall</a></div>
|
|
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
<div class="block">A wall is an intraversable object</div>
|
|
</div>
|
|
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="server/fr/lnl/game/server/games/weapon/Weapon.html" title="interface in fr.lnl.game.server.games.weapon">Weapon</a></div>
|
|
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|