Class GameItemCatalog
A Catalog for all GameItemDefinitions.
Namespace: UnityEngine.GameFoundation
Assembly: solution.dll
Syntax
public class GameItemCatalogProperties
| Name | Description |
|---|---|
| categories | A dictionary of all CategoryDefinitions. |
| definitions | A dictionary of all GameItemDefinitions. |
Methods
| Name | Description |
|---|---|
| GetCategories() | Returns the categories in this catalog in an array. |
| GetCategories(List<CategoryDefinition>) | Fills the given list with all categories found in this catalog. Note: this returns the current state of categories. To ensure that there are no invalid or duplicate entries, the 'categories' list will always be cleared and 'recycled' (i.e. updated) with current data from the catalog. |
| GetCategory(int) | Returns specified CategoryDefinition by its Hash. |
| GetCategory(string) | Returns specified Category by CategoryDefinition Hash. |
| GetDefinitionsByCategory(int) | This will return an array of GameItemDefinitions with the designated Category. |
| GetDefinitionsByCategory(int, List<GameItemDefinition>) | Fills the given list with the GameItemDefinitions that have the designated category. Note: this returns the current state of game item definitions. To ensure that there are no invalid or duplicate entries, the 'gameItemDefinitions' list will always be cleared and 'recycled' (i.e. updated) with current data from the catalog. |
| GetDefinitionsByCategory(string) | This will return an array of GameItemDefinitions with the designated Category. |
| GetDefinitionsByCategory(string, List<GameItemDefinition>) | Fills the given list with the GameItemDefinitions that have the designated category. Note: this returns the current state of game item definitions. To ensure that there are no invalid or duplicate entries, the 'gameItemDefinitions' list will always be cleared and 'recycled' (i.e. updated) with current data from the catalog. |
| GetGameItemDefinition(int) | Return specified GameItemDefinition by Hash. |
| GetGameItemDefinition(string) | Return specified GameItemDefinition by GameItemDefinition id string. |
| GetGameItemDefinitions() | Returns an array of all game item definitions in this catalog. |
| GetGameItemDefinitions(List<GameItemDefinition>) | Fills the given array with all game item definitions in this catalog. Note: this returns the current state of game item definitions. To ensure that there are no invalid or duplicate entries, the 'gameItemDefinitions' list will always be cleared and 'recycled' (i.e. updated) with current data from the catalog. |
| IsDefinitionHashUnique(string) | Check if the given string's hash is not yet included in this GameItemCatalog's list of GameItemDefinitions and is available for use. |