Skip to content

How It Works

CG-Tespy edited this page Jul 27, 2019 · 1 revision

Table of Contents

How does it keep track of the narrative?

Every time a Say command finishes executing, the Narrative Log registers an entry containing the text of said command. Then, the UI responds by creating a slot to hold the entry's text, based on the prefab that the NarrativeLogUI component was given.


How do I look through its contents?

By default, you can scroll through the log's UI by holding left-click on it and moving the mouse vertically.


I don't like the default look.

You can improve it in any way you like! Just make sure that the core components of your NarrativeLog UI are set up properly. Like so:

  • NarrativeLogEntryDisplay: Make sure it has references to the displays within it that it may need to update.
  • NarrativeLog: Attached to a game object (preferably the root) in your prefab.
  • NarrativeLogUI: Also preferably attached to the prefab's root game object. Needs references to the NarrativeLog, the prefab for the entry display, and the object meant to hold the entry displays.
It'll probably be easiest if you use the built-in Narrative Log prefab as a base.

I want to code in some new features.

The API documentation and the source code can help you with that :) Also feel free to ask questions by raising an issue on the repo.

Clone this wiki locally