PixelCrushers.DialogueSystem.Location Class Reference

A location asset. More...

Inheritance diagram for PixelCrushers.DialogueSystem.Location:
Collaboration diagram for PixelCrushers.DialogueSystem.Location:

Public Member Functions

 Location ()
 Initializes a new Location.
 
 Location (Location sourceLocation)
 Copy constructor.
 
 Location (ChatMapper.Location chatMapperLocation)
 Initializes a new Location copied from a Chat Mapper location asset.
 
void Assign (ChatMapper.Location chatMapperLocation)
 Copies a Chat Mapper location asset.
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.Asset
 Asset ()
 Initializes a new DialogueAsset.
 
 Asset (Asset sourceAsset)
 Copy constructor.
 
 Asset (int chatMapperID, List< ChatMapper.Field > chatMapperFields)
 Initializes a new DialogueAsset copied from a Chat Mapper asset.
 
void Assign (int chatMapperID, List< ChatMapper.Field > chatMapperFields)
 Copies a Chat Mapper asset.
 
bool FieldExists (string title)
 Checks whether a field exists.
 
string LookupValue (string title)
 Looks up the value of a field.
 
string LookupLocalizedValue (string title)
 Looks up the localized value of a field for the current language.
 
int LookupInt (string title)
 Looks up the value of a field.
 
float LookupFloat (string title)
 Looks up the value of a field.
 
bool LookupBool (string title)
 Looks up the value of a field.
 
bool IsFieldAssigned (string title)
 Checks whether a field exists and has non-empty text.
 
Field AssignedField (string title)
 Returns a field if it exists and has non-empty text.
 

Additional Inherited Members

- Public Attributes inherited from PixelCrushers.DialogueSystem.Asset
int id = 0
 Every asset has an ID number.
 
List< Fieldfields = null
 The asset's fields.
 
- Properties inherited from PixelCrushers.DialogueSystem.Asset
string Name [get, set]
 Gets or sets the Name field.
 
string localizedName [get]
 Gets the localized Name field.
 
string Description [get, set]
 Gets or sets the Description field, which is optional and may not exist.
 

Detailed Description

A location asset.

In Chat Mapper, locations are usually used to track the information about locations within the simulation. The dialogue system doesn't do anything with locations, but you're free to use them in your Lua code.

Constructor & Destructor Documentation

◆ Location() [1/3]

PixelCrushers.DialogueSystem.Location.Location ( )
inline

Initializes a new Location.

◆ Location() [2/3]

PixelCrushers.DialogueSystem.Location.Location ( Location  sourceLocation)
inline

Copy constructor.

Parameters
sourceLocationSource location.

◆ Location() [3/3]

PixelCrushers.DialogueSystem.Location.Location ( ChatMapper::Location  chatMapperLocation)
inline

Initializes a new Location copied from a Chat Mapper location asset.

Parameters
chatMapperLocationThe Chat Mapper location.

Member Function Documentation

◆ Assign()

void PixelCrushers.DialogueSystem.Location.Assign ( ChatMapper::Location  chatMapperLocation)
inline

Copies a Chat Mapper location asset.

Parameters
chatMapperLocationThe Chat Mapper location.

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