Class ConfiguratorSettings
Settings of the configurator.
Inherited Members
Namespace: UnityEngine.Industrial.Configuring.ConfiguratorRuntime
Syntax
[ExecuteInEditMode]
public class ConfiguratorSettings : MonoBehaviourProperties
analyticsPrefab
Prefab containing the analytics engine provider.
Declaration
public GameObject analyticsPrefab { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | The analytics prefab. |
pricingEnginePrefab
Prefab containing the price engine provider.
Declaration
public GameObject pricingEnginePrefab { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | The pricing engine prefab. |
productPrefabs
Product prefabs available in this configurator.
Declaration
public ReadOnlyCollection<AssetProductReference> productPrefabs { get; }Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<AssetProductReference> | The product prefabs. |
ProductSources
Gets the product sources.
Declaration
public ReadOnlyCollection<IProductSource> ProductSources { get; }Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<IProductSource> | The product sources. |
ruleEnginePrefab
Prefab containing the rule engine provider.
Declaration
public GameObject ruleEnginePrefab { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | The rule engine prefab. |
runtimeUIDataEnginePrefab
Prefab containing the info engine provider.
Declaration
public GameObject runtimeUIDataEnginePrefab { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | The runtime UI data engine prefab. |
runtimeUISettings
Runtime UI settings for the configurators
Declaration
public ConfiguratorRuntimeUISettings runtimeUISettings { get; set; }Property Value
| Type | Description |
|---|---|
| ConfiguratorRuntimeUISettings | The runtime UI settings. |
ValidProductPrefabs
Gets the valid product prefabs.
Declaration
public IEnumerable<AssetProductReference> ValidProductPrefabs { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<AssetProductReference> | The valid product prefabs. |
Methods
AddProduct(AssetProductReference)
Adds the product.
Declaration
public void AddProduct(AssetProductReference assetReference)Parameters
| Type | Name | Description |
|---|---|---|
| AssetProductReference | assetReference | The asset reference. |
AddProductSource(IProductSource, Boolean, Boolean)
Adds the product source.
Declaration
public void AddProductSource(IProductSource productSource, bool addToSourceList = true, bool addSourceProductsFromList = true)Parameters
| Type | Name | Description |
|---|---|---|
| IProductSource | productSource | The product source. |
| Boolean | addToSourceList | if set to |
| Boolean | addSourceProductsFromList | if set to |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | productSource |
FindProductSourceOwners(AssetProductReference)
Find the ProductSource owner of the product guid (key).
Declaration
public List<IProductSource> FindProductSourceOwners(AssetProductReference productReference)Parameters
| Type | Name | Description |
|---|---|---|
| AssetProductReference | productReference | Asset Product Reference |
Returns
| Type | Description |
|---|---|
| List<IProductSource> | Related ProductSource |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | productReference |
GetProductAtIndex(Int32)
Gets the index of the product at.
Declaration
public AssetProductReference GetProductAtIndex(int index)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | The index. |
Returns
| Type | Description |
|---|---|
| AssetProductReference | AssetProductReference. |
Exceptions
| Type | Condition |
|---|---|
| IndexOutOfRangeException | There is no product with {index}. |
Init(ConfigurationManager)
Initializes the specified configuration manager.
Declaration
public void Init(ConfigurationManager configurationManager)Parameters
| Type | Name | Description |
|---|---|---|
| ConfigurationManager | configurationManager | The configuration manager. |
RemoveProductAtIndexFromSource(Int32)
Will remove the product at index from the ProductSource owner.
Declaration
public AssetProductReference RemoveProductAtIndexFromSource(int index)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | The index. |
Returns
| Type | Description |
|---|---|
| AssetProductReference | AssetProductReference. |
Exceptions
| Type | Condition |
|---|---|
| IndexOutOfRangeException | There is no product with {index}. |
| ArgumentException | There is no product with {index}. |
RemoveProductSource(IProductSource, Boolean, Boolean)
Removes the product source.
Declaration
public void RemoveProductSource(IProductSource productSource, bool removeFromSourceList = true, bool removeSourceProductsFromList = true)Parameters
| Type | Name | Description |
|---|---|---|
| IProductSource | productSource | The product source. |
| Boolean | removeFromSourceList | if set to |
| Boolean | removeSourceProductsFromList | if set to |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | productSource |
Events
productSourceAdded
Occurs when [product source added].
Declaration
public event ProductSourceChanged productSourceAddedEvent Type
| Type | Description |
|---|---|
| ProductSourceChanged |
productSourceRemoved
Occurs when [product source removed].
Declaration
public event ProductSourceChanged productSourceRemovedEvent Type
| Type | Description |
|---|---|
| ProductSourceChanged |
settingsChanged
Occurs when [settings changed].
Declaration
public event SettingsChanged settingsChangedEvent Type
| Type | Description |
|---|---|
| SettingsChanged |