Skip to content

Clarify string documentation. #19

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

Open
Windows81 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify string documentation. #19

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
5 changes: 3 additions & 2 deletions formats/rbxl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Type | Example | Description
`floatNE` | `float32` | A IEEE 754 floating-point number with a size of `N` bits, and [endianness][Endianness] `E`.
`rfloatNE` | `rfloat32` | Same as `floatNE`, but with [rotated encoding][RotatedEncoding].
`bool` | `bool` | A boolean value stored as a `uint8`, where 0 is false and 1 is true.
`string | `string` | A [string][Strings] value with a prefix `N` value `uint32`, followed by a non-zero terminated `[N]uint8`.
`[N]T` | `[4]uint8` | An array with a constant length of `N`, with elements of type `T`.
`[]T` | `[]uint8` | An array with elements of type `T`, the length of which is determined dynamically.
`?T` | `?uint8` | A value of type `T`, which may or may not be present based on some condition. If not present, the value is omitted entirely.
Expand Down Expand Up @@ -124,8 +125,8 @@ the following structure:

Field | Type | Description
-------|-----------|------------
Length | `uint32` | The length of the string.
Bytes | `[]uint8` | The content of the string. The length is determined by the Length field.
Length | `uint32` | The length of the following Bytes field.
Bytes | `[]uint8` | The content of the string. Strings are non-zero terminated.

## References
[References]: #references
Expand Down