Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.InvetorySystem.StoragesDatabase Class Reference

Detailed Description

Data base that holds data of entire storages created during game session.

Inheritance diagram for Doloro.InvetorySystem.StoragesDatabase:
Collaboration diagram for Doloro.InvetorySystem.StoragesDatabase:

Classes

class  ADataContainer
 Base data container class. More...
 
class  AFeaturesHolderContainer
 
class  FeatureContainer
 The container fro cross-session hold of the AStorageFeature data. More...
 
class  ItemContainer
 Implements conception of the storage entry. More...
 
class  StorageContainer
 Container that using as data entry for the StoragesDatabase. More...
 

Public Member Functions

delegate void StorageDelgate (StoragesDatabase database, StorageContainer storage)
 Delegate using for storage related events. More...
 
delegate void DatabaseDelgate (StoragesDatabase database)
 
 StoragesDatabase ()
 Empty constructor.
 
 StoragesDatabase (SerializationInfo info, StreamingContext context)
 Allows to binary serializer instantiate the object from binary. More...
 
virtual void GetObjectData (SerializationInfo info, StreamingContext context)
 Calling by binary serializer to get object's data. More...
 
bool TryCreateStorage (Guid forcedId, params ItemContainer[] items)
 Creates new storage entry in the database with predefined StorageContainer.id. More...
 
bool TryCreateStorage (Guid forcedId, ICollection< ItemContainer > items)
 Creates new storage entry in the database with predefined StorageContainer.id. More...
 
Guid CreateStorage (params ItemContainer[] items)
 Creates new storage entry in the database. More...
 
Guid CreateStorage (ICollection< ItemContainer > items)
 Creates new storage entry in the database. More...
 
void DestroyStorage (Guid id)
 Safely destroys entire instances related to the storage. More...
 
void Clear ()
 Releases entire entries from the database. More...
 
bool ContainsStorage (Guid id)
 Checks is the storage registered at the database. More...
 
object Clone ()
 Clones database. More...
 

Properties

static StoragesDatabase Active [get, set]
 Single tone instance of the Storage related database.
 
StorageContainer this[Guid id] [get]
 Returns the storage by id. More...
 

Events

static DatabaseDelgate NewActiveDatabase
 Occurs when a new database assigned as Active.
 
static StorageDelgate StorageCreated
 Occurs when a new storage has been created at the database.
 
static StorageDelgate StorageDeleted
 Occurs when a new storage has been deleted from the database.
 

Constructor & Destructor Documentation

◆ StoragesDatabase()

Doloro.InvetorySystem.StoragesDatabase.StoragesDatabase ( SerializationInfo  info,
StreamingContext  context 
)

Allows to binary serializer instantiate the object from binary.

Parameters
info
context

Member Function Documentation

◆ Clear()

void Doloro.InvetorySystem.StoragesDatabase.Clear ( )

Releases entire entries from the database.

Releases rented entities and cancels started transactions.

◆ Clone()

object Doloro.InvetorySystem.StoragesDatabase.Clone ( )

Clones database.

Returns
Cloned database instance.

◆ ContainsStorage()

bool Doloro.InvetorySystem.StoragesDatabase.ContainsStorage ( Guid  id)

Checks is the storage registered at the database.

Parameters
idStorageContainer.id to search.
Returns
true in case if found. False otherwise.

◆ CreateStorage() [1/2]

Guid Doloro.InvetorySystem.StoragesDatabase.CreateStorage ( ICollection< ItemContainer items)

Creates new storage entry in the database.

Parameters
itemsCollection of items to place inside the storage.
Returns
Id to access of generated storage.

◆ CreateStorage() [2/2]

Guid Doloro.InvetorySystem.StoragesDatabase.CreateStorage ( params ItemContainer[]  items)

Creates new storage entry in the database.

Parameters
itemsCollection of items to place inside the storage.
Returns
Id to access of generated storage.

◆ DestroyStorage()

void Doloro.InvetorySystem.StoragesDatabase.DestroyStorage ( Guid  id)

Safely destroys entire instances related to the storage.

Parameters
idId of the storage inside database.

◆ GetObjectData()

virtual void Doloro.InvetorySystem.StoragesDatabase.GetObjectData ( SerializationInfo  info,
StreamingContext  context 
)
virtual

Calling by binary serializer to get object's data.

Parameters
info
context

◆ StorageDelgate()

delegate void Doloro.InvetorySystem.StoragesDatabase.StorageDelgate ( StoragesDatabase  database,
StorageContainer  storage 
)

Delegate using for storage related events.

Parameters
databaseParent database instance.
storageTarget storage container.

◆ TryCreateStorage() [1/2]

bool Doloro.InvetorySystem.StoragesDatabase.TryCreateStorage ( Guid  forcedId,
ICollection< ItemContainer items 
)

Creates new storage entry in the database with predefined StorageContainer.id.

Parameters
forcedIdId of new storage.
itemsCollection of items to place inside the storage.
Returns
true in case if storage created. false in case if storage id already registered.

◆ TryCreateStorage() [2/2]

bool Doloro.InvetorySystem.StoragesDatabase.TryCreateStorage ( Guid  forcedId,
params ItemContainer[]  items 
)

Creates new storage entry in the database with predefined StorageContainer.id.

Parameters
forcedIdId of new storage.
itemsCollection of items to place inside the storage.
Returns
true in case if storage created. false in case if storage id already registered.

Property Documentation

◆ this[Guid id]

StorageContainer Doloro.InvetorySystem.StoragesDatabase.this[Guid id]
get

Returns the storage by id.

Parameters
idId of the storage generated when storage was created.
Returns
Data container.

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