Skip to content

Commit 9092ed3

Browse files
update Open Source Docs from Roblox internal teams
1 parent e00b8fa commit 9092ed3

File tree

7 files changed

+114
-13
lines changed

7 files changed

+114
-13
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4069,6 +4069,11 @@ navigation:
40694069
type: engineapi
40704070
source: /reference/engine/enums/CompletionTriggerKind.yaml
40714071
ignoreTranslation: true
4072+
- title: CompressionAlgorithm
4073+
path: /reference/engine/enums/CompressionAlgorithm
4074+
type: engineapi
4075+
source: /reference/engine/enums/CompressionAlgorithm.yaml
4076+
ignoreTranslation: true
40724077
- title: ComputerCameraMovementMode
40734078
path: /reference/engine/enums/ComputerCameraMovementMode
40744079
type: engineapi
@@ -4489,6 +4494,11 @@ navigation:
44894494
type: engineapi
44904495
source: /reference/engine/enums/HapticEffectType.yaml
44914496
ignoreTranslation: true
4497+
- title: HashAlgorithm
4498+
path: /reference/engine/enums/HashAlgorithm
4499+
type: engineapi
4500+
source: /reference/engine/enums/HashAlgorithm.yaml
4501+
ignoreTranslation: true
44924502
- title: HighlightDepthMode
44934503
path: /reference/engine/enums/HighlightDepthMode
44944504
type: engineapi

content/en-us/reference/engine/classes/HttpService.yaml

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ description: |
3030
3131
Within Studio, use
3232
`Class.HttpService:CreateWebStreamClient()|CreateWebStreamClient()` to process
33-
data in real-time from HTTP servers that support streaming protocols such as
34-
[SSE](https://en.wikipedia.org/wiki/Server-sent_events) or
35-
[chunked transfer encoding](https://en.wikipedia.org/wiki/Chunked_transfer_encoding).
36-
You can connect callback functions to stream events, allowing you to process
37-
data immediately as it arrives instead of waiting for the entire response to
38-
complete.
33+
data in real-time from servers that support streaming protocols such as
34+
[SSE](https://en.wikipedia.org/wiki/Server-sent_events),
35+
[chunked transfer encoding](https://en.wikipedia.org/wiki/Chunked_transfer_encoding),
36+
and [WebSockets](https://en.wikipedia.org/wiki/WebSocket). You can connect
37+
callback functions to stream events, allowing you to process data immediately
38+
as it arrives instead of waiting for the entire response to complete.
3939
4040
Only send HTTP requests to trusted third-party platforms to avoid introducing
4141
unnecessary security risks to your experience.
@@ -92,11 +92,10 @@ methods:
9292
these callbacks to process messages as soon as they arrive, as well as
9393
respond to open, close, and error events.
9494
95-
There is a limit of six total `Enum.WebStreamClientType.SSE` or
96-
`Enum.WebStreamClientType.RawStream` clients allowed at one time. Close
97-
streams that you no longer need with `Class.WebStreamClient:Close()`. When
98-
the stream is no longer needed, you should disconnect any associated
99-
`Datatype.RBXScriptConnection` to avoid memory leaks.
95+
There is a limit of six total clients allowed at one time. Close streams
96+
that you no longer need with `Class.WebStreamClient:Close()`. When the
97+
stream is no longer needed, you should disconnect any associated
98+
`Datatype.RBXScriptConnection|RBXScriptConnections` to avoid memory leaks.
10099
101100
This method is available in Studio only. If you use it inside scripts,
102101
make sure to remove any references before publishing the experience. We

content/en-us/reference/engine/classes/ObjectValue.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ description: |
2424
The Changed event for this (and other objects like it) will fire with the new
2525
value being stored in the object, instead of a string representing the
2626
property being changed.
27+
28+
If [streaming](../../../workspace/streaming.md) is enabled, the `Value`
29+
property is nil until the referenced object streams in, at which point the
30+
`Changed` event fires.
2731
code_samples:
2832
- ObjectValue-Example
2933
inherits:
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# This file is automatically generated. Please don't edit it manually.
2+
# To submit a bug report on the content, see
3+
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
4+
5+
name: CompressionAlgorithm
6+
type: enum
7+
summary: |
8+
A compression algorithm to use in `Class.EncodingService` methods.
9+
description: |
10+
A compression algorithm to use in `Class.EncodingService` methods.
11+
code_samples: []
12+
tags: []
13+
deprecation_message: ''
14+
items:
15+
- name: Zstd
16+
summary: |
17+
Used to perform compression using
18+
[Zstandard](https://en.wikipedia.org/wiki/Zstd) compression, also known as
19+
zstd.
20+
value: 0
21+
tags: []
22+
deprecation_message: ''
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# This file is automatically generated. Please don't edit it manually.
2+
# To submit a bug report on the content, see
3+
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
4+
5+
name: HashAlgorithm
6+
type: enum
7+
summary: |
8+
A Cryptographic hash function to use in `Class.EncodingService` methods.
9+
description: |
10+
A
11+
[Cryptographic hash function](https://en.wikipedia.org/wiki/Cryptographic_hash_function)
12+
to use in `Class.EncodingService` methods.
13+
code_samples: []
14+
tags: []
15+
deprecation_message: ''
16+
items:
17+
- name: Blake2b
18+
summary: |
19+
Used to compute a 256-bit (32-byte) hash digest using the
20+
[BLAKE2b](https://en.wikipedia.org/wiki/BLAKE2) algorithm.
21+
value: 0
22+
tags: []
23+
deprecation_message: ''
24+
- name: Blake3
25+
summary: |
26+
Used to compute a 256-bit (32-byte) hash digest using the
27+
[BLAKE3](https://en.wikipedia.org/wiki/BLAKE3) algorithm.
28+
value: 1
29+
tags: []
30+
deprecation_message: ''
31+
- name: Md5
32+
summary: |
33+
Used to compute a 128-bit (16-byte) hash digest using the
34+
[MD5](https://en.wikipedia.org/wiki/MD5) algorithm.
35+
value: 2
36+
tags: []
37+
deprecation_message: ''
38+
- name: Sha1
39+
summary: |
40+
Used to compute a 160-bit (20-byte) hash digest using the
41+
[SHA-1](https://en.wikipedia.org/wiki/SHA-1) algorithm.
42+
value: 3
43+
tags: []
44+
deprecation_message: ''
45+
- name: Sha256
46+
summary: |
47+
Used to compute a 256-bit (32-byte) hash digest using the
48+
[SHA256](https://en.wikipedia.org/wiki/SHA-2) algorithm.
49+
value: 4
50+
tags: []
51+
deprecation_message: ''

content/en-us/reference/engine/enums/WebStreamClientType.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,17 @@ items:
2525
deprecation_message: ''
2626
- name: RawStream
2727
summary: |
28-
The client can connect to any server that provides streaming data transfer
29-
(e.g.
28+
General purpose HTTP streaming client. It can connect to any server that
29+
provides streaming data transfer (e.g.
3030
[chunked encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Transfer-Encoding)).
3131
It provides no guarantees about the stream format.
3232
value: 1
3333
tags: []
3434
deprecation_message: ''
35+
- name: WebSocket
36+
summary: |
37+
[WebSocket](https://en.wikipedia.org/wiki/WebSocket) client that provides
38+
a bidirectional communication channel over a TCP connection.
39+
value: 2
40+
tags: []
41+
deprecation_message: ''

tools/checks/utils/allowedHttpLinks.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -714,3 +714,11 @@ https://github.com/roblox/graphql-lua
714714
https://github.com/roblox/graphql-tag-lua
715715
https://github.com/roblox/apollo-client-lua
716716
https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation
717+
https://en.wikipedia.org/wiki/Zstd
718+
https://en.wikipedia.org/wiki/Cryptographic_hash_function
719+
https://en.wikipedia.org/wiki/BLAKE2
720+
https://en.wikipedia.org/wiki/BLAKE3
721+
https://en.wikipedia.org/wiki/MD5
722+
https://en.wikipedia.org/wiki/SHA-1
723+
https://en.wikipedia.org/wiki/SHA-2
724+
https://en.wikipedia.org/wiki/WebSocket

0 commit comments

Comments
 (0)