Skip to content

docs: clarify client frame ticking guidance #5165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
clockwork-labs-bot wants to merge 1 commit into from
Closed

docs: clarify client frame ticking guidance #5165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/docs/00300-resources/00100-how-to/00050-troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,15 @@ Your client may have failed to connect to the remote server, or may have been di

You may need to advance your connection by calling one of the following methods:

| Client SDK | Method | Description |
|---------------------|------------------------------|------------------------------------------------------------------------------------|
| Rust (native only) | `conn.run_threaded()` | Spawn a thread to continuously advance the connection. |
| Rust (browser only) | `conn.run_background_task()` | Spawn a task to continuously advance the connection. |
| Rust | `conn.run_async()` | A `Future` which you can `await` or poll to advance the connection. |
| Rust | `conn.frame_tick()` | In single-threaded games, call this every frame to advance the connection. |
| C# | `Conn.FrameTick()` | Call this every frame to advance the connection, or call it in a loop on a thread. |
| Unreal | `Conn.FrameTick()` | Call this every frame to advance the connection. |
| TypeScript | N/a | The TypeScript client SDK advances connections automatically. |
| Client SDK | Method | Description |
|---------------------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Rust (native only) | `conn.run_threaded()` | Spawn a thread to continuously advance the connection. |
| Rust (browser only) | `conn.run_background_task()` | Spawn a task to continuously advance the connection. |
| Rust | `conn.run_async()` | A `Future` which you can `await` or poll to advance the connection. |
| Rust | `conn.frame_tick()` | In single-threaded games, call this every frame to advance the connection. |
| C# | `Conn.FrameTick()` | Call this from your game or application update loop. If you use a separate loop, keep `Conn.Db` access on that same thread or synchronize access. |
| Unreal | `Conn->FrameTick()` or `Conn->SetAutoTicking(true)` | Call `FrameTick()` every frame, or enable auto-ticking once after building the connection. |
| TypeScript | N/a | The TypeScript client SDK advances connections automatically. |

### Rows never appear

Expand Down
Loading