Class
SerializationService
NotCreatableService
Serializes and deserializes instances to and from the .rbxm
format.
SerializationService converts instances to and from
the binary .rbxm model format. Call
SerializeInstancesAsync()
to serialize a list of instances into a buffer of .rbxm content,
and
DeserializeInstancesAsync()
to reconstruct instances from such a buffer.
Usable only from Studio plugins or Open Cloud Luau Execution Sessions. Attempting to serialize or deserialize non-creatable instances or services throws an error.
No stability contract is offered for the .rbxm format; its composition may
change at any time. Content serialized by the engine can always be
deserialized by the engine, but parsing engine-generated .rbxm with
third-party tools, or deserializing .rbxm generated by other means, is at
the user's own risk.
Methods 2#
| DeserializeInstancesAsync | Deserializes a buffer containing .rbxm content, returning a
list of instances.Yields |
| SerializeInstancesAsync | Serializes a list of instances to the .rbxm format,
returning a buffer or .rbxm content.Yields |
DeserializeInstancesAsync(buffer: buffer): List<Instance>#
Yields
Deserializes a buffer containing .rbxm content, returning a
list of instances.
This API can only be called from Studio plugins or Open Cloud Luau Execution Sessions. If non-creatable instances or services are included in the content, an error is thrown.
No stability contract is offered for the .rbxm format and the
composition of this data may change at any time. This API will faithfully
parse .rbxm content that was serialized by the Roblox engine, including
.rbxm files generated by Studio or via
SerializeInstancesAsync().
Although it is possible to use this API to deserialize .rbxm content
generated by any other means, this is done at the user's own risk. The
engine may fail to deserialize such content faithfully, or at all.
| Name | Type | Default | Description |
|---|---|---|---|
buffer | buffer | A buffer containing the .rbxm content to deserialize. |
Returns
List<Instance>— A list of theinstancesreconstructed from the buffer's.rbxmcontent.
SerializeInstancesAsync(inputInstances: List<Instance>): buffer#
Yields
Serializes a list of instances to the .rbxm format,
returning a buffer or .rbxm content.
This API can only be called from Studio plugins or Open Cloud Luau Execution Sessions. If non-creatable instances or services are included in the list of instances, an error is thrown.
No stability contract is offered for the .rbxm format and the
composition of this data may change at any time. This API will serialize
content according to the serialization behavior of the current engine
version.
Although it is possible for other tools to parse .rbxm content, this is
done at the user's own risk. The engine may still generate .rbxm content
that 3rd-party tools fail to parse faithfully.
| Name | Type | Default | Description |
|---|---|---|---|
inputInstances | List<Instance> | The list of instances to serialize. |
Returns
buffer— Abuffercontaining the.rbxmcontent of the serialized instances.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild