mirror of
https://github.com/imezx/Warp.git
synced 2026-03-18 00:44:16 +00:00
chore(docs): update buffer.md
This commit is contained in:
parent
07e0a99577
commit
189ac58d0d
1 changed files with 9 additions and 9 deletions
|
|
@ -22,21 +22,21 @@ Define strict data schemas for optimized serialization and type safety.
|
||||||
"nil",
|
"nil",
|
||||||
|
|
||||||
-- Numeric types
|
-- Numeric types
|
||||||
"u8",
|
"u8", -- usigned-int
|
||||||
"u16",
|
"u16",
|
||||||
"u32",
|
"u32",
|
||||||
"i8",
|
"i8", -- signed-int
|
||||||
"i16",
|
"i16",
|
||||||
"i32",
|
"i32",
|
||||||
"f16",
|
"f16", -- floating-point
|
||||||
"f32",
|
"f32",
|
||||||
"f64",
|
"f64",
|
||||||
|
|
||||||
-- Roblox types
|
-- Roblox types
|
||||||
"buffer"
|
"buffer"
|
||||||
"vector2",
|
"vector2", -- f16
|
||||||
"vector3",
|
"vector3", -- f16
|
||||||
"cframe",
|
"cframe", -- f32 & f16
|
||||||
"color3", -- u8
|
"color3", -- u8
|
||||||
"color3f16",
|
"color3f16",
|
||||||
"instance",
|
"instance",
|
||||||
|
|
@ -60,16 +60,16 @@ Define strict data schemas for optimized serialization and type safety.
|
||||||
object: { any },
|
object: { any },
|
||||||
writer: (w: Writer, v: any) -> (),
|
writer: (w: Writer, v: any) -> (),
|
||||||
reader: (b: buffer, c: number, refs: { Instance }?) -> (buffer, number))
|
reader: (b: buffer, c: number, refs: { Instance }?) -> (buffer, number))
|
||||||
): Writer
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
```luau [Example]
|
```luau [Example]
|
||||||
local Buffer = Warp.Buffer()
|
local Buffer = Warp.Buffer()
|
||||||
|
|
||||||
-- # this custom datatype must be registered on both server & client side
|
-- # this custom datatype must be registered on both server & client side
|
||||||
Buffer.Schema.custom_datatype("u64", {}, function(writer, value)
|
Buffer.Schema.custom_datatype("u64", {}, function(w: Buffer.Writer, value: any) -- just for reference
|
||||||
-- writing u64 logics here
|
-- writing u64 logics here
|
||||||
end, function(b, cursor, refs)
|
end, function(b: buffer, cursor: number, refs)
|
||||||
-- reading u64 logics here
|
-- reading u64 logics here
|
||||||
return b, cursor
|
return b, cursor
|
||||||
end)
|
end)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue