PixelCrushers.DialogueSystem.Articy.ArticyConverter Class Reference

This class does the actual work of converting ArticyData (version-independent articy:draft data) into a dialogue database. More...

Public Member Functions

delegate void ProgressCallbackDelegate (string info, float progress)
 
void Convert (ArticyData articyData, ConverterPrefs prefs, Template template, DialogueDatabase database)
 Convert the ArticyData, using the preferences in Prefs, into a dialogue database. More...
 

Static Public Member Functions

static DialogueDatabase ConvertXmlDataToDatabase (string xmlData, ConverterPrefs prefs=null, Template template=null)
 Creates a new database from an articy:draft XML file. More...
 
static void ConvertArticyDataToDatabase (ArticyData articyData, ConverterPrefs prefs, Template template, DialogueDatabase database)
 This static utility method creates a converter and uses it run the conversion. More...
 
static bool HasField (ArticyData.Features features, string fieldName, bool mustBeTrue)
 
static string ConvertExpression (string expression)
 Converts an articy expresso expression into Lua. More...
 

Events

static ProgressCallbackDelegate onProgressCallback = delegate { }
 

Detailed Description

This class does the actual work of converting ArticyData (version-independent articy:draft data) into a dialogue database.

Member Function Documentation

◆ Convert()

void PixelCrushers.DialogueSystem.Articy.ArticyConverter.Convert ( ArticyData  articyData,
ConverterPrefs  prefs,
Template  template,
DialogueDatabase  database 
)

Convert the ArticyData, using the preferences in Prefs, into a dialogue database.

Parameters
articyDataArticy data.
prefsPrefs.
databaseDialogue database.

◆ ConvertArticyDataToDatabase()

static void PixelCrushers.DialogueSystem.Articy.ArticyConverter.ConvertArticyDataToDatabase ( ArticyData  articyData,
ConverterPrefs  prefs,
Template  template,
DialogueDatabase  database 
)
static

This static utility method creates a converter and uses it run the conversion.

Parameters
articyDataArticy data.
prefsPrefs.
databaseDialogue database.

◆ ConvertExpression()

static string PixelCrushers.DialogueSystem.Articy.ArticyConverter.ConvertExpression ( string  expression)
static

Converts an articy expresso expression into Lua.

Returns
A Lua version of the expression.
Parameters
expressionarticy expresso expression.

◆ ConvertXmlDataToDatabase()

static DialogueDatabase PixelCrushers.DialogueSystem.Articy.ArticyConverter.ConvertXmlDataToDatabase ( string  xmlData,
ConverterPrefs  prefs = null,
Template  template = null 
)
static

Creates a new database from an articy:draft XML file.

Parameters
xmlDataArticy XML data (i.e., the contents of an articy:draft XML export).
prefsOptional ConverterPrefs to use. Does not use prefs.ProjectFilename.
templateOptional template for dialogue database assets.
Returns

◆ HasField()

static bool PixelCrushers.DialogueSystem.Articy.ArticyConverter.HasField ( ArticyData.Features  features,
string  fieldName,
bool  mustBeTrue 
)
static

◆ ProgressCallbackDelegate()

delegate void PixelCrushers.DialogueSystem.Articy.ArticyConverter.ProgressCallbackDelegate ( string  info,
float  progress 
)

Event Documentation

◆ onProgressCallback

ProgressCallbackDelegate PixelCrushers.DialogueSystem.Articy.ArticyConverter.onProgressCallback = delegate { }
static

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