Class CatalogItemConfig
Base configurator of a CatalogItem instance.
Namespace: UnityEngine.GameFoundation.Configs
Syntax
public abstract class CatalogItemConfigFields
displayName
The friendly name of the item.
Declaration
public string displayNameField Value
| Type | Description |
|---|---|
| String |
staticProperties
Declaration
public readonly Dictionary<string, Property> staticPropertiesField Value
| Type | Description |
|---|---|
| Dictionary<String, Property> |
tags
The identifiers of the tags the item will be linked to.
Declaration
public readonly List<string> tagsField Value
| Type | Description |
|---|---|
| List<String> |
Properties
key
The identifier of the item.
Declaration
public string key { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
CompileGeneric()
Create a new TRuntimeObject.
Declaration
public abstract 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. |
LinkGeneric(CatalogItem, Dictionary<String, CatalogItem>)
Resolves the references from the given runtimeObject
using the given compiledItems.
Declaration
public abstract 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. |