docs.unity.cn
    Show / Hide Table of Contents

    Class CatalogItemConfig<TRuntimeItem>

    Base configurator of a CatalogItem instance.

    Inheritance
    Object
    CatalogItemConfig
    CatalogItemConfig<TRuntimeItem>
    BaseTransactionConfig<TTransaction>
    CurrencyConfig
    GameParameterConfig
    InventoryItemDefinitionConfig
    RewardConfig
    StoreConfig
    Inherited Members
    CatalogItemConfig.key
    CatalogItemConfig.displayName
    CatalogItemConfig.tags
    CatalogItemConfig.staticProperties
    Namespace: UnityEngine.GameFoundation.Configs
    Syntax
    public abstract class CatalogItemConfig<TRuntimeItem> : CatalogItemConfig, IBuildable<TRuntimeItem> where TRuntimeItem : CatalogItem
    Type Parameters
    Name Description
    TRuntimeItem

    The type of the configurable CatalogItem.

    Methods

    Compile()

    Create a new TRuntimeObject.

    Declaration
    public Deferred<TRuntimeItem> Compile()
    Returns
    Type Description
    Deferred<TRuntimeItem>

    Return a promise handle to report how the operation went. The handle's result is the compiled item if the compilation was successful.

    Implements
    IBuildable<TRuntimeObject>.Compile()

    CompileGeneric()

    Create a new TRuntimeObject.

    Declaration
    public override Deferred<CatalogItem> CompileGeneric()
    Returns
    Type Description
    Deferred<CatalogItem>

    Return a promise handle to report how the operation went. The handle's result is the compiled item if the compilation was successful.

    Overrides
    CatalogItemConfig.CompileGeneric()

    CompileItem(Rejectable)

    Create a new TRuntimeObject.

    Declaration
    protected abstract TRuntimeItem CompileItem(Rejectable rejectable)
    Parameters
    Type Name Description
    Rejectable rejectable
    Returns
    Type Description
    TRuntimeItem

    Return a promise handle to report how the operation went. The handle's result is the compiled item if the compilation was successful.

    DoRequireDisplayName()

    Check if this configuration required a display name to compile.

    Declaration
    protected virtual bool DoRequireDisplayName()
    Returns
    Type Description
    Boolean

    true if required, false otherwise.

    Link(TRuntimeItem, Dictionary<String, CatalogItem>)

    Resolves the references from the given runtimeObject using the given compiledItems.

    Declaration
    public Deferred Link(TRuntimeItem runtimeObject, Dictionary<string, CatalogItem> compiledItems)
    Parameters
    Type Name Description
    TRuntimeItem runtimeObject
    Dictionary<String, CatalogItem> compiledItems

    The collection of existing catalog items where references can be found.

    Returns
    Type Description
    Deferred

    Return a promise handle to report how the operation went.

    Implements
    IBuildable<TRuntimeObject>.Link(TRuntimeObject, Dictionary<String, CatalogItem>)

    LinkGeneric(CatalogItem, Dictionary<String, CatalogItem>)

    Resolves the references from the given runtimeObject using the given compiledItems.

    Declaration
    public override Deferred LinkGeneric(CatalogItem runtimeObject, Dictionary<string, CatalogItem> compiledItems)
    Parameters
    Type Name Description
    CatalogItem runtimeObject
    Dictionary<String, CatalogItem> compiledItems

    The collection of existing catalog items where references can be found.

    Returns
    Type Description
    Deferred

    Return a promise handle to report how the operation went.

    Overrides
    CatalogItemConfig.LinkGeneric(CatalogItem, Dictionary<String, CatalogItem>)

    LinkItem(TRuntimeItem, Dictionary<String, CatalogItem>, Rejectable)

    Resolves the references from the given runtimeObject using the given compiledItems.

    Declaration
    protected virtual void LinkItem(TRuntimeItem runtimeObject, Dictionary<string, CatalogItem> compiledItems, Rejectable rejectable)
    Parameters
    Type Name Description
    TRuntimeItem runtimeObject
    Dictionary<String, CatalogItem> compiledItems
    Rejectable rejectable
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on 16 June 2021