PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration Class Reference

Integrates Ink with the Dialogue System. More...

Inheritance diagram for PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration:
Collaboration diagram for PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration:

Public Member Functions

void AddStory (string storyTitle, string storyJSON)
 Adds a story at runtime. More...
 
void SetInkBool (string variableName, bool value)
 
void SetInkNumber (string variableName, double value)
 
void SetInkString (string variableName, string value)
 

Public Attributes

List< TextAsset > inkJSONAssets = new List<TextAsset>()
 
bool resetStateOnConversationStart = false
 
bool includeInSaveData = true
 

Properties

List< Story > stories [get, set]
 
Story activeStory [get]
 
bool showPCSubtitles [get, set]
 
DialogueDatabase database [get]
 

Detailed Description

Integrates Ink with the Dialogue System.

In this integration, Ink does the processing, and the Dialogue System does the UI and handles triggers. It also handles saving/loading and exposes functions to manage quests and show alerts.

Member Function Documentation

◆ AddStory()

void PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.AddStory ( string  storyTitle,
string  storyJSON 
)

Adds a story at runtime.

Parameters
storyTitleThe story's title.
storyTextThe story in JSON format.

◆ SetInkBool()

void PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.SetInkBool ( string  variableName,
bool  value 
)

◆ SetInkNumber()

void PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.SetInkNumber ( string  variableName,
double  value 
)

◆ SetInkString()

void PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.SetInkString ( string  variableName,
string  value 
)

Member Data Documentation

◆ includeInSaveData

bool PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.includeInSaveData = true

◆ inkJSONAssets

List<TextAsset> PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.inkJSONAssets = new List<TextAsset>()

◆ resetStateOnConversationStart

bool PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.resetStateOnConversationStart = false

Property Documentation

◆ activeStory

Story PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.activeStory
get

◆ database

DialogueDatabase PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.database
get

◆ showPCSubtitles

bool PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.showPCSubtitles
getset

◆ stories

List<Story> PixelCrushers.DialogueSystem.InkSupport.DialogueSystemInkIntegration.stories
getset

The documentation for this class was generated from the following file: