Class
PackageLink
NotCreatableNotBrowsable
Links a DataModel instance to a corresponding asset in the cloud.
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.
Properties 10#
AutoUpdateboolean | When this property is set to true, the package associated with the given
PackageLink automatically updates to the latest version.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe |
Creatorstring | The creator of the package asset.ReadSafeReadOnlyNotReplicatedNotScriptable |
DefaultNamestring | Engine-managed name of the package's root instance as it was last published, kept as a baseline for detecting local name changes.Write: NotAccessibleSecurityReadSafe |
PackageAssetNamestring | The asset name of the package.ReadSafeReadOnlyNotReplicatedNotScriptable |
PackageContentContent | Read-only Content URL for the model asset backing this package.ReadSafeReadOnlyNotReplicated |
PackageIdContentId | The ID of the asset this package corresponds to.ReadSafeReadOnlyNotReplicated |
PermissionLevelPackagePermission | The package permission for the current Studio user.ReadSafeReadOnlyNotReplicatedNotScriptable |
SerializedDefaultAttributesBinaryString | 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.Write: NotAccessibleSecurityReadSafe |
Statusstring | The status of the package.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafeReadOnlyNotReplicated |
VersionNumberint64 | Refers to a revision of a specific package.Write: NotAccessibleSecurityReadSafeNotReplicated |
AutoUpdate: boolean#
Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe
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.
Creator: string#
ReadOnlyNotReplicatedNotScriptableReadSafe
The creator of the package asset.
DefaultName: string#
Write: NotAccessibleSecurityReadSafe
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.
PackageAssetName: string#
ReadOnlyNotReplicatedNotScriptableReadSafe
The asset name of the package.
PackageContent: Content#
ReadOnlyNotReplicatedReadSafe
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.
PackageId: ContentId#
ReadOnlyNotReplicatedReadSafe
The ID of the asset this package corresponds to.
PermissionLevel: PackagePermission#
ReadOnlyNotReplicatedNotScriptableReadSafe
The package permission for the current Studio user.
SerializedDefaultAttributes: BinaryString#
Write: NotAccessibleSecurityReadSafe
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.
Status: string#
ReadOnlyNotReplicatedRead: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe
The status of the package. It can be one of the following statuses: Up To Date, Changed, New Version Available, Changed + New Version Available.
VersionNumber: int64#
NotReplicatedWrite: NotAccessibleSecurityReadSafe
This property refers to a revision of a specific package
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild