Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PackageService

Manages Roblox Studio packages, tracking their metadata and versions and handling updates to package contents.

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 7

HistoryMember
734GetOverrides(scopeRoot: Instance): DataModelDiff
742RevertAttributeOverridesAsync(scopeRoot: Instance, identities: Array, attributeNames: Array): null
742RevertInstanceOverridesAsync(scopeRoot: Instance, identities: Array): null
742RevertPropertyOverridesAsync(scopeRoot: Instance, identities: Array, propertyNames: Array): null
722UpdateAsync(packageRoot: Instance, version: int64 = 0): Instance
734OverrideStateChanged(scopeRoot: Instance, identity: ScopedInstanceIdentity, changeType: DataModelChangeType, propertyNames: Array)
734OverridesCleared(scopeRoot: Instance, identity: ScopedInstanceIdentity)
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)

Description

PackageService manages packages in Roblox Studio. A package is a reusable asset built from an instance tree that keeps a link back to its source asset so changes can be published to and pulled from every place that uses it.

The service tracks lightweight metadata for each package, including its latest published version number, the creator's identity, and the current user's access permissions. It also drives operations on package contents: requesting and loading a package's instances, checking whether a package has been modified relative to its published version, and updating a package tree to a newer version or reverting it to its published state.

History 8

Members 7

GetOverrides

Parameters (1)
scopeRootInstance
Returns (1)
DataModelDiff
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

OverrideStateChanged

Parameters (4)
scopeRootInstance
identityScopedInstanceIdentity
changeTypeDataModelChangeType
propertyNamesArray
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

OverridesCleared

Parameters (2)
scopeRootInstance
identityScopedInstanceIdentity
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

RevertAttributeOverridesAsync

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

History 1

Tags: [Yields]

RevertInstanceOverridesAsync

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

History 1

Tags: [Yields]

RevertPropertyOverridesAsync

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

History 1

Tags: [Yields]

UpdateAsync

Parameters (2)Default
packageRootInstance
versionint640
Returns (1)
Instance
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Tags: [Yields]

Settings