Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
PackageLink
Inherits from: Instance → Object
The purpose of the PackageLink object is to link a DataModel instance to a corresponding asset in the cloud. This improves flows for collaboration, version control, and sharing for models. The PackageLink instance will be a child of the root of the entire package hierarchy.
PackageLinks are not creatable through Scripts. They can only be added through interaction with Studio and can only be parented to Instances that can be published independently of DataModel publish. The PackageLink instance will always be the first child shown in the tree view, regardless of sorting.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, NotBrowsable
Properties
| Name | Type / Returns | Description |
|---|---|---|
| PackageLink.AutoUpdate | boolean | When this property is set to true, the package associated with the given PackageLink automatically updates to the latest version. |
| PackageLink.Creator | string | The creator of the package asset. |
| PackageLink.DefaultName | string | Engine-managed name of the package's root instance as it was last published, kept as a baseline for detecting local name changes. |
| PackageLink.PackageAssetName | string | The asset name of the package. |
| PackageLink.PackageContent | Content | Read-only Content URL for the model asset backing this package. |
| PackageLink.PackageId | ContentId | The ID of the asset this package corresponds to. |
| PackageLink.PermissionLevel | PackagePermission | The package permission for the current Studio user. |
| PackageLink.SerializedDefaultAttributes | BinaryString | Engine-managed serialized snapshot of the attributes on the package's root instance as it was last published, kept as a baseline for detecting local attribute changes. |
| PackageLink.Status | string | The status of the package. |
| PackageLink.VersionNumber | int64 | Refers to a revision of a specific package. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
PackageLink.AutoUpdate
When this property is set to true, the package associated with the given PackageLink will be automatically updated to the latest version. By default, this property is false upon creation of a package.
This property lets you decide if a given package should be automatically updated to the latest version when entering a given place. The game periodically checks for new updates while a place is open.
This property is visible and configurable in the Properties window in Studio.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Link |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AssetRead"] |
PackageLink.Creator
The creator of the package asset.
| Field | Value |
|---|---|
| type | string |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["AssetRead"] |
PackageLink.DefaultName
Managed by the engine and not writable from scripts. Stores the name of the package's root instance as recorded when the package was last published or synced. It defaults to an empty string and is populated from the base root node's name.
This value is the as-published baseline the engine compares against the current instance name to detect local name customizations and preserve them during a three-way merge when the package is updated.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"NotAccessibleSecurity"} |
| thread safety | ReadSafe |
| category | Link |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AssetRead"] |
PackageLink.PackageAssetName
The asset name of the package.
| Field | Value |
|---|---|
| type | string |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["AssetRead"] |
PackageLink.PackageContent
A read-only Content that references the package's model asset. The value is the same asset that PackageLink.PackageId points to, expressed as a Content URL rather than a ContentId string. This property cannot be written from a Script.
| Field | Value |
|---|---|
| type | Content |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Link |
| serialization | {"can_load":false,"can_save":true} |
| capabilities | ["AssetRead"] |
PackageLink.PackageId
The ID of the asset this package corresponds to.
| Field | Value |
|---|---|
| type | ContentId |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Link |
| serialization | {"can_load":false,"can_save":true} |
| capabilities | ["AssetRead"] |
PackageLink.PermissionLevel
The package permission for the current Studio user.
| Field | Value |
|---|---|
| type | PackagePermission |
| tags | ["ReadOnly","NotReplicated","NotScriptable"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["AssetRead"] |
PackageLink.SerializedDefaultAttributes
Managed by the engine and not writable from scripts. Stores a serialized (binary) snapshot of the attributes on the package's root instance as recorded when the package was last published or synced. It defaults to an empty value and is populated from the base root node's serialized attributes.
This snapshot is the as-published baseline for a three-way merge: the engine compares the root instance's current attributes against it to preserve local customizations when the package is updated.
| Field | Value |
|---|---|
| type | BinaryString |
| security | {"read":"None","write":"NotAccessibleSecurity"} |
| thread safety | ReadSafe |
| category | Link |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["AssetRead"] |
PackageLink.Status
The status of the package. It can be one of the following statuses: Up To Date, Changed, New Version Available, Changed + New Version Available.
| Field | Value |
|---|---|
| type | string |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"} |
| thread safety | ReadSafe |
| category | Link |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["AssetRead"] |
PackageLink.VersionNumber
This property refers to a revision of a specific package
| Field | Value |
|---|---|
| type | int64 |
| tags | ["NotReplicated"] |
| security | {"read":"None","write":"NotAccessibleSecurity"} |
| thread safety | ReadSafe |
| category | Link |
| serialization | {"can_load":true,"can_save":false} |
| capabilities | ["AssetRead"] |
Methods
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |