IProductObtainer

Overview

Magify provides functionality for managing product obtainers and their behavior. This includes checking product availability, preparing products, and obtaining them through campaigns.

IProductObtainer Interface

Overview

The IProductObtainer interface defines the structure for obtaining and preparing products.

ObtainUnderSpin

bool ObtainUnderSpin => false;

Indicates whether the product should be obtained under spinner popup.

CanObtainProduct

bool CanObtainProduct(ProductDef product);

Determines if the specified product can be obtained by this implementation.

NeedPrepareProduct

bool NeedPrepareProduct(ProductDef product) => false;

Checks whether the specified product needs preparation before obtaining.

PrepareProductAsync

UniTask<ProductPrepareResult> PrepareProductAsync(ProductDef product, CancellationToken cancellationToken) => UniTask.FromResult(ProductPrepareResult.Success());

Asynchronously prepares the specified product for obtaining. Defaults to returning a successful result.

ObtainProductAsync

UniTask<ProductObtainResult> ObtainProductAsync(ProductDef product, CampaignRequest request);

Asynchronously obtains the specified product based on the provided campaign request.

ProductObtainer<T> Abstract Class

Overview

The ProductObtainer<T> abstract class provides a base implementation of the IProductObtainer interface for specific product types.

CanObtainProduct

virtual bool CanObtainProduct(ProductDef product)
{
    return product is T;
}

Checks whether the specified product can be obtained. By default, verifies if the product is of type T.

ObtainProductAsync

UniTask<ProductObtainResult> ObtainProductAsync(ProductDef product, CampaignRequest request)
{
    return ObtainProductAsync((T)product, request);
}

Delegates the product obtaining operation to a type-specific implementation.

ObtainProductAsync (Type-Specific)

private protected abstract UniTask<ProductObtainResult> ObtainProductAsync(T product, CampaignRequest request);

Type-specific implementation of the product obtaining operation. Must be implemented by derived classes.