API Reference
API Reference
Public Flexweave API surfaces, separate from the guide chapters.
This section is the API map. It is intentionally separate from the book-style guide so users can look up public surfaces without walking through the RPG example.
Surfaces
- Identity
- Data Store
- Query
- Attribute
- Derived Attribute
- Tag
- Ability
- Effect
- Lifecycle
- Signal
- Clock
- Mechanics
- Registry
- Object Lifecycle
- Errors and Outcomes
For Rustdoc output, run:
bun run docs:corePublic Re-Export Coverage
The API Reference is organized around the public re-exports from
core/src/lib.rs.
| Page | Public exports |
|---|---|
| Identity | ObjectId, ObjectStore, INVALID_OBJECT_ID |
| Data Store | DataStore |
| Query | query::require_object, query::require_attached, query::collect_where |
| Attribute | Attribute, AttributeSet, AttributeValue, mutation and change types |
| Derived Attribute | DerivedAttribute, DerivedAttributeRefresh, DerivedChange |
| Tag | Tag, TagSet, TagSetQuery, TagCollection |
| Ability | all ability ids, definitions, stores, commands, executors, events, and errors |
| Effect | all effect ids, definitions, applications, executors, pipelines, events, errors |
| Lifecycle | event kinds, event trait, channels, channel definitions, connections, errors |
| Signal | signal definitions, policies, facts, projection, removal reasons, errors |
| Clock | ClockUnits, Clock, fixed-step and realtime clock helpers |
| Mechanics | MechanicsStore, MechanicsDriver, MechanicsTick |
| Registry | RegistryEntry, DefinitionRegistryEntry, Registry |
| Object Lifecycle | ObjectLifecycleStore, ObjectDestructionDriver, ObjectDestroy |
| Errors and Outcomes | CoreError plus command outcome and error enums from ability/effect surfaces |