jenny library
Classes
- Character
-
A Character represents a person who is speaking a particular line in a
dialogue. This object is available as the
.characterproperty of a DialogueLine delivered to your DialogueView. - CharacterStorage
-
The CharacterStorage is a cache for all Characters defined in your
yarn scripts. This container is populated from the
<<character>>commands as the YarnProject parses the input scripts. - CommandStorage
- CommandStorage is the repository of user-defined commands known to the YarnProject.
- DialogueChoice
- DialogueLine
-
The DialogueLine class represents a single line of text within the
dialogue [
Line]. - DialogueOption
- DialogueRunner
- The DialogueRunner is the engine that executes Jenny's dialogue at runtime.
- DialogueView
-
The DialogueView class is the main mechanism for integrating Jenny with
a game engine. This class describes how {ref}
line <DialogueLine>s and {ref}option <DialogueOption>s are presented to the user. - FunctionStorage
- FunctionStorage is the container for all user-defined functions in a yarn project.
- Localization
- MarkupAttribute
- Node
- UserDefinedCommand
- VariableStorage
- YarnProject
- YarnProject is a central place where all dialogue-related information is held:
Properties
-
localizationInfo
→ Map<
String, Localization> -
final
Exceptions / Errors
- DialogueError
- NameError
- This error is emitted when accessing an unknown name, such as: undefined variable name, unknown node title, unrecognized function, unspecified command, etc.
- SyntaxError
- TypeError