StreamingIntegrityMode
Determines how a user's client should handle not having enough content streamed in.
Items 4
| History | Name | Value | Description | |
|---|---|---|---|---|
| 541 | Default | 0 | Default behavior (currently equivalent to Disabled). | |
| 541 | Disabled | 1 | Simulation of the replication focus is never paused, regardless of the amount of content streamed in on the client. | |
| 541 | MinimumRadiusPause | 2 | All client-side simulation is paused when content is not streamed in up to the minimum radius. | |
| 548 | PauseOutsideLoadedArea | 3 | Simulation of the replication focus is paused when any part of its bounding box is not in a streamed-in area. |
Description
This enum is used to control Workspace.StreamingIntegrityMode behavior. The default behavior is currently equivalent to Disabled but may change in the future. For all modes, the replication focus defaults to be the local character model unless explicitly set via Player.ReplicationFocus.
Most experiences should use PauseOutsideLoadedArea, however if your experience relies on raycasts, or otherwise requires a certain amount of content to be loaded in, then MinimumRadiusPause might be a better choice.
Note that MinimumRadiusPause and PauseOutsideLoadedArea both set the Player.GameplayPaused property when their respective pause logic is triggered, and a default message is displayed on the client. The default pause UI can be overridden as outlined in Instance Streaming.
History 5
- 548 Add PauseOutsideLoadedArea
- 541 Add MinimumRadiusPause
- 541 Add Disabled
- 541 Add Default
- 541 Add StreamingIntegrityMode