RIC Docs

Appearance

Plugin 1.0 · Unreal Engine 5.8Source snapshot · Version details

API overview ​

RocketInventoryCore ​

Container manager ​

URicContainerManagerComponent owns roots and publishes inventory-wide events.

  • Create: AddContainerFromDefinition, AddContainersFromCollection.
  • Query: GetContainers, GetContainersRecursive, FindContainerByIdRecursive, FindItemByIdRecursive, FindItemByDefinitionRecursive, FindItemsByDefinitionRecursive.
  • Add: AddItemFromDefinition, AddItemFromDefinitionWithParams, AddItemRef.
  • Save: GetSaveData, LoadFromSaveData.
  • Observe: OnContainersChanged, OnSlotsChanged, OnItemAdded, OnItemRemoved, OnItemDiscarded, OnItemGameplayTagChanged.

The actor is responsible for replication and gameplay lifetime.

Container and item instances ​

URicContainerBase supplies common ownership, GUID, tag, item-query, placement, filter, and persistence APIs. The grid and single-slot classes implement the concrete storage behavior. Many base placement implementations are empty/default methods; use a concrete container.

URicItemInstance exposes definition, GUID, quantity, shape, ownership, child containers, fragments, and tag stacks. Relevant events are OnGameplayTagChanged, OnOuterContainerChanged, and OnStackStart.

Prediction and RPCs ​

URicClientPredictedInventoryComponent exposes GetContainerCopies, GetObservedContainersCopy, SetObservedContainerManager, GUID lookups, move/stack/split/drop/tag operations, synchronization, and container subscriptions.

URicItemOperationsRPCsComponent contains reliable server requests for inventory mutations, actions, and quick-slot assignments. Its methods are not a complete permission system.

Quick slots ​

URicQuickSlotsComponent manages authoritative slots and their save data. URicClientPredictedQuickSlotsComponent maps assignments to predicted inventory copies. Both provide assignment, clearing, item lookup, and slot-change notifications.

World subsystems ​

  • URicInventorySubsystem: construction, manager lookup, transfers, world snapshot data, and tick handlers.
  • URicGlobalTimeSubsystem: a shared server timer.
  • URicVisualResolverSubsystem: GUID/context-based presentation caching.

Helpers and extension types ​

URicStatics contains shape, coordinate, rotation, stacking, nesting, and lookup helpers. FRicScopedReplicationUpdate batches custom mutations. Extension bases are URicItemFragment, URicContainerFragment, URicFilterBase, URicItemAction, URicVisualResolver, URicSwapStrategyBase, and URicTickHandler.

RicInteraction ​

URicInteractionPoint is a scene component with replicated state and execution events. URicInteractorComponent performs local discovery and dispatches execution requests.

URicInteractionSubsystem maintains the spatial index. URicInteractionStrategyClosestVisiblePoint evaluates candidate points, while IRicInteractionInterface supplies UI callbacks.

See World interaction.

RicInput ​

URicInputSubsystem tracks local input devices and cursor state. URicPlatformSettings provides initial device settings. URicDragAndDropHelperSubsystem manages UI drag/context-menu events, and URicDragPayload is the abstract payload base.

See Input and inventory UI.

RicPreview ​

URicPreviewSubsystem creates isolated preview worlds and returns FRicPreviewHandle values. Use OpenPreview, RefreshPreview, SetPreviewActorClass, and ClosePreview.

See Visuals and previews.

RicEditor ​

Asset factories/actions, shape detail customization, thumbnail renderers, and the icon generator are editor integration. They are not runtime gameplay APIs.

Exact reflected names ​

Blueprint display names may differ from C++ names. This version keeps names such as URicFilter_DynamicFilter and URicSwapStrategySwapBoofer exactly as implemented.

The public class catalog describes public classes across the plugin modules. Blueprint display names and availability depend on each API's reflection annotations.