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

1914 lines
88 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 -class">
<h2 class="phpdocumentor-content__title">
Game
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">The main game class.</p>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_character">$character</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a>|null </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_composerManager">$composerManager</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_configuration">$configuration</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_cwd">$cwd</a>
<span>
&nbsp;: string </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_diceBag">$diceBag</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_entityManager">$entityManager</a>
<span>
&nbsp;: <abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_eventManager">$eventManager</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_logger">$logger</a>
<span>
&nbsp;: <abbr title="\Monolog\Logger">Logger</abbr> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_messageManager">$messageManager</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_moduleManager">$moduleManager</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_sceneRenderer">$sceneRenderer</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-Services-TwigSceneRenderer.html"><abbr title="\LotGD\Core\Services\TwigSceneRenderer">TwigSceneRenderer</abbr></a> </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/LotGD-Core-Game.html#property_timeKeeper">$timeKeeper</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-TimeKeeper.html"><abbr title="\LotGD\Core\TimeKeeper">TimeKeeper</abbr></a>|null </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Construct a game. You probably want to use Bootstrap to do this.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getCharacter">getCharacter()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a> </span>
</dt>
<dd>Returns the currently configured user character.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getComposerManager">getComposerManager()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a> </span>
</dt>
<dd>Returns the game&#039;s composer manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getConfiguration">getConfiguration()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a> </span>
</dt>
<dd>Returns the game&#039;s configuration.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getCWD">getCWD()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the current working directory, or root directory where the
Composer configuration is based.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getDiceBag">getDiceBag()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a> </span>
</dt>
<dd>Returns the game&#039;s dice bag.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getEntityManager">getEntityManager()</a>
<span>
&nbsp;: <abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr> </span>
</dt>
<dd>Returns the game&#039;s entity manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getEventManager">getEventManager()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a> </span>
</dt>
<dd>Returns the game&#039;s event manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getLogger">getLogger()</a>
<span>
&nbsp;: <abbr title="\Monolog\Logger">Logger</abbr> </span>
</dt>
<dd>Returns the logger instance to write logs.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getMessageManager">getMessageManager()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a> </span>
</dt>
<dd>Returns the Message manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getModuleManager">getModuleManager()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a> </span>
</dt>
<dd>Returns the game&#039;s module manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getSceneRenderer">getSceneRenderer()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-Services-TwigSceneRenderer.html"><abbr title="\LotGD\Core\Services\TwigSceneRenderer">TwigSceneRenderer</abbr></a> </span>
</dt>
<dd>Returns the default scene renderer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getTimeKeeper">getTimeKeeper()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-TimeKeeper.html"><abbr title="\LotGD\Core\TimeKeeper">TimeKeeper</abbr></a> </span>
</dt>
<dd>Returns the time keeper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getVersion">getVersion()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Return the current version of the core, conforming to Semantic Versioning.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_getViewpoint">getViewpoint()</a>
<span>
&nbsp;: <a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a> </span>
</dt>
<dd>Return the viewpoint for the current user.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_setCharacter">setCharacter()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets the currently configured user character.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_setComposerManager">setComposerManager()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Sets the game&#039;s composer manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_setDiceBag">setDiceBag()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Sets the game&#039;s dice bag.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_setEventManager">setEventManager()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Sets the game&#039;s event manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_setMessageManager">setMessageManager()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Sets the Message Manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_setModuleManager">setModuleManager()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Sets the game&#039;s module manager.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_setSceneRenderer">setSceneRenderer()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Sets a scene renderer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/LotGD-Core-Game.html#method_takeAction">takeAction()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Take the specified navigation action for the currently configured
user. This action must be present in the current user&#039;s viewpoint.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/LotGD-Core-Game.html#method_navigateToScene">navigateToScene()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Starting with the current viewpoint, navigate to the specified scene,
calling the hook `h/lotgd/core/navigate-to/[scene template]` to
set up the proper viewpoint values, and following any redirects specified
by the hook.</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/LotGD-Core-Game.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_character">
$character
<a href="classes/LotGD-Core-Game.html#property_character" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a>|null</span>
<span class="phpdocumentor-signature__name">$character</span>
= <span class="phpdocumentor-signature__default-value">null</span></code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_composerManager">
$composerManager
<a href="classes/LotGD-Core-Game.html#property_composerManager" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a></span>
<span class="phpdocumentor-signature__name">$composerManager</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_configuration">
$configuration
<a href="classes/LotGD-Core-Game.html#property_configuration" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a></span>
<span class="phpdocumentor-signature__name">$configuration</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_cwd">
$cwd
<a href="classes/LotGD-Core-Game.html#property_cwd" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$cwd</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_diceBag">
$diceBag
<a href="classes/LotGD-Core-Game.html#property_diceBag" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a></span>
<span class="phpdocumentor-signature__name">$diceBag</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_entityManager">
$entityManager
<a href="classes/LotGD-Core-Game.html#property_entityManager" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></span>
<span class="phpdocumentor-signature__name">$entityManager</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_eventManager">
$eventManager
<a href="classes/LotGD-Core-Game.html#property_eventManager" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a></span>
<span class="phpdocumentor-signature__name">$eventManager</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_logger">
$logger
<a href="classes/LotGD-Core-Game.html#property_logger" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><abbr title="\Monolog\Logger">Logger</abbr></span>
<span class="phpdocumentor-signature__name">$logger</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_messageManager">
$messageManager
<a href="classes/LotGD-Core-Game.html#property_messageManager" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a></span>
<span class="phpdocumentor-signature__name">$messageManager</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_moduleManager">
$moduleManager
<a href="classes/LotGD-Core-Game.html#property_moduleManager" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a></span>
<span class="phpdocumentor-signature__name">$moduleManager</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_sceneRenderer">
$sceneRenderer
<a href="classes/LotGD-Core-Game.html#property_sceneRenderer" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-Services-TwigSceneRenderer.html"><abbr title="\LotGD\Core\Services\TwigSceneRenderer">TwigSceneRenderer</abbr></a></span>
<span class="phpdocumentor-signature__name">$sceneRenderer</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_timeKeeper">
$timeKeeper
<a href="classes/LotGD-Core-Game.html#property_timeKeeper" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/LotGD-Core-TimeKeeper.html"><abbr title="\LotGD\Core\TimeKeeper">TimeKeeper</abbr></a>|null</span>
<span class="phpdocumentor-signature__name">$timeKeeper</span>
= <span class="phpdocumentor-signature__default-value">null</span></code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"></section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/LotGD-Core-Game.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/LotGD-Core-Game.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Construct a game. You probably want to use Bootstrap to do this.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$configuration</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Monolog\Logger">Logger</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$logger</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$entityManager</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$cwd</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$configuration</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$logger</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Monolog\Logger">Logger</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityManager</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cwd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCharacter">
getCharacter()
<a href="classes/LotGD-Core-Game.html#method_getCharacter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">227</span>
</aside>
<p class="phpdocumentor-summary">Returns the currently configured user character.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCharacter</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a></span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/LotGD-Core-Exceptions-CharacterNotFoundException.html"><abbr title="\LotGD\Core\Exceptions\CharacterNotFoundException">CharacterNotFoundException</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getComposerManager">
getComposerManager()
<a href="classes/LotGD-Core-Game.html#method_getComposerManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">103</span>
</aside>
<p class="phpdocumentor-summary">Returns the game&#039;s composer manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getComposerManager</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>The game's composer manager.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getConfiguration">
getConfiguration()
<a href="classes/LotGD-Core-Game.html#method_getConfiguration" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Returns the game&#039;s configuration.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getConfiguration</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Configuration.html"><abbr title="\LotGD\Core\Configuration">Configuration</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>The game's configuration.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCWD">
getCWD()
<a href="classes/LotGD-Core-Game.html#method_getCWD" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Returns the current working directory, or root directory where the
Composer configuration is based.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCWD</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDiceBag">
getDiceBag()
<a href="classes/LotGD-Core-Game.html#method_getDiceBag" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">148</span>
</aside>
<p class="phpdocumentor-summary">Returns the game&#039;s dice bag.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDiceBag</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getEntityManager">
getEntityManager()
<a href="classes/LotGD-Core-Game.html#method_getEntityManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">121</span>
</aside>
<p class="phpdocumentor-summary">Returns the game&#039;s entity manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getEntityManager</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></span>
&mdash;
<section class="phpdocumentor-description"><p>The game's database entity manager.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getEventManager">
getEventManager()
<a href="classes/LotGD-Core-Game.html#method_getEventManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Returns the game&#039;s event manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getEventManager</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>The game's event manager.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getLogger">
getLogger()
<a href="classes/LotGD-Core-Game.html#method_getLogger" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
</aside>
<p class="phpdocumentor-summary">Returns the logger instance to write logs.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getLogger</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Monolog\Logger">Logger</abbr></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\Monolog\Logger">Logger</abbr></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getMessageManager">
getMessageManager()
<a href="classes/LotGD-Core-Game.html#method_getMessageManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">190</span>
</aside>
<p class="phpdocumentor-summary">Returns the Message manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getMessageManager</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getModuleManager">
getModuleManager()
<a href="classes/LotGD-Core-Game.html#method_getModuleManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
</aside>
<p class="phpdocumentor-summary">Returns the game&#039;s module manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getModuleManager</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>The game's module manager.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSceneRenderer">
getSceneRenderer()
<a href="classes/LotGD-Core-Game.html#method_getSceneRenderer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">208</span>
</aside>
<p class="phpdocumentor-summary">Returns the default scene renderer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSceneRenderer</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Services-TwigSceneRenderer.html"><abbr title="\LotGD\Core\Services\TwigSceneRenderer">TwigSceneRenderer</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Services-TwigSceneRenderer.html"><abbr title="\LotGD\Core\Services\TwigSceneRenderer">TwigSceneRenderer</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTimeKeeper">
getTimeKeeper()
<a href="classes/LotGD-Core-Game.html#method_getTimeKeeper" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">175</span>
</aside>
<p class="phpdocumentor-summary">Returns the time keeper.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTimeKeeper</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-TimeKeeper.html"><abbr title="\LotGD\Core\TimeKeeper">TimeKeeper</abbr></a></span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-TimeKeeper.html"><abbr title="\LotGD\Core\TimeKeeper">TimeKeeper</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getVersion">
getVersion()
<a href="classes/LotGD-Core-Game.html#method_getVersion" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Return the current version of the core, conforming to Semantic Versioning.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getVersion</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>The current version, in x.y.z format.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getViewpoint">
getViewpoint()
<a href="classes/LotGD-Core-Game.html#method_getViewpoint" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">249</span>
</aside>
<p class="phpdocumentor-summary">Return the viewpoint for the current user.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getViewpoint</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a></span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/LotGD-Core-Exceptions-InvalidConfigurationException.html"><abbr title="\LotGD\Core\Exceptions\InvalidConfigurationException">InvalidConfigurationException</abbr></a>|<a href="classes/LotGD-Core-Exceptions-CharacterNotFoundException.html"><abbr title="\LotGD\Core\Exceptions\CharacterNotFoundException">CharacterNotFoundException</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a></span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setCharacter">
setCharacter()
<a href="classes/LotGD-Core-Game.html#method_setCharacter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">239</span>
</aside>
<p class="phpdocumentor-summary">Sets the currently configured user character.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setCharacter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$c</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$c</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Models-Character.html"><abbr title="\LotGD\Core\Models\Character">Character</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setComposerManager">
setComposerManager()
<a href="classes/LotGD-Core-Game.html#method_setComposerManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
</aside>
<p class="phpdocumentor-summary">Sets the game&#039;s composer manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setComposerManager</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$composerManager</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$composerManager</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-ComposerManager.html"><abbr title="\LotGD\Core\ComposerManager">ComposerManager</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDiceBag">
setDiceBag()
<a href="classes/LotGD-Core-Game.html#method_setDiceBag" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">157</span>
</aside>
<p class="phpdocumentor-summary">Sets the game&#039;s dice bag.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDiceBag</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$diceBag</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$diceBag</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-DiceBag.html"><abbr title="\LotGD\Core\DiceBag">DiceBag</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setEventManager">
setEventManager()
<a href="classes/LotGD-Core-Game.html#method_setEventManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">139</span>
</aside>
<p class="phpdocumentor-summary">Sets the game&#039;s event manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setEventManager</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$eventManager</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$eventManager</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-EventManager.html"><abbr title="\LotGD\Core\EventManager">EventManager</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setMessageManager">
setMessageManager()
<a href="classes/LotGD-Core-Game.html#method_setMessageManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">199</span>
</aside>
<p class="phpdocumentor-summary">Sets the Message Manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setMessageManager</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$messageManager</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$messageManager</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-MessageManager.html"><abbr title="\LotGD\Core\MessageManager">MessageManager</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setModuleManager">
setModuleManager()
<a href="classes/LotGD-Core-Game.html#method_setModuleManager" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Sets the game&#039;s module manager.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setModuleManager</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$moduleManager</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$moduleManager</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-ModuleManager.html"><abbr title="\LotGD\Core\ModuleManager">ModuleManager</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setSceneRenderer">
setSceneRenderer()
<a href="classes/LotGD-Core-Game.html#method_setSceneRenderer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<p class="phpdocumentor-summary">Sets a scene renderer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setSceneRenderer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Services-TwigSceneRenderer.html"><abbr title="\LotGD\Core\Services\TwigSceneRenderer">TwigSceneRenderer</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$sceneRenderer</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sceneRenderer</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Services-TwigSceneRenderer.html"><abbr title="\LotGD\Core\Services\TwigSceneRenderer">TwigSceneRenderer</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_takeAction">
takeAction()
<a href="classes/LotGD-Core-Game.html#method_takeAction" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">408</span>
</aside>
<p class="phpdocumentor-summary">Take the specified navigation action for the currently configured
user. This action must be present in the current user&#039;s viewpoint.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">takeAction</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$actionId</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$parameters</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$actionId</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The identifier of the action to take.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parameters</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/LotGD-Core-Exceptions-ActionNotFoundException.html"><abbr title="\LotGD\Core\Exceptions\ActionNotFoundException">ActionNotFoundException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/LotGD-Core-Exceptions-SceneNotFoundException.html"><abbr title="\LotGD\Core\Exceptions\SceneNotFoundException">SceneNotFoundException</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_navigateToScene">
navigateToScene()
<a href="classes/LotGD-Core-Game.html#method_navigateToScene" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Game.php"><a href="files/src-game.html"><abbr title="src/Game.php">Game.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">290</span>
</aside>
<p class="phpdocumentor-summary">Starting with the current viewpoint, navigate to the specified scene,
calling the hook `h/lotgd/core/navigate-to/[scene template]` to
set up the proper viewpoint values, and following any redirects specified
by the hook.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">navigateToScene</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\LotGD\Core\Models\Scene">Scene</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$scene</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$parameters</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$scene</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\LotGD\Core\Models\Scene">Scene</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parameters</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/LotGD-Core-Exceptions-CharacterNotFoundException.html"><abbr title="\LotGD\Core\Exceptions\CharacterNotFoundException">CharacterNotFoundException</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
</section>
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
</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="classes/LotGD-Core-Game.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