2864 lines
131 KiB
HTML
2864 lines
131 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>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/lotgd-core.html">Core</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/lotgd-core-models.html">Models</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
Character
|
|
|
|
|
|
<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>
|
|
|
|
<span class="phpdocumentor-element__implements">
|
|
implements
|
|
<a href="classes/LotGD-Core-Models-CharacterInterface.html"><abbr title="\LotGD\Core\Models\CharacterInterface">CharacterInterface</abbr></a>, <a href="classes/LotGD-Core-Models-CreateableInterface.html"><abbr title="\LotGD\Core\Models\CreateableInterface">CreateableInterface</abbr></a>, <a href="classes/LotGD-Core-GameAwareInterface.html"><abbr title="\LotGD\Core\GameAwareInterface">GameAwareInterface</abbr></a>, <a href="classes/LotGD-Core-Models-ExtendableModelInterface.html"><abbr title="\LotGD\Core\Models\ExtendableModelInterface">ExtendableModelInterface</abbr></a> </span>
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
Uses
|
|
<a href="classes/LotGD-Core-Tools-Model-Creator.html"><abbr title="\LotGD\Core\Tools\Model\Creator">Creator</abbr></a>, <a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html"><abbr title="\LotGD\Core\Tools\Model\SoftDeletable">SoftDeletable</abbr></a>, <a href="classes/LotGD-Core-Tools-Model-PropertyManager.html"><abbr title="\LotGD\Core\Tools\Model\PropertyManager">PropertyManager</abbr></a>, <a href="classes/LotGD-Core-Tools-Model-GameAware.html"><abbr title="\LotGD\Core\Tools\Model\GameAware">GameAware</abbr></a>, <a href="classes/LotGD-Core-Tools-Model-ExtendableModel.html"><abbr title="\LotGD\Core\Tools\Model\ExtendableModel">ExtendableModel</abbr></a> </span>
|
|
</h2>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">36</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Model for a character.</p>
|
|
|
|
|
|
|
|
<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">Entity</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(repositoryClass="LotGD\Core\Models\Repositories\CharacterRepository")</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">Table</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(name="characters")</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</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-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-Models-ExtendableModelInterface.html"><abbr title="\LotGD\Core\Models\ExtendableModelInterface">ExtendableModelInterface</abbr></a></dt>
|
|
<dd></dd>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<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-Models-Character.html#property_buffList">$buffList</a>
|
|
<span>
|
|
: <a href="classes/LotGD-Core-BuffList.html"><abbr title="\LotGD\Core\BuffList">BuffList</abbr></a>|null </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_buffs">$buffs</a>
|
|
<span>
|
|
: <abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr>|null </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#property_deletedAt">$deletedAt</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_displayName">$displayName</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_fillable">$fillable</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Tools-Model-GameAware.html#property_game">$game</a>
|
|
<span>
|
|
: <a href="classes/LotGD-Core-Game.html"><abbr title="\LotGD\Core\Game">Game</abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_health">$health</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_id">$id</a>
|
|
<span>
|
|
: <abbr title="\Ramsey\Uuid\UuidInterface">UuidInterface</abbr> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_level">$level</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_maxHealth">$maxHealth</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_messageThreads">$messageThreads</a>
|
|
<span>
|
|
: <abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr>|null </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_name">$name</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_properties">$properties</a>
|
|
<span>
|
|
: <abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr>|null </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_propertyClass">$propertyClass</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#property_propertyStorage">$propertyStorage</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_viewpoint">$viewpoint</a>
|
|
<span>
|
|
: <a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a>|null </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-ExtendableModel.html#method___call">__call()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Construct an empty character.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method___toString">__toString()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_addBuff">addBuff()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Adds a buff to the buffList.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-Creator.html#method_create">create()</a>
|
|
<span>
|
|
: <a href="classes/LotGD-Core-Models-CreateableInterface.html"><abbr title="\LotGD\Core\Models\CreateableInterface">CreateableInterface</abbr></a> </span>
|
|
</dt>
|
|
<dd>Creates and returns an entity instance and fills values.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_createAtFullHealth">createAtFullHealth()</a>
|
|
<span>
|
|
: self </span>
|
|
</dt>
|
|
<dd>Creates a character at full health.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_damage">damage()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Does damage to the entity.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_delete">delete()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Deletes the entity.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getAttack">getAttack()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Returns the character's virtual attribute "attack".</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getBuffs">getBuffs()</a>
|
|
<span>
|
|
: <a href="classes/LotGD-Core-BuffList.html"><abbr title="\LotGD\Core\BuffList">BuffList</abbr></a> </span>
|
|
</dt>
|
|
<dd>Returns a list of buffs.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getDefense">getDefense()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Returns the character's virtual attribute "defense".</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_getDeletedAt">getDeletedAt()</a>
|
|
<span>
|
|
: <abbr title="\DateTime">DateTime</abbr> </span>
|
|
</dt>
|
|
<dd>Returns when the entry got deleted.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getDisplayName">getDisplayName()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Returns displayName, a combination of title, name and suffix, mixed with colour codes.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-GameAware.html#method_getGame">getGame()</a>
|
|
<span>
|
|
: <a href="classes/LotGD-Core-Game.html"><abbr title="\LotGD\Core\Game">Game</abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getHealth">getHealth()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Returns current health.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getId">getId()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Returns the entity's id.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getLevel">getLevel()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Returns the character's level.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getMaxHealth">getMaxHealth()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Returns the maximum health.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getMessageThreads">getMessageThreads()</a>
|
|
<span>
|
|
: <abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr> </span>
|
|
</dt>
|
|
<dd>Returns a list of message threads this user has created.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getName">getName()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Returns the character's name.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_getProperty">getProperty()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Returns a property with its stored type.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getViewpoint">getViewpoint()</a>
|
|
<span>
|
|
: <a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a>|null </span>
|
|
</dt>
|
|
<dd>Returns the current character viewpoint or null if one is not set.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_heal">heal()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Heals the enemy.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_isAlive">isAlive()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Returns true if the character is alive.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_isDeleted">isDeleted()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Returns true if this entity is soft deleted.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_loadProperties">loadProperties()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Loads properties.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_restore">restore()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Restores an entity back.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_setDeletedAt">setDeletedAt()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets deletedAt to a specific date.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-GameAware.html#method_setGame">setGame()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setHealth">setHealth()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets current health.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setLevel">setLevel()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets the character's level.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setMaxHealth">setMaxHealth()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets the maximum health of a character to a given value. It also sets the
|
|
health if none has been set yet.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setName">setName()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets the character's name and generates the display name.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_setProperty">setProperty()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Sets a property to a given value.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setViewpoint">setViewpoint()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Sets the current character viewpoint.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_unsetProperty">unsetProperty()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Deletes a property.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_generateDisplayName">generateDisplayName()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Generates the display name which is a composition of title and name.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/LotGD-Core-Models-Character.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_buffList">
|
|
$buffList
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_buffList" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">85</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-BuffList.html"><abbr title="\LotGD\Core\BuffList">BuffList</abbr></a>|null</span>
|
|
<span class="phpdocumentor-signature__name">$buffList</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_buffs">
|
|
$buffs
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_buffs" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">83</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr>|null</span>
|
|
<span class="phpdocumentor-signature__name">$buffs</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">OneToMany</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(targetEntity="Buff", mappedBy="character", cascade={"persist"})</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_deletedAt">
|
|
$deletedAt
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#property_deletedAt" 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/Tools/Model/SoftDeletable.php"><a href="files/src-tools-model-softdeletable.html"><abbr title="src/Tools/Model/SoftDeletable.php">SoftDeletable.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">15</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">$deletedAt</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">Column</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(type="datetime", nullable=true)</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_displayName">
|
|
$displayName
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_displayName" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">51</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">$displayName</span>
|
|
= <span class="phpdocumentor-signature__default-value">""</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">Column</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(type="text");</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_fillable">
|
|
$fillable
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_fillable" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">87</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$fillable</span>
|
|
= <span class="phpdocumentor-signature__default-value">["name", "maxHealth", "level"]</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_game">
|
|
$game
|
|
<a href="classes/LotGD-Core-Tools-Model-GameAware.html#property_game" 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/Tools/Model/GameAware.php"><a href="files/src-tools-model-gameaware.html"><abbr title="src/Tools/Model/GameAware.php">GameAware.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">13</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-Game.html"><abbr title="\LotGD\Core\Game">Game</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$game</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_health">
|
|
$health
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_health" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">57</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$health</span>
|
|
= <span class="phpdocumentor-signature__default-value">10</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">Column</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(type="integer", options={"default"=10})</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_id">
|
|
$id
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_id" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">45</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\Ramsey\Uuid\UuidInterface">UuidInterface</abbr></span>
|
|
<span class="phpdocumentor-signature__name">$id</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">Id</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>@Column(type="uuid", unique=True)</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_level">
|
|
$level
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_level" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">60</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$level</span>
|
|
= <span class="phpdocumentor-signature__default-value">1</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">Column</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(type="integer", options={"default"=1})/</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_maxHealth">
|
|
$maxHealth
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_maxHealth" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">54</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$maxHealth</span>
|
|
= <span class="phpdocumentor-signature__default-value">10</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">Column</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(type="integer", options={"default"=10})</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_messageThreads">
|
|
$messageThreads
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_messageThreads" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">80</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr>|null</span>
|
|
<span class="phpdocumentor-signature__name">$messageThreads</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">ManyToMany</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(targetEntity="MessageThread", inversedBy="participants", cascade={"persist"})</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">JoinTable</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(
|
|
name="message_threads_x_characters",
|
|
joinColumns={
|
|
@JoinColumn(name="character_id", referencedColumnName="id")
|
|
},
|
|
inverseJoinColumns={
|
|
@JoinColumn(name="messagethread_id", referencedColumnName="id")
|
|
}
|
|
)</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_name">
|
|
$name
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_name" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.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">string</span>
|
|
<span class="phpdocumentor-signature__name">$name</span>
|
|
= <span class="phpdocumentor-signature__default-value">""</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">Column</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(type="string", length=50);</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_properties">
|
|
$properties
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_properties" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">63</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr>|null</span>
|
|
<span class="phpdocumentor-signature__name">$properties</span>
|
|
</code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">OneToMany</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(targetEntity="CharacterProperty", mappedBy="owner", cascade={"persist", "remove"})</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_propertyClass">
|
|
$propertyClass
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_propertyClass" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">93</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">$propertyClass</span>
|
|
= <span class="phpdocumentor-signature__default-value">LotGDCoreModelsCharacterProperty::class</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_propertyStorage">
|
|
$propertyStorage
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#property_propertyStorage" 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/Tools/Model/PropertyManager.php"><a href="files/src-tools-model-propertymanager.html"><abbr title="src/Tools/Model/PropertyManager.php">PropertyManager.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">11</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">$propertyStorage</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_viewpoint">
|
|
$viewpoint
|
|
<a href="classes/LotGD-Core-Models-Character.html#property_viewpoint" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">66</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-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a>|null</span>
|
|
<span class="phpdocumentor-signature__name">$viewpoint</span>
|
|
= <span class="phpdocumentor-signature__default-value">null</span></code>
|
|
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
<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">OneToOne</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>(targetEntity="Viewpoint", mappedBy="owner", cascade={"persist", "remove"})</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/LotGD-Core-Models-Character.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___call">
|
|
__call()
|
|
<a href="classes/LotGD-Core-Tools-Model-ExtendableModel.html#method___call" 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/Tools/Model/ExtendableModel.php"><a href="files/src-tools-model-extendablemodel.html"><abbr title="src/Tools/Model/ExtendableModel.php">ExtendableModel.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">18</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$method</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$arguments</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">$method</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$arguments</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
__construct()
|
|
<a href="classes/LotGD-Core-Models-Character.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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">109</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Construct an empty character.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___toString">
|
|
__toString()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method___toString" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">121</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__toString</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addBuff">
|
|
addBuff()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_addBuff" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">338</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Adds a buff to the buffList.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addBuff</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Models-Buff.html"><abbr title="\LotGD\Core\Models\Buff">Buff</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$buff</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$override</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</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">$buff</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Models-Buff.html"><abbr title="\LotGD\Core\Models\Buff">Buff</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$override</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_create">
|
|
create()
|
|
<a href="classes/LotGD-Core-Tools-Model-Creator.html#method_create" 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/Tools/Model/Creator.php"><a href="files/src-tools-model-creator.html"><abbr title="src/Tools/Model/Creator.php">Creator.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">25</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Creates and returns an entity instance and fills values.</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">create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$arguments</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Models-CreateableInterface.html"><abbr title="\LotGD\Core\Models\CreateableInterface">CreateableInterface</abbr></a></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">$arguments</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The values the instance should get</p>
|
|
</section>
|
|
|
|
</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-WrongTypeException.html"><abbr title="\LotGD\Core\Exceptions\WrongTypeException">WrongTypeException</abbr></a>|<a href="classes/LotGD-Core-Exceptions-UnexpectedArrayKeyException.html"><abbr title="\LotGD\Core\Exceptions\UnexpectedArrayKeyException">UnexpectedArrayKeyException</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-AttributeMissingException.html"><abbr title="\LotGD\Core\Exceptions\AttributeMissingException">AttributeMissingException</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-CreateableInterface.html"><abbr title="\LotGD\Core\Models\CreateableInterface">CreateableInterface</abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The created Entity</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_createAtFullHealth">
|
|
createAtFullHealth()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_createAtFullHealth" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">98</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Creates a character at full health.</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">createAtFullHealth</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$arguments</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</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">$arguments</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">self</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_damage">
|
|
damage()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_damage" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">212</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Does damage to the entity.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">damage</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$damage</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">$damage</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_delete">
|
|
delete()
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_delete" 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/Tools/Model/SoftDeletable.php"><a href="files/src-tools-model-softdeletable.html"><abbr title="src/Tools/Model/SoftDeletable.php">SoftDeletable.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">21</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Deletes the entity.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$em</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">$em</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getAttack">
|
|
getAttack()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getAttack" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">258</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the character's virtual attribute "attack".</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getAttack</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$ignoreBuffs</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">$ignoreBuffs</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</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">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getBuffs">
|
|
getBuffs()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getBuffs" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">327</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns a list of buffs.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getBuffs</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-BuffList.html"><abbr title="\LotGD\Core\BuffList">BuffList</abbr></a></span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-BuffList.html"><abbr title="\LotGD\Core\BuffList">BuffList</abbr></a></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDefense">
|
|
getDefense()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getDefense" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">280</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the character's virtual attribute "defense".</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getDefense</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$ignoreBuffs</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">$ignoreBuffs</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</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">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDeletedAt">
|
|
getDeletedAt()
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_getDeletedAt" 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/Tools/Model/SoftDeletable.php"><a href="files/src-tools-model-softdeletable.html"><abbr title="src/Tools/Model/SoftDeletable.php">SoftDeletable.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">50</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns when the entry got deleted.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getDeletedAt</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\DateTime">DateTime</abbr></span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\DateTime">DateTime</abbr></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDisplayName">
|
|
getDisplayName()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getDisplayName" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">166</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns displayName, a combination of title, name and suffix, mixed with colour codes.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getDisplayName</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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The displayName</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getGame">
|
|
getGame()
|
|
<a href="classes/LotGD-Core-Tools-Model-GameAware.html#method_getGame" 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/Tools/Model/GameAware.php"><a href="files/src-tools-model-gameaware.html"><abbr title="src/Tools/Model/GameAware.php">GameAware.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">26</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getGame</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Game.html"><abbr title="\LotGD\Core\Game">Game</abbr></a></span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/LotGD-Core-Game.html"><abbr title="\LotGD\Core\Game">Game</abbr></a></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getHealth">
|
|
getHealth()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getHealth" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">203</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns current health.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getHealth</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getId">
|
|
getId()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getId" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">130</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the entity's id.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getId</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The id</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getLevel">
|
|
getLevel()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getLevel" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">248</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the character's level.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getMaxHealth">
|
|
getMaxHealth()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getMaxHealth" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">185</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the maximum health.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getMaxHealth</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getMessageThreads">
|
|
getMessageThreads()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getMessageThreads" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">351</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns a list of message threads this user has created.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getMessageThreads</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr></span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\Doctrine\Common\Collections\Collection">Collection</abbr></span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getName">
|
|
getName()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_getName" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">149</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the character's name.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getName</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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The name</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getProperty">
|
|
getProperty()
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_getProperty" 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/Tools/Model/PropertyManager.php"><a href="files/src-tools-model-propertymanager.html"><abbr title="src/Tools/Model/PropertyManager.php">PropertyManager.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">33</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns a property with its stored type.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getProperty</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$default</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</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">$name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$default</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">null</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getViewpoint">
|
|
getViewpoint()
|
|
<a href="classes/LotGD-Core-Models-Character.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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">310</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the current character viewpoint or null if one is not set.</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>|null</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<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>|null</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_heal">
|
|
heal()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_heal" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">226</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Heals the enemy.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">heal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$heal</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$overheal</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</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">$heal</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$overheal</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>True if healing bigger than maxHealth is desired.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_isAlive">
|
|
isAlive()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_isAlive" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">239</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns true if the character is alive.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">isAlive</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_isDeleted">
|
|
isDeleted()
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_isDeleted" 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/Tools/Model/SoftDeletable.php"><a href="files/src-tools-model-softdeletable.html"><abbr title="src/Tools/Model/SoftDeletable.php">SoftDeletable.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">59</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns true if this entity is soft deleted.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">isDeleted</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_loadProperties">
|
|
loadProperties()
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_loadProperties" 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/Tools/Model/PropertyManager.php"><a href="files/src-tools-model-propertymanager.html"><abbr title="src/Tools/Model/PropertyManager.php">PropertyManager.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">16</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Loads properties.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">loadProperties</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_restore">
|
|
restore()
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_restore" 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/Tools/Model/SoftDeletable.php"><a href="files/src-tools-model-softdeletable.html"><abbr title="src/Tools/Model/SoftDeletable.php">SoftDeletable.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">31</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Restores an entity back.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">restore</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr> </span><span class="phpdocumentor-signature__argument__name">$em</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">$em</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Doctrine\ORM\EntityManagerInterface">EntityManagerInterface</abbr></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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setDeletedAt">
|
|
setDeletedAt()
|
|
<a href="classes/LotGD-Core-Tools-Model-SoftDeletable.html#method_setDeletedAt" 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/Tools/Model/SoftDeletable.php"><a href="files/src-tools-model-softdeletable.html"><abbr title="src/Tools/Model/SoftDeletable.php">SoftDeletable.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">41</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets deletedAt to a specific date.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setDeletedAt</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\DateTime">DateTime</abbr>|null </span><span class="phpdocumentor-signature__argument__name">$deletedAt</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</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">$deletedAt</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\DateTime">DateTime</abbr>|null</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">null</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setGame">
|
|
setGame()
|
|
<a href="classes/LotGD-Core-Tools-Model-GameAware.html#method_setGame" 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/Tools/Model/GameAware.php"><a href="files/src-tools-model-gameaware.html"><abbr title="src/Tools/Model/GameAware.php">GameAware.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">18</span>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setGame</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Game.html"><abbr title="\LotGD\Core\Game">Game</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$game</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">$game</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Game.html"><abbr title="\LotGD\Core\Game">Game</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setHealth">
|
|
setHealth()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setHealth" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">194</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets current health.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setHealth</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$health</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">$health</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setLevel">
|
|
setLevel()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setLevel" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">301</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the character's level.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setLevel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$level</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">$level</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setMaxHealth">
|
|
setMaxHealth()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setMaxHealth" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">176</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the maximum health of a character to a given value. It also sets the
|
|
health if none has been set yet.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setMaxHealth</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$maxHealth</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">$maxHealth</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setName">
|
|
setName()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setName" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">139</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the character's name and generates the display name.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</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">$name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The name to set</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setProperty">
|
|
setProperty()
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_setProperty" 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/Tools/Model/PropertyManager.php"><a href="files/src-tools-model-propertymanager.html"><abbr title="src/Tools/Model/PropertyManager.php">PropertyManager.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">63</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets a property to a given value.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setProperty</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</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">$name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setViewpoint">
|
|
setViewpoint()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_setViewpoint" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">319</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the current character viewpoint.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setViewpoint</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a>|null </span><span class="phpdocumentor-signature__argument__name">$v</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">$v</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/LotGD-Core-Models-Viewpoint.html"><abbr title="\LotGD\Core\Models\Viewpoint">Viewpoint</abbr></a>|null</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>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_unsetProperty">
|
|
unsetProperty()
|
|
<a href="classes/LotGD-Core-Tools-Model-PropertyManager.html#method_unsetProperty" 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/Tools/Model/PropertyManager.php"><a href="files/src-tools-model-propertymanager.html"><abbr title="src/Tools/Model/PropertyManager.php">PropertyManager.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">47</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Deletes a property.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">unsetProperty</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</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">$name</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">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_generateDisplayName">
|
|
generateDisplayName()
|
|
<a href="classes/LotGD-Core-Models-Character.html#method_generateDisplayName" 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/Models/Character.php"><a href="files/src-models-character.html"><abbr title="src/Models/Character.php">Character.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">157</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Generates the display name which is a composition of title and name.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">generateDisplayName</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</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-Models-Character.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>
|