Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DraftsService

A Studio service that manages script drafts in a Team Create session with collaborative editing enabled.

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.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 16

HistoryMember
648CommitEdits(scripts: Instances): null
648DiscardEdits(scripts: Instances): null
462GetDraftStatus(script: Instance): DraftStatusCode
648GetDrafts(): Instances
648GetEditors(script: Instance): Instances
648RestoreScripts(scripts: Instances): null
648ShowDiffsAgainstBase(scripts: Instances): null
648ShowDiffsAgainstServer(scripts: Instances): null
648ShowSourceDiffsAgainstCurrent(sources: Array, scripts: Instances): null
648UpdateToLatestVersion(scripts: Instances): null
462CommitStatusChanged(script: Instance, status: DraftStatusCode)
462DraftAdded(script: Instance)
462DraftRemoved(script: Instance)
462DraftStatusChanged(script: Instance)
462EditorsListChanged(script: Instance)
462UpdateStatusChanged(script: Instance, status: DraftStatusCode)
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Removed member index 6

HistoryMember
398OpenDrafts(scripts: Objects): void
397DraftDeleted(script: Instance)
399DraftOutdatedStateChanged(script: Instance, outdated: bool)
397ScriptDeleted(script: Instance)
398ScriptRemoved(script: Instance)
398ScriptServerVersionChanged(script: Instance)

Description

DraftsService backs the collaborative editing "drafts" workflow in a Team Create session. When collaborative editing is enabled, a collaborator's changes to a Script, LocalScript, or ModuleScript are kept as a local draft rather than being applied to the shared session copy immediately, and a draft must be committed before other collaborators receive it.

The service exposes the operations behind Studio's Drafts interface. GetDrafts() enumerates the current drafts, GetDraftStatus() reports a draft's status, and GetEditors() lists the collaborators editing a given script. CommitEdits() and DiscardEdits() publish or drop changes; RestoreScripts() and UpdateToLatestVersion() reconcile local drafts with the server; and ShowDiffsAgainstBase() and ShowDiffsAgainstServer() open diff views. Events including DraftAdded, DraftRemoved, DraftStatusChanged, and EditorsListChanged fire as drafts and their editors change.

DraftsService is a Studio-only service; retrieve it with game:GetService("DraftsService").

History 75

Members 16

CommitEdits

Parameters (1)
scriptsInstances
Returns (1)
null
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

Tags: [Yields]

CommitStatusChanged

Parameters (2)
scriptInstance
statusDraftStatusCode
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

DiscardEdits

Parameters (1)
scriptsInstances
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

DraftAdded

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

DraftRemoved

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

DraftStatusChanged

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

EditorsListChanged

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

GetDraftStatus

Parameters (1)
scriptInstance
Returns (1)
DraftStatusCode
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

GetDrafts

Parameters (0)
No parameters.
Returns (1)
Instances
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

Tags: [Yields]

GetEditors

Parameters (1)
scriptInstance
Returns (1)
Instances
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

RestoreScripts

Parameters (1)
scriptsInstances
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

ShowDiffsAgainstBase

Parameters (1)
scriptsInstances
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

ShowDiffsAgainstServer

Parameters (1)
scriptsInstances
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 5

ShowSourceDiffsAgainstCurrent

Parameters (2)
sourcesArray
scriptsInstances
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

UpdateStatusChanged

Parameters (2)
scriptInstance
statusDraftStatusCode
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

UpdateToLatestVersion

Parameters (1)
scriptsInstances
Returns (1)
null
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 6

Tags: [Yields]

Removed members 6

DraftDeleted

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity

History 3

DraftOutdatedStateChanged

Parameters (2)
scriptInstance
outdatedbool
SecurityRobloxScriptSecurity

History 2

OpenDrafts

Parameters (1)
scriptsObjects
Returns (1)
void
SecurityRobloxScriptSecurity

History 3

ScriptDeleted

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity

History 3

ScriptRemoved

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity

History 2

ScriptServerVersionChanged

Parameters (1)
scriptInstance
SecurityRobloxScriptSecurity

History 3

Settings