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

Detailed Description

Todo:
Not implemented. Makes the storage to allow only certain items or groups of items to be placed in.
Inheritance diagram for Doloro.InvetorySystem.Features.StorageItemsTagsFilter:
Collaboration diagram for Doloro.InvetorySystem.Features.StorageItemsTagsFilter:

Public Member Functions

override bool OnTrasactionMask (TransactionService.TransactionOrder order)
 Checks is the item's tags contains demanded ones. More...
 
virtual void OnStorageRented ()
 The storage entity was rented with a new source StoragesDatabase.StorageContainer. More...
 
virtual void OnStorageRentOver ()
 Occurs when rented storage released from the rent. More...
 
virtual byte[] SaveSession ()
 Converting property session data to the binary formated. More...
 
virtual void SetDefault ()
 Sets default property values. More...
 
virtual void LoadSession (byte[] data)
 Loading session data in binary format to the instance. More...
 

Static Public Attributes

const char TAGS_SPLITTER = '+'
 Symbol using to split tags in filter query.
 

Protected Member Functions

virtual void OnModified ()
 Handler that should be called each time when property values have been modified. More...
 

Protected Attributes

string[] tagMask = new string[0]
 

Properties

string[] TagMask [get, set]
 Tags masks that passing through validator. More...
 
string[][] FormatedMask [get]
 Decoded mask parsed from origin query provided with the TagMask
 
string message [get, protected set]
 Message generated to the order during validation precess.
 
Storage storage [get]
 Binded storage source.
 

Events

Action< AEntityFeatureModified
 Occurs when internal systems calling the OnModified handler.
 

Member Function Documentation

◆ LoadSession()

virtual void Doloro.InvetorySystem.AEntityFeature.LoadSession ( byte[]  data)
virtualinherited

Loading session data in binary format to the instance.

Parameters
dataProperty related data received via the SaveSession handler.

data as null must be considered as a clear session.

Reimplemented in Doloro.InvetorySystem.Modules.Shops.ShopFeature, Doloro.InvetorySystem.Features.VolumetricSpace.StorageVolume, Doloro.InvetorySystem.Features.StorageContentSpawner, Doloro.InvetorySystem.Features.StorageInfo, and Doloro.InvetorySystem.Features.StorageLock.

◆ OnModified()

virtual void Doloro.InvetorySystem.AEntityFeature.OnModified ( )
protectedvirtualinherited

Handler that should be called each time when property values have been modified.

Reimplemented in Doloro.InvetorySystem.Features.VolumetricSpace.StorageVolume.

◆ OnStorageRented()

virtual void Doloro.InvetorySystem.AStorageFeature.OnStorageRented ( )
virtualinherited

◆ OnStorageRentOver()

virtual void Doloro.InvetorySystem.AStorageFeature.OnStorageRentOver ( )
virtualinherited

Occurs when rented storage released from the rent.

Use to clear entire members related to the certain source StoragesDatabase.StorageContainer binded to the storage.

Reimplemented in Doloro.InvetorySystem.Modules.Shops.ShopFeature, Doloro.InvetorySystem.Features.StorageInfo, and Doloro.InvetorySystem.Features.StorageLock.

◆ OnTrasactionMask()

override bool Doloro.InvetorySystem.Features.StorageItemsTagsFilter.OnTrasactionMask ( TransactionService.TransactionOrder  order)
virtual

Checks is the item's tags contains demanded ones.

Parameters
orderDescribing order instance.
Returns
Result of filtering.

Implements Doloro.InvetorySystem.AMaskStorageFeature.

◆ SaveSession()

virtual byte[] Doloro.InvetorySystem.AEntityFeature.SaveSession ( )
virtualinherited

◆ SetDefault()

virtual void Doloro.InvetorySystem.AEntityFeature.SetDefault ( )
virtualinherited

Property Documentation

◆ TagMask

string [] Doloro.InvetorySystem.Features.StorageItemsTagsFilter.TagMask
getset

Tags masks that passing through validator.

Format of mask string:

  • [0] tag1+tag2+tag3
  • [1] tag4+tag5

TAGS_SPLITTER symbol is separator that means AND world. Array cells considers OR for different pass rules.

Means that item could accept cold liquid items or bulk-like.


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