Skip to content

Extensions

Optional convenience helpers built on top of result-first APIs.

These helpers provide shorthand wrappers and formatting utilities to reduce boilerplate.

Purpose

Provide ergonomic helpers for interacting with inventory systems in UI, tools, and lightweight scripts.

What Lives Here

  • CharacterEquipmentExtensions → bool wrappers for equipment operations
  • InventoryReadExtensions → read-only helpers for inventory services
  • InventoryServiceSortExtensions → sorting and search helpers
  • InvOpResultExtensions → converts results into user-facing text

Important Notes

  • Extensions are thin wrappers over existing systems
  • They do not implement core logic
  • Some helpers reduce result detail to boolean outcomes

Usage Guidance

Bool wrappers

Some helpers return only a success flag.

This may hide:

  • failure reasons
  • partial results
  • diagnostic messages

Use result-first APIs when detailed handling is required.

Result formatting

Helpers can convert operation results into readable messages for UI or debugging.

Service vs container usage

  • service-based helpers respect authority
  • container-based helpers may bypass authority

Use service APIs when authority matters.

Typical usage

Extensions are suited for:

  • UI glue code
  • debug tools
  • quick scripts

Not for Production Use

Helpers are conveniences over the service, not a replacement for it

This folder does not:

  • Define mutation rules
  • Enforce authority
  • Replace service APIs
  • Provide validation logic
  • Define search or sort behaviour