PixelCrushers.DialogueSystem.Item Class Reference

An item asset. More...

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

Public Member Functions

 Item ()
 Initializes a new Item.
 
 Item (Item sourceItem)
 Copy constructor.
 
 Item (ChatMapper.Item chatMapperItem)
 Initializes a new Item copied from a Chat Mapper item.
 
void Assign (ChatMapper.Item chatMapperItem)
 Copies a Chat Mapper item.
 
- 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.
 

Properties

bool IsItem [get, set]
 Gets or sets the field 'Is Item' which indicates whether this asset is an item or a quest.
 
string Group [get, set]
 Gets or sets the field 'Group' which is an optional group for quest categorization.
 
- 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.
 

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.
 

Detailed Description

An item asset.

In Chat Mapper, items are usually used to track the status of items in the simulation. You can still do this in the Dialogue System; however the QuestLog class gives you the option of using the item table to track quest log information instead. (See questLogSystem)

Constructor & Destructor Documentation

◆ Item() [1/3]

PixelCrushers.DialogueSystem.Item.Item ( )
inline

Initializes a new Item.

◆ Item() [2/3]

PixelCrushers.DialogueSystem.Item.Item ( Item  sourceItem)
inline

Copy constructor.

Parameters
sourceItemSource item.

◆ Item() [3/3]

PixelCrushers.DialogueSystem.Item.Item ( ChatMapper::Item  chatMapperItem)
inline

Initializes a new Item copied from a Chat Mapper item.

Parameters
chatMapperItemThe Chat Mapper item.

Member Function Documentation

◆ Assign()

void PixelCrushers.DialogueSystem.Item.Assign ( ChatMapper::Item  chatMapperItem)
inline

Copies a Chat Mapper item.

Parameters
chatMapperItemThe Chat Mapper item.

Property Documentation

◆ Group

string PixelCrushers.DialogueSystem.Item.Group
getset

Gets or sets the field 'Group' which is an optional group for quest categorization.

The group, or empty string if none.

◆ IsItem

bool PixelCrushers.DialogueSystem.Item.IsItem
getset

Gets or sets the field 'Is Item' which indicates whether this asset is an item or a quest.

true if asset is actually an item; false if the asset is actually a quest.


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