PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs Class Reference

This is the base prefs (converter window settings) class. More...

Public Member Functions

 Prefs ()
 

Static Public Member Functions

static Prefs Load (string key)
 This method reads prefs from EditorPrefs or creates it if it doesn't exist. More...
 
static void Save (string key, Prefs prefs)
 This method saves prefs to EditorPrefs. More...
 

Public Attributes

string sourceFilename = string.Empty
 The source filename. More...
 
string outputFolder = "Assets"
 The output folder in which to create the dialogue database. More...
 
string databaseFilename = "Dialogue Database"
 The name of the dialogue database. More...
 
bool overwrite = false
 If true, the converter may overwrite the dialogue database if it already exists. More...
 
bool merge = false
 If true and overwriting, merge assets into the existing database instead of replacing it. More...
 
EncodingType encodingType = EncodingType.Default
 The encoding type to use when reading the source file. More...
 

Static Protected Member Functions

static void WarnIfKeyUndefined (string key)
 

Detailed Description

This is the base prefs (converter window settings) class.

The converter window uses an instance of this class, or a subclass if you need additional info, to store the user's current settings.

Constructor & Destructor Documentation

◆ Prefs()

PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.Prefs ( )

Member Function Documentation

◆ Load()

static Prefs PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.Load ( string  key)
static

This method reads prefs from EditorPrefs or creates it if it doesn't exist.

Parameters
keyEditorPrefs key.

◆ Save()

static void PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.Save ( string  key,
Prefs  prefs 
)
static

This method saves prefs to EditorPrefs.

Parameters
keyKey.
prefsEditorPrefs key.

◆ WarnIfKeyUndefined()

static void PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.WarnIfKeyUndefined ( string  key)
staticprotected

Member Data Documentation

◆ databaseFilename

string PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.databaseFilename = "Dialogue Database"

The name of the dialogue database.

◆ encodingType

EncodingType PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.encodingType = EncodingType.Default

The encoding type to use when reading the source file.

◆ merge

bool PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.merge = false

If true and overwriting, merge assets into the existing database instead of replacing it.

◆ outputFolder

string PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.outputFolder = "Assets"

The output folder in which to create the dialogue database.

◆ overwrite

bool PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.overwrite = false

If true, the converter may overwrite the dialogue database if it already exists.

◆ sourceFilename

string PixelCrushers.DialogueSystem.AbstractConverterWindow.Prefs.sourceFilename = string.Empty

The source filename.

This file gets converted into a dialogue database.


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