PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference

StreamingPauseMode

Hide content
  1. API Reference
  2. Enum Index

StreamingPauseMode

The StreamingPauseMode enum is used to control 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

  • Workspace/StreamingEnabled, controls whether network streaming is enabled for the place or not
  • Workspace/StreamingMinRadius, the minimum distance that parts will be streamed to players with high priority
  • Workspace/StreamingTargetRadius, the maximum distance that parts will be streamed to players

Enums

Name Value Description

Default

 0

Default behavior (currently no change to gameplay)

Disabled

 1

No change to gameplay due to streaming region availability

ClientPhysicsPause

 2

Client owned physics is paused

Referenced by:

  • Workspace/StreamingPauseMode