DraftsService¶
A Studio service that manages script drafts in a Team Create session with collaborative editing enabled.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
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").
Inheritance¶
Object → Instance → DraftsService
Methods¶
| Member | Signature | Summary |
|---|---|---|
CommitEdits |
DraftsService:CommitEdits(scripts: Instances): null |
— |
DiscardEdits |
DraftsService:DiscardEdits(scripts: Instances): null |
— |
GetDrafts |
DraftsService:GetDrafts(): Instances |
— |
GetDraftStatus |
DraftsService:GetDraftStatus(script: Instance): DraftStatusCode |
— |
GetEditors |
DraftsService:GetEditors(script: Instance): Instances |
— |
RestoreScripts |
DraftsService:RestoreScripts(scripts: Instances): null |
— |
ShowDiffsAgainstBase |
DraftsService:ShowDiffsAgainstBase(scripts: Instances): null |
— |
ShowDiffsAgainstServer |
DraftsService:ShowDiffsAgainstServer(scripts: Instances): null |
— |
ShowSourceDiffsAgainstCurrent |
DraftsService:ShowSourceDiffsAgainstCurrent(sources: Array, scripts: Instances): null |
— |
UpdateToLatestVersion |
DraftsService:UpdateToLatestVersion(scripts: Instances): null |
— |
Events¶
| Member | Signature | Summary |
|---|---|---|
CommitStatusChanged |
CommitStatusChanged(script: Instance, status: DraftStatusCode) |
— |
DraftAdded |
DraftAdded(script: Instance) |
— |
DraftRemoved |
DraftRemoved(script: Instance) |
— |
DraftStatusChanged |
DraftStatusChanged(script: Instance) |
— |
EditorsListChanged |
EditorsListChanged(script: Instance) |
— |
UpdateStatusChanged |
UpdateStatusChanged(script: Instance, status: DraftStatusCode) |
— |
Roblox reference: DraftsService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.