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

StreamingPauseMode

Workspace

StreamingPauseMode

If Workspace/StreamingEnabled is activated, a game may behave in unintended ways if a player somehow moves into a region of the world that hasn’t been streamed to them. The streaming pause feature helps manage this by pausing the local physical simulation and normal character movement if content within Workspace/StreamingMinRadius|StreamingMinRadius isn’t yet streamed in. Non-physical systems will continue to run (scripts will continue executing, for example) and gameplay will resume after the engine has loaded enough content to minimize further pauses.

To determine the pause status, you can utilize the Player/GameplayPaused property as outlined articles/content streaming#customizing-pause-screen|here.

For a detailed explanation of game content streaming, best practices, and implementation notes, see articles/content streaming|Game Content Streaming.

See Also

  • Workspace/StreamingEnabled which controls whether content streaming is enabled
  • Workspace/StreamingMinRadius
  • Workspace/StreamingTargetRadius