PackageLink¶
Links a DataModel instance to a corresponding asset in the cloud.
Not implemented yet
The package system is not implemented.
Description¶
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.
Inheritance¶
Object → Instance → PackageLink
Properties¶
| Member | Signature | Summary |
|---|---|---|
AutoUpdate |
AutoUpdate: bool |
When this property is set to true, the package associated with the given PackageLink automatically updates to the latest version. |
CanAutoUpdate |
CanAutoUpdate: bool |
— |
Creator |
Creator: string |
The creator of the package asset. |
DefaultName |
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. |
HasNewVersion |
HasNewVersion: bool |
— |
ModifiedState |
ModifiedState: int |
— |
PackageAssetName |
PackageAssetName: string |
The asset name of the package. |
PackageContent |
PackageContent: Content |
Read-only Content URL for the model asset backing this package. |
PackageContentSerialize |
PackageContentSerialize: Content |
— |
PackageGuid |
PackageGuid: int64 |
— |
PackageId |
PackageId: ContentId |
The ID of the asset this package corresponds to. |
PackageIdSerialize |
PackageIdSerialize: ContentId |
— |
PermissionLevel |
PermissionLevel: PackagePermission |
The package permission for the current Studio user. |
SerializedDefaultAttributes |
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. |
Status |
Status: string |
The status of the package. |
VersionIdSerialize |
VersionIdSerialize: int64 |
— |
VersionNumber |
VersionNumber: int64 |
Refers to a revision of a specific package. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
getOverrides |
PackageLink:getOverrides(): DataModelDiff |
— |
Roblox reference: PackageLink
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.