Reference API Roblox

Engine API

Website

Related

Reference API Roblox

StreamingService

This class is not replicated. Its interface does not cross the network boundary.
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.
Tags: [NotCreatable, Service, NotReplicated]

Member index 23

HistoryMember
649AttemptSaveAndSendPlaceTelemetry(requestId: string, toolSource: string): null
625BindCodeToGuid(runCodeGuid: string, code: string): Tuple
649DEPRECATED_RegisterCommand(commandName: string, function: Function = nil): null
649DEPRECATED_RegisterSequentialCommand(commandName: string, function: Function = nil): null
649ExecuteCommandAsync(requestId: string, commandName: string, arg: Variant): Variant
601GetEphemeralVariable(key: string): Variant
619GetInstance(requestId: string, instanceId: string): Instance
652GetRequiredScripts(script: Instance): Variant
601InvokeCommand(requestId: string, commandName: string, arg: Variant): null
649RegisterCommandInternal(commandName: string, function: Function = nil, isSequential: bool = false, isPublic: bool = false): null
591RegisterContextCollector(collectorName: string, function: Function = nil): null
625RunSandboxedCode(runCodeGuid: string, requestId: string): Tuple
651SearchForAssets(body: Variant): Variant
601SetEphemeralVariable(key: string, value: Variant, timeToLive: int = -1): null
602SetPluginInfoCallback(function: Function = nil): null
590UnregisterCommand(commandName: string): null
591UnregisterContextCollector(collectorName: string): null
616ConversationCleared()
591RequestEnded(requestId: string)
602RequestError(requestId: string, errorType: string, errorMessage: string)
601RequestStarted(requestId: string, queryToProcess: string)
601SequentialCommandsFinished(requestId: string, success: bool)
627Stream(requestId: string, commandName: string, streamContent: string)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: 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()
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)

Removed member index 2

HistoryMember
649RegisterCommand(commandName: string, function: Function = nil): null
649RegisterSequentialCommand(commandName: string, function: Function = nil): null

Description

History 38

Members 23

AttemptSaveAndSendPlaceTelemetry

Parameters (2)
requestIdstring
toolSourcestring
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

BindCodeToGuid

Parameters (2)
runCodeGuidstring
codestring
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

ConversationCleared

Parameters (0)
No parameters.

History 1

DEPRECATED_RegisterCommand

Parameters (2)Default
commandNamestring
functionFunctionnil
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

DEPRECATED_RegisterSequentialCommand

Parameters (2)Default
commandNamestring
functionFunctionnil
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

ExecuteCommandAsync

Parameters (3)
requestIdstring
commandNamestring
argVariant
Returns (1)
Variant
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

GetEphemeralVariable

Parameters (1)
keystring
Returns (1)
Variant

History 1

GetInstance

Parameters (2)
requestIdstring
instanceIdstring
Returns (1)
Instance

History 2

GetRequiredScripts

Parameters (1)
scriptInstance
Returns (1)
Variant
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

InvokeCommand

Parameters (3)
requestIdstring
commandNamestring
argVariant
Returns (1)
null

History 1

RegisterCommandInternal

Parameters (4)Default
commandNamestring
functionFunctionnil
isSequentialboolfalse
isPublicboolfalse
Returns (1)
null

History 1

RegisterContextCollector

Parameters (2)Default
collectorNamestring
functionFunctionnil
Returns (1)
null

History 1

RequestEnded

Parameters (1)
requestIdstring

History 1

RequestError

Parameters (3)
requestIdstring
errorTypestring
errorMessagestring

History 2

RequestStarted

Parameters (2)
requestIdstring
queryToProcessstring

History 2

RunSandboxedCode

Parameters (2)
runCodeGuidstring
requestIdstring
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

SearchForAssets

Parameters (1)
bodyVariant
Returns (1)
Variant
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

SequentialCommandsFinished

Parameters (2)
requestIdstring
successbool

History 1

SetEphemeralVariable

Parameters (3)Default
keystring
valueVariant
timeToLiveint-1
Returns (1)
null

History 1

SetPluginInfoCallback

Parameters (1)Default
functionFunctionnil
Returns (1)
null

History 1

Stream

Parameters (3)
requestIdstring
commandNamestring
streamContentstring

History 2

UnregisterCommand

Parameters (1)
commandNamestring
Returns (1)
null

History 1

UnregisterContextCollector

Parameters (1)
collectorNamestring
Returns (1)
null

History 1

Removed members 2

RegisterCommand

Parameters (2)Default
commandNamestring
functionFunctionnil
Returns (1)
null

History 2

RegisterSequentialCommand

Parameters (2)Default
commandNamestring
functionFunctionnil
Returns (1)
null

History 2

Settings