Namespace UnityEngine.GameFoundation

Classes

AnalyticsDetailDefinition

AnalyticsDetailDefinition. Attach to a game item to have it automatically get tracked with analytics.

CategoryDefinition

CategoryDefinition describes a Category. CategoryDefinitions are usable across multiple systems, but each system is responsible for containing and managing its own Categories.

CurrencyDetailDefinition

CurrencyDetailDefinition. Attach to a GameItemDefinition to store the currency information.

DefaultCollectionDefinition

DefaultCollectionDefinitions contain preset values and rules for a Collection by using a CollectionDefinition. During runtime, it may be useful to refer back to the DefaultCollectionDefinition for the presets and rules, but the values cannot be changed at runtime (your system may, for example, bypass the presets, or calculate new values on the fly with modifiers).

DefaultItem

This class contains a pair of data, a GameItemDefinition Hash and an int for quantity. These are used to setup the DefaultItems in a CollectionDefinition.

GameFoundation

Manage the initialization and the persistence of the Game Foundation systems.

GameFoundationDatabase

This consolidates all catalogs into one asset.

GameFoundationSettings

Game Foundation settings for all of Game Foundation implemenation and serialization.

GameItem

Common Fields found in BaseItem and BaseCollection. BaseItem and BaseCollection both inherit from this class.

GameItemCatalog

A Catalog for all GameItemDefinitions.

GameItemDefinition

Base class for both BaseItemDefinition and BaseCollectionDefinition. Holds Id, dsplay name, etc., and allows DetailDefinitions to be attached as needed.

IconDetailDefinition

IconDetailDefinition. Attach to a GameItemDefinition to store sprite information.

Inventory

Contains a runtime list of InventoryItems as well as details which effect this Inventory.

InventoryCatalog

Definitions for InventoryItemDefinitions and InventoryDefinitions. The Catalog serves as a way to find references to Definitions, as needed.

InventoryDefinition

Describes preset values and rules for an Inventory. During runtime, it may be useful to refer back to the InventoryDefinition for the presets and rules, but the values cannot be changed at runtime. The InventoryDefinition is also responsible for creating Inventories based on preset properties.

InventoryItem

An InventoryItem that goes into an Inventory. InventoryItems should only exist inside Inventories.

InventoryItemDefinition

Preset values and rules for an InventoryItem. During runtime, it may be useful to refer back to the InventoryItemDefinition for the presets and rules, but the values cannot be changed at runtime. InventoryItemDefinitions are also used as factories to create InventoryItems.

InventoryManager

Manages all Inventories. Can subscribe to events relevant to Inventories and create and remove them here. InventoryManager also owns the main and wallet Inventories, as well as all other Inventories of InventoryItems. The InventoryManager can create Inventories from InventoryDefinitions or default Inventories as needed.

InventoryManager.InventoryManagerEvent

This is a Unity event that effects the entire InventoryManager

StatCatalog

Definitions for StatDefinitions. The Stat Catalog serves as a way to find references to Definitions, as needed.

StatDefinition

This is one entry in the list of possible stats an item could have.

StatDetailDefinition

Detail definition to establish that item uses certain stats, and also to set default values for those stats.

StatItem<T>

This is one record in the Stat Manager’s list of current Stats at runtime.

StatManager

Track of all runtime stats data and exposes methods for managing the data at runtime.

Wallet

Static helper class for dealing with the Wallet inventory.
Many methods are simply shortcuts for 'InventoryManager.wallet.xxx'.

Enums

CurrencyDetailDefinition.CurrencyType

Enum for currency type. Sets to soft, hard, special, event or other types of currency.

StatDefinition.StatValueType

Enum to determine the value type for this StatDefinition

Delegates

InventoryManager.InventoryEvent

This is a delegate that takes in a single Inventory as the parameter