Class CatalogItemConfig<TRuntimeItem>
Base configurator of a CatalogItem instance.
Inherited Members
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
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
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 |
|
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
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
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 |