Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BranchService

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]

Member index 16

HistoryMember
737ArchiveBranchAsync(branchPlaceId: int64): null
737CompleteMerge(): null
737CreateBranchAsync(sourcePlaceId: int64, sourceVersionNumber: int64, name: string): Dictionary
737GetBranchesAsync(placeId: int64, archived: bool): Dictionary
737GetDiffAsync(placeId: int64, baseVersion: int64, targetVersion: int64): DataModelDiff
737GetInstanceConflicts(): Array
737GetMergeChanges(): DataModelDiff
737GetMergeResolution(identity: ScopedInstanceIdentity, propName: string?): MergeResolution
737GetMergeStatus(): MergeStatus
737RestoreBranchAsync(branchPlaceId: int64): null
737SetMergeResolution(identity: ScopedInstanceIdentity, propName: string?, resolution: MergeResolution): null
737StartMergeAsync(sourcePlaceId: int64, ancestorVersion: int64): null
737UpdateBranchAsync(branchPlaceId: int64, status: BranchStatus, name: string): Dictionary
737MergeStateChanged(identity: ScopedInstanceIdentity)
737MergeStateCleared(identity: ScopedInstanceIdentity)
737MergeStatusChanged(status: MergeStatus)
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

History 17

Members 16

ArchiveBranchAsync

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

History 1

Tags: [Yields]

CompleteMerge

Parameters (0)
No parameters.
Returns (1)
null

History 1

CreateBranchAsync

Parameters (3)
sourcePlaceIdint64
sourceVersionNumberint64
namestring
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetBranchesAsync

Parameters (2)
placeIdint64
archivedbool
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetDiffAsync

Parameters (3)
placeIdint64
baseVersionint64
targetVersionint64
Returns (1)
DataModelDiff
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetInstanceConflicts

Parameters (0)
No parameters.
Returns (1)
Array

History 1

GetMergeChanges

Parameters (0)
No parameters.
Returns (1)
DataModelDiff

History 1

GetMergeResolution

Parameters (2)
identityScopedInstanceIdentity
propNamestring?
Returns (1)
MergeResolution

History 1

GetMergeStatus

Parameters (0)
No parameters.
Returns (1)
MergeStatus

History 1

MergeStateChanged

Parameters (1)
identityScopedInstanceIdentity

History 1

MergeStateCleared

Parameters (1)
identityScopedInstanceIdentity

History 1

MergeStatusChanged

Parameters (1)
statusMergeStatus

History 1

RestoreBranchAsync

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

History 1

Tags: [Yields]

SetMergeResolution

Parameters (3)
identityScopedInstanceIdentity
propNamestring?
resolutionMergeResolution
Returns (1)
null

History 1

StartMergeAsync

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

History 1

Tags: [Yields]

UpdateBranchAsync

Parameters (3)
branchPlaceIdint64
statusBranchStatus
namestring
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

Settings