aheh/core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
core/docs/namespaces/lotgd-core-models.html
T
Vassyli 1c30183ce3 Adding generated Documentation
2021-09-08 22:36:12 +02:00

221 lines
16 KiB
HTML
Raw Permalink Blame History

<!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>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/lotgd-core.html">Core</a></li>
</ul>
<article class="phpdocumentor-element -namespace">
<h2 class="phpdocumentor-content__title">Models</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-models-battleevents.html"><abbr title="\LotGD\Core\Models\BattleEvents">BattleEvents</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-models-characterstats.html"><abbr title="\LotGD\Core\Models\CharacterStats">CharacterStats</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/lotgd-core-models-repositories.html"><abbr title="\LotGD\Core\Models\Repositories">Repositories</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-Models-CharacterInterface.html"><abbr title="\LotGD\Core\Models\CharacterInterface">CharacterInterface</abbr></a></dt>
<dd>Interface for the character model and all objects that mimick such a model.</dd>
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-Models-CreateableInterface.html"><abbr title="\LotGD\Core\Models\CreateableInterface">CreateableInterface</abbr></a></dt>
<dd>Interface for createable models.</dd>
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-Models-ExtendableModelInterface.html"><abbr title="\LotGD\Core\Models\ExtendableModelInterface">ExtendableModelInterface</abbr></a></dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-Models-FighterInterface.html"><abbr title="\LotGD\Core\Models\FighterInterface">FighterInterface</abbr></a></dt>
<dd>Interface for models that should be able to participate in fights.</dd>
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-Models-PermissionAssociationInterface.html"><abbr title="\LotGD\Core\Models\PermissionAssociationInterface">PermissionAssociationInterface</abbr></a></dt>
<dd>Extend this class to provide an association between an entity and a permission.</dd>
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-Models-SaveableInterface.html"><abbr title="\LotGD\Core\Models\SaveableInterface">SaveableInterface</abbr></a></dt>
<dd>Interface for createable models.</dd>
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/LotGD-Core-Models-SceneConnectable.html"><abbr title="\LotGD\Core\Models\SceneConnectable">SceneConnectable</abbr></a></dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Actor.html"><abbr title="\LotGD\Core\Models\Actor">Actor</abbr></a></dt>
<dd>This abtract class provides functionality for user entities that crates might
want to implement, such as permissions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-BasicEnemy.html"><abbr title="\LotGD\Core\Models\BasicEnemy">BasicEnemy</abbr></a></dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Buff.html"><abbr title="\LotGD\Core\Models\Buff">Buff</abbr></a></dt>
<dd>A model representing a buff used to modify the flow of the battle.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a></dt>
<dd>Model for a character.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-CharacterProperty.html"><abbr title="\LotGD\Core\Models\CharacterProperty">CharacterProperty</abbr></a></dt>
<dd>Properties for Characters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-CharacterStatGroup.html"><abbr title="\LotGD\Core\Models\CharacterStatGroup">CharacterStatGroup</abbr></a></dt>
<dd>Class CharacterStatGroup.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-CharacterStats.html"><abbr title="\LotGD\Core\Models\CharacterStats">CharacterStats</abbr></a></dt>
<dd>Class CharacterStats.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-EventSubscription.html"><abbr title="\LotGD\Core\Models\EventSubscription">EventSubscription</abbr></a></dt>
<dd>An event name to class binding that represents that class listening for that
event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-GameConfiguration.html"><abbr title="\LotGD\Core\Models\GameConfiguration">GameConfiguration</abbr></a></dt>
<dd>Provides an interface to access properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-GameConfigurationElement.html"><abbr title="\LotGD\Core\Models\GameConfigurationElement">GameConfigurationElement</abbr></a></dt>
<dd>Properties for Characters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Message.html"><abbr title="\LotGD\Core\Models\Message">Message</abbr></a></dt>
<dd>Model for messages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-MessageThread.html"><abbr title="\LotGD\Core\Models\MessageThread">MessageThread</abbr></a></dt>
<dd>A Thread of messages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-MissingCharacter.html"><abbr title="\LotGD\Core\Models\MissingCharacter">MissingCharacter</abbr></a></dt>
<dd>Provides a basic implementation of CharacterInterface to return the most
important data a missing character might still need.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Module.html"><abbr title="\LotGD\Core\Models\Module">Module</abbr></a></dt>
<dd>An installed module in the system. Note that module metadata is stored in
the composer.json for each module.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-ModuleProperty.html"><abbr title="\LotGD\Core\Models\ModuleProperty">ModuleProperty</abbr></a></dt>
<dd>A place for modules to store per-module private data.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Monster.html"><abbr title="\LotGD\Core\Models\Monster">Monster</abbr></a></dt>
<dd>The Monster entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-MotD.html"><abbr title="\LotGD\Core\Models\MotD">MotD</abbr></a></dt>
<dd>Model for the message of the day.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Permission.html"><abbr title="\LotGD\Core\Models\Permission">Permission</abbr></a></dt>
<dd>Represents a permission.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-SceneAttachment.html"><abbr title="\LotGD\Core\Models\SceneAttachment">SceneAttachment</abbr></a></dt>
<dd>A SceneAttachment is a registered Attachment class to keep track of
(a) generally all available attachments, and
(b) which scene contains which attachment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-SceneConnection.html"><abbr title="\LotGD\Core\Models\SceneConnection">SceneConnection</abbr></a></dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-SceneConnectionGroup.html"><abbr title="\LotGD\Core\Models\SceneConnectionGroup">SceneConnectionGroup</abbr></a></dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-SceneProperty.html"><abbr title="\LotGD\Core\Models\SceneProperty">SceneProperty</abbr></a></dt>
<dd>A place for modules to store per-module private data.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-SceneTemplate.html"><abbr title="\LotGD\Core\Models\SceneTemplate">SceneTemplate</abbr></a></dt>
<dd>Class SceneTemplates.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-SystemCharacter.html"><abbr title="\LotGD\Core\Models\SystemCharacter">SystemCharacter</abbr></a></dt>
<dd>Provides a basic system character to serve as an anonymous user.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a></dt>
<dd>A Viewpoint is the current Scene a character is experiencing with
all changes from modules included.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/LotGD-Core-Models-ViewpointSnapshot.html"><abbr title="\LotGD\Core\Models\ViewpointSnapshot">ViewpointSnapshot</abbr></a></dt>
<dd>Represents a complete set of viewpoint data used to restore a saved viewpoint.</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-models.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>
Reference in New Issue View Git Blame Copy Permalink