hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-22 21:01:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix autoSerialize note

Browse source
This commit is contained in:
Richard 2025-01-25 14:04:40 -08:00
parent 9e5cb6954c
commit 6af6515fc1
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -473,10 +473,11 @@ end)
- **optional** `preserveHistory`: Whether to sync an exhaustive history of changes made to the atoms since the last sync event. If `true`, the server sends multiple payloads instead of one. Defaults to `false` for performance. - **optional** `preserveHistory`: Whether to sync an exhaustive history of changes made to the atoms since the last sync event. If `true`, the server sends multiple payloads instead of one. Defaults to `false` for performance.
- **optional** `autoSerialize`: Whether to apply validation and workarounds to certain [remote argument limitations](https://create.roblox.com/docs/scripting/events/remote#table-indexing). Defaults to `true`, but you should set it to `false` if you serialize remote arguments (i.e. if you use [ByteNet](https://github.com/ffrostfall/ByteNet) or [Zap](https://github.com/red-blox/zap)). - **optional** `autoSerialize`: Whether to apply validation and workarounds to certain [remote argument limitations](https://create.roblox.com/docs/scripting/events/remote#table-indexing). Defaults to `true`, but you should set it to `false` if you serialize remote arguments (i.e. if you use [ByteNet](https://github.com/ffrostfall/ByteNet) or [Zap](https://github.com/red-blox/zap)).
> [!NOTE] > [!NOTE]
> Charm sends table updates in the form of partial tables, so arrays will contain `nil` values, which has undefined behavior in remotes without serialization. > Charm sends table updates in the form of partial tables, so arrays will contain `nil` values, which has undefined behavior in remotes without serialization.
> >
> Charm's default behavior fixes this, but it can interfere with custom serialization, so disable this option if you use a custom network library. > Charm's default `autoSerialize` behavior fixes this, but it can interfere with custom serialization. Disable this option if you use a custom network library.
#### Returns #### Returns