Vassyli
205 lines
14 KiB
HTML
205 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Documentation</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<base href="../">
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
<link rel="stylesheet" href="css/base.css">
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="css/template.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
<script src="js/search.js"></script>
|
|
<script defer src="js/searchIndex.js"></script>
|
|
</head>
|
|
<body id="top">
|
|
<header class="phpdocumentor-header phpdocumentor-section">
|
|
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
|
|
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
<i class="fas fa-bars"></i>
|
|
</label>
|
|
<section data-search-form class="phpdocumentor-search">
|
|
<label>
|
|
<span class="visually-hidden">Search for</span>
|
|
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
</svg>
|
|
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
</label>
|
|
</section>
|
|
|
|
<nav class="phpdocumentor-topnav">
|
|
<ul class="phpdocumentor-topnav__menu">
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="phpdocumentor">
|
|
<div class="phpdocumentor-section">
|
|
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
Menu
|
|
</label>
|
|
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/lotgd.html">LotGD</a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/lotgd-core.html">Core</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/Application.html">Application</a></h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
</section>
|
|
</aside>
|
|
|
|
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/lotgd.html">LotGD</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -namespace">
|
|
<h2 class="phpdocumentor-content__title">Core</h2>
|
|
|
|
|
|
<h3 id="namespaces">
|
|
Namespaces
|
|
<a href="#namespaces" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-console.html"><abbr title="\LotGD\Core\Console">Console</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-doctrine.html"><abbr title="\LotGD\Core\Doctrine">Doctrine</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-events.html"><abbr title="\LotGD\Core\Events">Events</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-exceptions.html"><abbr title="\LotGD\Core\Exceptions">Exceptions</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-models.html"><abbr title="\LotGD\Core\Models">Models</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-phpunit.html"><abbr title="\LotGD\Core\PHPUnit">PHPUnit</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-scenetemplates.html"><abbr title="\LotGD\Core\SceneTemplates">SceneTemplates</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-services.html"><abbr title="\LotGD\Core\Services">Services</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-tools.html"><abbr title="\LotGD\Core\Tools">Tools</abbr></a></dt>
|
|
</dl>
|
|
|
|
<h3 id="interfaces_class_traits">
|
|
Interfaces, Classes and Traits
|
|
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-AttachmentInterface.html"><abbr title="\LotGD\Core\AttachmentInterface">AttachmentInterface</abbr></a></dt>
|
|
<dd></dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-EventHandler.html"><abbr title="\LotGD\Core\EventHandler">EventHandler</abbr></a></dt>
|
|
<dd></dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-GameAwareInterface.html"><abbr title="\LotGD\Core\GameAwareInterface">GameAwareInterface</abbr></a></dt>
|
|
<dd>Interface for classes that are aware of the game.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-Module.html"><abbr title="\LotGD\Core\Module">Module</abbr></a></dt>
|
|
<dd>Classes which provide module functionality should implement this interface.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Action.html"><abbr title="\LotGD\Core\Action">Action</abbr></a></dt>
|
|
<dd>A representation of an action the user can take to affect the game
|
|
state. An encapsulation of a navigation menu option.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-ActionGroup.html"><abbr title="\LotGD\Core\ActionGroup">ActionGroup</abbr></a></dt>
|
|
<dd>A grouping of navigation actions, like a submenu.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Attachment.html"><abbr title="\LotGD\Core\Attachment">Attachment</abbr></a></dt>
|
|
<dd>An attachment to a scene. This is desigend to be subclasses by modules to
|
|
provide functinoality like forms or maybe image attachments to go along with a scene.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Battle.html"><abbr title="\LotGD\Core\Battle">Battle</abbr></a></dt>
|
|
<dd>Class for managing and running battles between 2 participants.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Bootstrap.html"><abbr title="\LotGD\Core\Bootstrap">Bootstrap</abbr></a></dt>
|
|
<dd>The entry point for constructing a properly configured LotGD Game object.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-BuffList.html"><abbr title="\LotGD\Core\BuffList">BuffList</abbr></a></dt>
|
|
<dd>Description of BuffList.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a></dt>
|
|
<dd>Helps perform tasks with the composer configuration.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a></dt>
|
|
<dd>The configuration information for a LotGD game. Configuration is read from
|
|
a YAML file, who's path is specified when you construct the object.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a></dt>
|
|
<dd>A collection of random number generators, with various distributions.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a></dt>
|
|
<dd>Manages a simple publish/subscribe system based on regular expressions
|
|
matching event names and running a fixed.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Game.html"><abbr title="\LotGD\Core\Game">Game</abbr></a></dt>
|
|
<dd>The main game class.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-GameBuilder.html"><abbr title="\LotGD\Core\GameBuilder">GameBuilder</abbr></a></dt>
|
|
<dd>The GameBuilder class is used to build a Game object with all dependencies that are needed.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-LibraryConfiguration.html"><abbr title="\LotGD\Core\LibraryConfiguration">LibraryConfiguration</abbr></a></dt>
|
|
<dd>Represents the configuration of a LotGD library (like the core, crate or module),
|
|
with its configuration parameters.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-LibraryConfigurationManager.html"><abbr title="\LotGD\Core\LibraryConfigurationManager">LibraryConfigurationManager</abbr></a></dt>
|
|
<dd>Handle the library configurations for the installed core, crate and modules.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a></dt>
|
|
<dd>Manages the message system overall
|
|
Class MessageManager.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-ModelExtender.html"><abbr title="\LotGD\Core\ModelExtender">ModelExtender</abbr></a></dt>
|
|
<dd>Contains method to help the extension of a model.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a></dt>
|
|
<dd>Handles the adding and removing of modules to the game.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-PermissionManager.html"><abbr title="\LotGD\Core\PermissionManager">PermissionManager</abbr></a></dt>
|
|
<dd>The PermissionManager manages (checks and manipulates) permissions of actors.</dd>
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-TimeKeeper.html"><abbr title="\LotGD\Core\TimeKeeper">TimeKeeper</abbr></a></dt>
|
|
<dd>Configurable way to convert back and forth between real time and game time.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
<section class="phpdocumentor-search-results__dialog">
|
|
<header class="phpdocumentor-search-results__header">
|
|
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
</header>
|
|
<section class="phpdocumentor-search-results__body">
|
|
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
<a href="namespaces/lotgd-core.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
</body>
|
|
</html>
|