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

Detailed Description

Allows to lock the storage from unauthorized access.

Inheritance diagram for Doloro.InvetorySystem.Features.StorageLock:
Collaboration diagram for Doloro.InvetorySystem.Features.StorageLock:

Public Member Functions

override bool OnTrasactionMask (TransactionService.TransactionOrder order)
 The handler that calling by the storage for each property to find out is the item could be placed in. More...
 
override void LoadSession (byte[] data)
 Loading session data in binary format to the instance. More...
 
override byte[] SaveSession ()
 Converting property session data to the binary formated. More...
 
override void SetDefault ()
 Sets default property values. More...
 
override void OnStorageRentOver ()
 Occurs when rented storage released from the rent. More...
 
virtual void OnStorageRented ()
 The storage entity was rented with a new source StoragesDatabase.StorageContainer. More...
 

Protected Member Functions

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

Properties

bool IsLocked [get, set]
 Defines is the storage locked.
 
string KeyID [get, set]
 Id or type of key to unlock.
 
bool AllowsLockedAdd [get, set]
 If true the content could be placed into the storage event in case if locked, but can't be extracted.
 
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()

override void Doloro.InvetorySystem.Features.StorageLock.LoadSession ( byte[]  data)
virtual

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 from Doloro.InvetorySystem.AEntityFeature.

◆ 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()

override void Doloro.InvetorySystem.Features.StorageLock.OnStorageRentOver ( )
virtual

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 from Doloro.InvetorySystem.AStorageFeature.

◆ OnTrasactionMask()

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

The handler that calling by the storage for each property to find out is the item could be placed in.

Parameters
orderTransaction order that contains meta description of sharing operation.
Returns
true in case if item passing the filter. false otherwise.

Implements Doloro.InvetorySystem.AMaskStorageFeature.

◆ SaveSession()

override byte[] Doloro.InvetorySystem.Features.StorageLock.SaveSession ( )
virtual

Converting property session data to the binary formated.

Returns
Binary-like data that must be accessible cross sessions.

Reimplemented from Doloro.InvetorySystem.AEntityFeature.

◆ SetDefault()

override void Doloro.InvetorySystem.Features.StorageLock.SetDefault ( )
virtual

Sets default property values.

Reimplemented from Doloro.InvetorySystem.AEntityFeature.


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