Skip to content

Commit

Permalink
Add initial docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nezuo committed Jan 2, 2024
1 parent d25393c commit ddcc7c5
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/config/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,24 @@ When enabled, Zap will generate a `.d.ts` file for the server and client with th
### Example

<CodeBlock code="opt typescript = true" />

## `manual_event_loop`

This option determines if Zap automatically sends reliable events each Heartbeat.

When enabled, a `SendEvents` function will be exported from the client and server modules that must be called manually.

This is useful when you can easily run `SendEvents` after all events have been fired each frame.

### Default

`false`

### Options

- `true`
- `false`

### Example

<CodeBlock code="opt manual_event_loop = true" />

0 comments on commit ddcc7c5

Please sign in to comment.