mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
55 lines
2 KiB
YAML
55 lines
2 KiB
YAML
# 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: ModelStreamingMode
|
|
type: enum
|
|
summary: |
|
|
Controls stream in and out behavior of a model.
|
|
description: |
|
|
Controls how model is streamed in and out when used in an experience that is
|
|
streaming enabled. Has no effect when experience is not streaming enabled.
|
|
code_samples: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
items:
|
|
- name: Default
|
|
summary: |
|
|
Engine determines best behavior. Currently equivalent to **Nonatomic**.
|
|
value: 0
|
|
tags: []
|
|
deprecation_message: ''
|
|
- name: Atomic
|
|
summary: |
|
|
The `Class.Model` and all of its descendants are streamed in/out together.
|
|
For streaming in, this applies when **any** descendant `Class.BasePart` is
|
|
eligible for streaming in. For streaming out, this applies when **all**
|
|
descendant `Class.BasePart|BaseParts` are eligible for streaming out.
|
|
value: 1
|
|
tags: []
|
|
deprecation_message: ''
|
|
- name: Persistent
|
|
summary: |
|
|
Persistent models are sent as a complete atomic unit soon after the player
|
|
joins and before the `Class.Workspace.PersistentLoaded` event fires.
|
|
Persistent models and their descendants are never streamed out.
|
|
value: 2
|
|
tags: []
|
|
deprecation_message: ''
|
|
- name: PersistentPerPlayer
|
|
summary: |
|
|
Behaves as a persistent model for players that have been added using
|
|
`Class.Model:AddPersistentPlayer()`. For other players, behavior is the
|
|
same as **Atomic**. You can revert a model from player persistence via
|
|
`Class.Model:RemovePersistentPlayer()`.
|
|
value: 3
|
|
tags: []
|
|
deprecation_message: ''
|
|
- name: Nonatomic
|
|
summary: |
|
|
When a nonatomic model is streamed, descendants are also sent, except for
|
|
part descendants. Nonatomic models that are not descendants of parts are
|
|
sent during experience loading.
|
|
value: 4
|
|
tags: []
|
|
deprecation_message: ''
|