mirror of https://github.com/clockworklabs/SpacetimeDB.git synced 2026-07-21 01:30:20 -04:00

Files

T

History

Jason Larabie 57c845d6a5 Fix Unreal cache desync for overlapping transaction table updates (#5426 )

# Description of Changes
- Fixed an Unreal SDK cache bug with overlapping subscriptions on the
same table called out in
[Discord](<https://discordapp.com/channels/1037340874172014652/1507200761900171405>)
from @defohost
- Merged repeated transaction table updates by table name while
preserving all row-set payloads
- Fixes unique-index `Find(...)` returning empty while `Iter()` still
sees the updated row
- Aligned Unreal transaction update handling with the other SDKs
- Applies one accumulated per-table update per transaction instead of
multiple partial passes

# API and ABI breaking changes
- No intended API or ABI breaking changes to released Unreal SDK
behavior

# Expected complexity level and risk

2 - Small transaction update normalization change, risk is preserving
row multiplicity for overlapping
subscriptions

# Testing
What I've done so far:
- [x] Added and ran a throwaway Unreal repro for overlapping identical
subscriptions on one table
- [x] Ran the full `sdk-unreal-test-harness`
- [x] Tested Unreal Blackholio

2026-06-23 14:56:19 +00:00

examples

Update Unreal SDK to websocket 2.0 (#4497 )

2026-03-18 21:14:06 +00:00

src

Fix Unreal cache desync for overlapping transaction table updates (#5426 )

2026-06-23 14:56:19 +00:00

tests

Fix Unreal cache desync for overlapping transaction table updates (#5426 )

2026-06-23 14:56:19 +00:00

.gitignore

Added the Unreal SDK work for codegen, testing, and the plugin (#3223 )

2025-09-19 22:52:53 +00:00

Cargo.toml

Migrate to Rust 2024 (#3802 )

2026-03-03 11:06:52 +00:00

DEVELOP.md

Update Unreal SDK to websocket 2.0 (#4497 )

2026-03-18 21:14:06 +00:00

LICENSE

Update selected crate licenses to Apache 2.0 (#5151 )

2026-06-02 16:13:59 +00:00

README.md

Added the Unreal SDK work for codegen, testing, and the plugin (#3223 )

2025-09-19 22:52:53 +00:00

README.md

SpacetimeDB Unreal SDK

This folder contains the Unreal Engine plugin that allows games to talk to a SpacetimeDB server. The design mirrors the official Rust SDK and borrows ideas from the C# SDK so that projects can share a common workflow across languages.

Overview

The plugin exposes a high level API for establishing connections, invoking reducers and keeping a synchronized cache of database tables. Communication happens over WebSockets using the BSATN binary format. Most of the message and type headers are generated by the SpacetimeDB CLI so that Unreal games can send and receive the same structures as other SDKs.

Feature Highlights

Connect to a SpacetimeDB server and authenticate with identity tokens
Call reducers and receive their results via Blueprint exposed delegates
Subscribe to queries and maintain a local table cache updated by server diffs
Serialize common Unreal types to BSATN, including arrays
Auto-generated table types keep the API in sync with your database
Pure C++ implementation with Blueprint wrappers for easy gameplay scripting

Directory Layout

crates/sdk-unreal/
├── DEVELOP.md           # Notes on integrating the plugin into a project
├── SpacetimeDbSdk/      # The Unreal plugin sources
│   ├── Resources/       # Plugin icons and metadata
│   └── Source/
│       └── SpacetimeDbSdk/
│           ├── Public/  # Headers used by gameplay code
│           │   ├── BSATN/       # BSATN serializer
│           │   ├── Connection/  # Connection and subscription classes
│           │   ├── DBCache/     # Client side table cache utilities
│           │   ├── Tables/      # Base class for generated table wrappers
│           │   ├── Types/       # Generated message and type headers
│           │   └── tests/       # Unit test helpers for BSATN
│           ├── Private/ # Implementation files
│           └── SpacetimeDbSdk.Build.cs

See the README files in each subfolder for more details on the available classes and helpers.

Getting Started

Copy SpacetimeDbSdk into your project's Plugins directory or use the AdditionalPluginDirectories option described in DEVELOP.md.
Regenerate the headers under Public/Types by running the SpacetimeDB CLI against your module schema.
Include SpacetimeDbSdk in your game's build files and start a connection using UDbConnectionBuilder.

With the connection established you can call reducers, subscribe to queries and drive gameplay logic using incoming table data.