rules

.cursor/rules/roblox/reference/engine/enums/StreamingPauseMode.yaml

@@ -0,0 +1,57 @@
+# This file is automatically generated. Please don't edit it manually.
+# To submit a bug report on the content, see
+# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
+
+name: StreamingPauseMode
+type: enum
+summary: |
+  Determines how a Players client should handle not having enough content
+  streamed in to continue playing properly.
+description: |
+  The StreamingPauseMode enum is used to control
+  `Class.Workspace.StreamingPauseMode` behavior.
+
+  Default behavior is currently equivalent to disabled, but may change in the
+  future.
+
+  The disabled mode indicates that gameplay continues unchanged even if player
+  does not have the minimum streaming radius available.
+
+  In ClientPhysicsPause mode client-side physics is paused when the player
+  doesn't have the minimum radius present, and resumed when the minimum radius
+  is available.
+
+  See also:
+
+  - `Class.Workspace.StreamingEnabled`, controls whether network streaming is
+    enabled for the place or not
+  - `Class.Workspace.StreamingMinRadius`, the minimum distance that parts will
+    be streamed to players with high priority
+  - `Class.Workspace.StreamingTargetRadius`, the maximum distance that parts
+    will be streamed to players
+code_samples: []
+tags: []
+deprecation_message: |
+  Please use `Class.Workspace.StreamingIntegrityMode` instead.
+items:
+  - name: Default
+    summary: |
+      Default behavior (currently no change to gameplay).
+    value: 0
+    tags:
+      - Deprecated
+    deprecation_message: ''
+  - name: Disabled
+    summary: |
+      No change to gameplay due to streaming region availability.
+    value: 1
+    tags:
+      - Deprecated
+    deprecation_message: ''
+  - name: ClientPhysicsPause
+    summary: |
+      Client owned physics is paused.
+    value: 2
+    tags:
+      - Deprecated
+    deprecation_message: ''