Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SerializationService

Serializes and deserializes instances to and from the .rbxm format.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service]

Member index 2

HistoryMember
668DeserializeInstancesAsync(buffer: buffer): Instances
668SerializeInstancesAsync(inputInstances: Instances): buffer
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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.

History 3

Members 2

DeserializeInstancesAsync

Parameters (1)
bufferbuffer
Returns (1)
Instances

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.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

SerializeInstancesAsync

Parameters (1)
inputInstancesInstances
Returns (1)
buffer

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.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

Settings