Method GetDefinitionsByCategory
GetDefinitionsByCategory(string)
This will return an array of GameItemDefinitions with the designated Category.
Declaration
public GameItemDefinition[] GetDefinitionsByCategory(string categoryId)Parameters
| Type | Name | Description |
|---|---|---|
| string | categoryId | The id string of the Category we want to iterate. |
Returns
| Type | Description |
|---|---|
| Game |
An array of GameItemDefinitions that contain the given 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.
Declaration
public void GetDefinitionsByCategory(string categoryId, List<GameItemDefinition> gameItemDefinitions)Parameters
| Type | Name | Description |
|---|---|---|
| string | categoryId | The id string of the Category we want to iterate. |
| List<Game |
gameItemDefinitions | The list to clear and fill with matching data. |
GetDefinitionsByCategory(int)
This will return an array of GameItemDefinitions with the designated Category.
Declaration
public GameItemDefinition[] GetDefinitionsByCategory(int categoryHash)Parameters
| Type | Name | Description |
|---|---|---|
| int | categoryHash | The id hash of the Category we want to iterate. |
Returns
| Type | Description |
|---|---|
| Game |
An array of GameItemDefinitions that contain the requested 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.
Declaration
public void GetDefinitionsByCategory(int categoryHash, List<GameItemDefinition> gameItemDefinitions)Parameters
| Type | Name | Description |
|---|---|---|
| int | categoryHash | The id hash of the Category we want to iterate. |
| List<Game |
gameItemDefinitions | The list to clear and fill with matching data. |