GS_Item

Data-driven inventory containers and equipment slot management for collectible, usable, and equippable items in GS_Play projects.
Categories:
Tags:

GS_Item provides the inventory and equipment systems for GS_Play. It gives entities inventory containers that hold stacks of item data, and an equipment system that maps items to named slots on a character entity. Items are defined as data assets, making the full catalog editable without code changes. GS_Item is under active development — the API surface is evolving and additional item behaviours will be added in future releases.

For usage guides and setup examples, see The Basics: GS_Item.

 

Contents

Inventory

The inventory system manages ordered collections of item stacks on an entity. Stacks track item type, quantity, and metadata. The inventory component exposes add, remove, query, and transfer operations and broadcasts notifications when contents change.

AreaContents
Inventory ComponentPer-entity container that holds item stacks and manages quantity limits.
Item Data AssetsData-driven item definitions: display name, icon, stack limit, categories, and custom properties.
Stack OperationsAdd, remove, transfer, split, and query by item type or category.
NotificationsChange events broadcast when items are added, removed, or quantities updated.

Inventory API

Equipment

The equipment system maps item assets to named slots on a character or entity. Equipping an item occupies its designated slot and can trigger stat modifications via GS_RPStats integration. Unequipping returns the item to inventory or discards it based on configured policy.

AreaContents
Equipment ComponentPer-entity slot manager. Maps slot names to currently equipped item assets.
Slot DefinitionsNamed slot configuration (e.g. weapon_main, armour_chest, accessory_1) defined per entity type.
Equip / Unequip FlowValidates slot compatibility, optionally modifies stats via GS_RPStats, and notifies listeners.
NotificationsChange events broadcast when slots are filled, cleared, or swapped.

Equipment API

Installation

GS_Item is a standalone gem. GS_RPStats integration is optional but recommended for stat-modifying equipment.

  1. Enable GS_Item and GS_Core in your O3DE project’s gem list.
  2. Create item data assets in your project’s asset directory and populate them in the Editor.
  3. Add the inventory component to any entity (player, chest, NPC) that should hold items.
  4. Add the equipment component to character entities that support equippable slots.
  5. Configure slot names on the equipment component to match your game’s equipment schema.
  6. Optionally enable GS_RPStats to wire equipment stat modifiers into the character stat pipeline.

Note: GS_Item is under active development. Check the changelog for the latest additions before starting integration work.

See Also

For conceptual overviews and usage guides:

For sub-system references:

For related resources:

Get GS_Item

GS_Item — Explore this gem on the product page and add it to your project.