docs.unity.cn
    Show / Hide Table of Contents

    Class CatalogProductSourceImpl

    Class CatalogProductSourceImpl.

    Inheritance
    Object
    CatalogProductSourceImpl
    Namespace: UnityEngine.Industrial.Configuring.ConfiguratorRuntime
    Syntax
    [Serializable]
    public class CatalogProductSourceImpl : IProductSource

    Constructors

    CatalogProductSourceImpl(MonoBehaviour)

    Initializes a new instance of the CatalogProductSourceImpl class.

    Declaration
    public CatalogProductSourceImpl(MonoBehaviour controller)
    Parameters
    Type Name Description
    MonoBehaviour controller

    The controller.

    Properties

    CatalogPaths

    Gets the catalog paths.

    Declaration
    public List<string> CatalogPaths { get; }
    Property Value
    Type Description
    List<String>

    The catalog paths.

    IsLoaded

    Gets or sets a value indicating whether this instance is loaded.

    Declaration
    public virtual bool IsLoaded { get; set; }
    Property Value
    Type Description
    Boolean

    true if this instance is loaded; otherwise, false.

    Implements
    IProductSource.IsLoaded

    IsLoading

    Gets or sets a value indicating whether this instance is loading.

    Declaration
    public virtual bool IsLoading { get; set; }
    Property Value
    Type Description
    Boolean

    true if this instance is loading; otherwise, false.

    Implements
    IProductSource.IsLoading

    Products

    Gets or sets the products.

    Declaration
    public List<AssetProductReference> Products { get; set; }
    Property Value
    Type Description
    List<AssetProductReference>

    The products.

    Implements
    IProductSource.Products

    Methods

    ClearListeners()

    Clears the listeners.

    Declaration
    public void ClearListeners()

    FindCatalogFromStreamingAssetFolder(String)

    Works in Windows, Mac and Linux. (Not on Android or iOS)

    Declaration
    public static List<string> FindCatalogFromStreamingAssetFolder(string folderPath)
    Parameters
    Type Name Description
    String folderPath

    Path to look into

    Returns
    Type Description
    List<String>

    Catalog found

    Load()

    Loads this instance.

    Declaration
    public virtual IEnumerator Load()
    Returns
    Type Description
    IEnumerator

    IEnumerator.

    Implements
    IProductSource.Load()

    RemoveProduct(String, Boolean)

    Removes the product.

    Declaration
    public void RemoveProduct(string key, bool sendEvent = true)
    Parameters
    Type Name Description
    String key

    The key.

    Boolean sendEvent

    if set to true [send event].

    Implements
    IProductSource.RemoveProduct(String, Boolean)
    Exceptions
    Type Condition
    ArgumentException

    There is no product with {key}.

    Unload()

    Unloads this instance.

    Declaration
    public virtual IEnumerator Unload()
    Returns
    Type Description
    IEnumerator

    IEnumerator.

    Implements
    IProductSource.Unload()

    Events

    onProductAdded

    Occurs when [on product added].

    Declaration
    public event ProductSource.ProductReferenceEvent onProductAdded
    Event Type
    Type Description
    ProductSource.ProductReferenceEvent
    Implements
    IProductSource.onProductAdded

    onProductRemoved

    Occurs when [on product removed].

    Declaration
    public event ProductSource.ProductGuidEvent onProductRemoved
    Event Type
    Type Description
    ProductSource.ProductGuidEvent
    Implements
    IProductSource.onProductRemoved
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on 03 March 2021