Documentation

Application

Interfaces, Classes and Traits

AttachmentInterface
EventHandler
GameAwareInterface
Interface for classes that are aware of the game.
CharacterInterface
Interface for the character model and all objects that mimick such a model.
CharacterStatInterface
CreateableInterface
Interface for createable models.
ExtendableModelInterface
FighterInterface
Interface for models that should be able to participate in fights.
PermissionAssociationInterface
Extend this class to provide an association between an entity and a permission.
SaveableInterface
Interface for createable models.
SceneConnectable
Module
Classes which provide module functionality should implement this interface.
SceneTemplateInterface
Action
A representation of an action the user can take to affect the game state. An encapsulation of a navigation menu option.
ActionGroup
A grouping of navigation actions, like a submenu.
Attachment
An attachment to a scene. This is desigend to be subclasses by modules to provide functinoality like forms or maybe image attachments to go along with a scene.
Battle
Class for managing and running battles between 2 participants.
Bootstrap
The entry point for constructing a properly configured LotGD Game object.
BuffList
Description of BuffList.
ComposerManager
Helps perform tasks with the composer configuration.
Configuration
The configuration information for a LotGD game. Configuration is read from a YAML file, who's path is specified when you construct the object.
BaseCommand
Parent class for daenerys tool commands.
CharacterAddCommand
Resets the viewpoint of a given character.
CharacterBaseCommand
Parent class for daenerys tool commands.
CharacterConfigListCommand
Parent class for daenerys tool commands.
CharacterConfigResetCommand
Parent class for daenerys tool commands.
CharacterConfigSetCommand
Parent class for daenerys tool commands.
CharacterEditCommand
Resets the viewpoint of a given character.
CharacterListCommand
Command to list all characters.
CharacterRemoveCommand
Resets the viewpoint of a given character.
CharacterResetViewpointCommand
Resets the viewpoint of a given character.
CharacterShowCommand
Resets the viewpoint of a given character.
ConsoleCommand
Daenerys command to start a PHP REPL with a basic game set up.
DatabaseInitCommand
Danerys command to initiate the database with default values.
DatabaseSchemaUpdateCommand
Danerys command to initiate the database with default values.
ModuleBaseCommand
Parent class for daenerys tool commands.
ModuleConfigListCommand
Parent class for daenerys tool commands.
ModuleConfigResetCommand
Parent class for daenerys tool commands.
ModuleConfigSetCommand
Parent class for daenerys tool commands.
ModuleListCommand
Parent class for daenerys tool commands.
ModuleRegisterCommand
Danerys command to register and initiate any newly installed modules.
ModuleValidateCommand
Danerys command to validate installed modules.
SceneAddCommand
Resets the viewpoint of a given character.
SceneAddConnectionGroupCommand
Resets the viewpoint of a given character.
SceneBaseCommand
Parent class for daenerys tool commands.
SceneConfigListCommand
Parent class for daenerys tool commands.
SceneConfigResetCommand
Parent class for daenerys tool commands.
SceneConfigSetCommand
Parent class for daenerys tool commands.
SceneConnectCommand
Resets the viewpoint of a given character.
SceneDisconnectCommand
Resets the viewpoint of a given character.
SceneListCommand
Parent class for daenerys tool commands.
SceneRemoveCommand
Resets the viewpoint of a given character.
SceneRemoveConnectionGroupCommand
Resets the viewpoint of a given character.
SceneShowCommand
Resets the viewpoint of a given character.
SceneTemplateListCommand
Parent class for daenerys tool commands.
Main
Main execution class for the daenerys tool.
DiceBag
A collection of random number generators, with various distributions.
Extension
Annotation that is used to flag which entity a class extends.
ExtensionMethod
Annotation that is used to link a static method to a model entity.
EntityPostLoadEventListener
Class EntityPostLoadEventListener.
EventManager
Manages a simple publish/subscribe system based on regular expressions matching event names and running a fixed.
CharacterEventData
Class CharacterEventData.
EventContext
Class EventContext.
EventContextData
EventContextData to provide a basic structure for managing contextual data of an event.
NavigateToSceneData
NavigateToScene data container which can be used for navigational events.
NewViewpointData
NewViewpoint data container which is used if no scene has ever been visited.
ViewpointDecorationEventData
Class ViewpointDecorationEventData.
ActionNotFoundException
Exception if a scene action is not found.
ArgumentEmptyException
Exception if a specific, required argument is missing.
ArgumentException
Exception if a specific, required argument is missing.
AttributeMissingException
Exception if a specific, required argument is missing.
BattleEventException
Exception if a specific, required argument is missing.
BattleException
Exception if a specific, required argument is missing.
BattleIsOverException
Exception if a specific, required argument is missing.
BattleNotOverException
Exception if a specific, required argument is missing.
BuffListAlreadyActivatedException
Exception if a specific, required argument is missing.
BuffSlotOccupiedException
Exception if a specific, required argument is missing.
BuilderException
Exception if a builder is missing an argument.
CharacterNotFoundException
Exception if a character is not found.
CharacterStatException
Class CharacterStatException.
CharacterStatExistsException
Class CharacterStatExistsException.
CharacterStatGroupExistsException
Class CharacterStatGroupExistsException.
CharacterStatGroupNotFoundException
Class CharacterStatGroupNotFoundException.
CharacterStatNotFoundException
Class CharacterStatNotFoundException.
ClassNotFoundException
Exception if a specific, required argument is missing.
CoreException
Base exceptions for all core errors.
EntityAlreadyExistsException
Exception if an existing entity is tried to create again.
EntityDoesNotExistException
Exception if a non-existing entity is requested.
EntityException
A basic entity exception.
InsecureTwigTemplateError
Base exceptions for all core errors.
InvalidConfigurationException
Exception if a configuration value is missing or invalid.
InvalidModelException
Exception if a specific combination of model values is invalid.
IsNullException
Exception if a specific, required argument is missing.
KeyNotFoundException
Exception if a specific, required argument is missing.
LibraryDoesNotExistException
Exception if a Composer library does not exists.
ModuleAlreadyExistsException
Exception if a module already exists.
ModuleDoesNotExistException
Exception if a module does not exists.
NotImplementedException
Exception if a specific, required argument is missing.
ParentAlreadySetException
Exception if a specific, required argument is missing.
PermissionAlreadyExistsException
Exception if an existing entity is tried to create again.
PermissionDoesNotExistException
Exception if an existing entity is tried to create again.
PermissionIdNotFoundException
Exception if a requested permission id has not been found.
SceneNotFoundException
Exception if a scene is not found.
SubscriptionNotFoundException
Exception if an event subscription does not exist.
UnexpectedArrayKeyException
Gets thrown if a array containts an unexpected array key.
WrongTypeException
Exception if a variable has the wrong type.
Game
The main game class.
GameBuilder
The GameBuilder class is used to build a Game object with all dependencies that are needed.
LibraryConfiguration
Represents the configuration of a LotGD library (like the core, crate or module), with its configuration parameters.
LibraryConfigurationManager
Handle the library configurations for the installed core, crate and modules.
MessageManager
Manages the message system overall Class MessageManager.
ModelExtender
Contains method to help the extension of a model.
Actor
This abtract class provides functionality for user entities that crates might want to implement, such as permissions.
BasicEnemy
BattleEvent
A representation of something that happened in battle.
BuffMessageEvent
A battle event representing a message generated by a buff.
CriticalHitEvent
Battle event representing a stronger than average attack.
DamageEvent
BattleEvent.
DamageLifetapEvent
Damage event where damage is the result of a life tap.
DamageReflectionEvent
A battle event representing damage being reflected back on the attacker.
DeathEvent
BattleEvent representing a fighter's death.
MinionDamageEvent
Battle event that represents damage to a minion.
RegenerationBuffEvent
Battle event that represents regenerating health.
Buff
A model representing a buff used to modify the flow of the battle.
Character
Model for a character.
CharacterProperty
Properties for Characters.
CharacterStatGroup
Class CharacterStatGroup.
BaseCharacterStat
Class BaseCharacterStat.
CharacterStats
Class CharacterStats.
EventSubscription
An event name to class binding that represents that class listening for that event.
GameConfiguration
Provides an interface to access properties.
GameConfigurationElement
Properties for Characters.
Message
Model for messages.
MessageThread
A Thread of messages.
MissingCharacter
Provides a basic implementation of CharacterInterface to return the most important data a missing character might still need.
Module
An installed module in the system. Note that module metadata is stored in the composer.json for each module.
ModuleProperty
A place for modules to store per-module private data.
Monster
The Monster entity.
MotD
Model for the message of the day.
Permission
Represents a permission.
CharacterRepository
Convenience methods to query for characters.
MessageThreadRepository
Repository for MessageThreads.
SceneAttachment
A SceneAttachment is a registered Attachment class to keep track of (a) generally all available attachments, and (b) which scene contains which attachment.
SceneConnection
SceneConnectionGroup
SceneProperty
A place for modules to store per-module private data.
SceneTemplate
Class SceneTemplates.
SystemCharacter
Provides a basic system character to serve as an anonymous user.
Viewpoint
A Viewpoint is the current Scene a character is experiencing with all changes from modules included.
ViewpointSnapshot
Represents a complete set of viewpoint data used to restore a saved viewpoint.
ModuleManager
Handles the adding and removing of modules to the game.
PermissionManager
The PermissionManager manages (checks and manipulates) permissions of actors.
HasAction
LotGDTestCase
BasicSceneTemplate
Class BasicSceneTemplate.
TwigNullLoader
TwigSceneRenderer
TimeKeeper
Configurable way to convert back and forth between real time and game time.
OneToManyCollection
A one-to-many relation between two entities.
SceneDescription
Abstracts a scene description and provides tools to modify the text more easily.
AutoScaleFighter
Automatically calculated values based on the fighter's level.
Creator
Provides methods for creating new entities.
Deletor
Provides methods for deleting entities.
ExtendableModel
Trait to add the __call class required for extendable models.
GameAware
Helper trait to implement public setGame from GameAwareInterface and private getGame for internal use.
MockCharacter
Provides basic implementation to mock CharacterInterface.
PermissionAssociationable
Tools to work with a permission type field.
Properties
Provides method and doctrine annotation for a property submodel.
PropertyManager
Provides method and doctrine annotation for a property submodel.
Saveable
Provides methods for persisting Saveable entities.
SceneBasics
Provides scene basics.
SoftDeletable
Provides methods for deleting entities.
UserAssignable

Search results