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

Detailed Description

Implements the slots limit to the storage.

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

Public Member Functions

override bool OnTrasactionMask (TransactionService.TransactionOrder order)
 Checks is the storage slots limiter allows to place entire objects along with them stack size. More...
 
void Reserve (TransactionService.TransactionOrder order)
 Reserves internal capacity for possible transaction. More...
 
void CancelReservation (TransactionService.TransactionOrder order)
 Releases reservation holdings. More...
 
void ConfirmReservation (TransactionService.TransactionOrder order)
 Changes reservation holdings state to permanent. More...
 
override void OnStorageRented ()
 Drops a data related to certain database instance. More...
 
void DropPrecomputedData ()
 Drops precomputed data.
 
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...
 

Protected Member Functions

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

Properties

float FilledSlots [get]
 Current filled slots for current content of the storage content. More...
 
float Limit [get, set]
 Slots allowed to be filled in the storage. More...
 
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

◆ CancelReservation()

void Doloro.InvetorySystem.Features.StorageSlotsLimiter.CancelReservation ( TransactionService.TransactionOrder  order)

Releases reservation holdings.

Parameters
orderOrder requested reservation previously.

Implements Doloro.InvetorySystem.IReservationAgent.

◆ ConfirmReservation()

void Doloro.InvetorySystem.Features.StorageSlotsLimiter.ConfirmReservation ( TransactionService.TransactionOrder  order)

Changes reservation holdings state to permanent.

Parameters
orderOrder requested reservation previously.

Implements Doloro.InvetorySystem.IReservationAgent.

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

override void Doloro.InvetorySystem.Features.StorageSlotsLimiter.OnStorageRented ( )
virtual

Drops a data related to certain database instance.

Reimplemented from Doloro.InvetorySystem.AStorageFeature.

◆ 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.StorageSlotsLimiter.OnTrasactionMask ( TransactionService.TransactionOrder  order)
virtual

Checks is the storage slots limiter allows to place entire objects along with them stack size.

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.

◆ Reserve()

void Doloro.InvetorySystem.Features.StorageSlotsLimiter.Reserve ( TransactionService.TransactionOrder  order)

Reserves internal capacity for possible transaction.

Parameters
orderOrder that defines resources that could be transfered to the agent.

Implements Doloro.InvetorySystem.IReservationAgent.

◆ SaveSession()

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

◆ SetDefault()

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

Property Documentation

◆ FilledSlots

float Doloro.InvetorySystem.Features.StorageSlotsLimiter.FilledSlots
get

Current filled slots for current content of the storage content.

>

Not includes reservation.

◆ Limit

float Doloro.InvetorySystem.Features.StorageSlotsLimiter.Limit
getset

Slots allowed to be filled in the storage.

Can't be lesser then 0.


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