Class GameItemCatalog
A Catalog for all GameItemDefinitions.
Inherited Members
Namespace: UnityEngine.GameFoundation
Assembly: solution.dll
Syntax
public class GameItemCatalog : ScriptableObject
Properties
| Name | Description |
|---|---|
| categories | A dictionary of all CategoryDefinitions. |
| definitions | A dictionary of all GameItemDefinitions. |
Methods
| Name | Description |
|---|---|
| AddCategory(CategoryDefinition) | Adds the given Category to this GameItemCatalog. |
| AddGameItemDefinition(GameItemDefinition) | Adds the given GameItemDefinition to this GameItemCatalog. |
| Create() | Simple factory method for creating an empty GameItemCatalog. |
| GetCategories() | Returns the categories in this catalog in an array. |
| GetCategories(List<CategoryDefinition>) | Fills the given list with all categories found in this 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. |
| 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. |
| 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. |
| IsDefinitionHashUnique(string) | Check if the given Hash is not yet included in this GameItemCatalog's list of GameItemDefinitions and is available for use. |
| RemoveCategory(CategoryDefinition) | Removes the given Category from this GameItemCatalog. |
| RemoveGameItemDefinition(GameItemDefinition) | Removes the given GameItemDefinition from this GameItemCatalog. |