PackageLink
Links a DataModel instance to a corresponding asset in the cloud.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is not browsable. It is not visible in Studio's object browser.
| Memory category | Instances |
|---|
Member index 12
Removed member index 8
| History | Member | |
|---|---|---|
| 544 | Package Id: Content | |
| 544 | Version Number: int64 | |
| 354 | VersionId: int64 |
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.
History 77
- 726 Change Default of VersionNumber from 0 to
- 726 Remove
- 726 Change Default of Status from Up To Date to
- 726 Change Default of PermissionLevel from None to
- 726 Remove
- 726 Remove
- 726 Remove
- 726 Change Default of PackageContent from to
- 726 Change Default of from 0 to
- 726 Change Default of from false to
- 726 Remove
- 726 Change Default of AutoUpdate from false to
- 725 Add
- 725 Add PackageContent
- 656 Change Tags of from [Hidden, ReadOnly, NotReplicated] to [Hidden, NotReplicated]
- 649 Change WriteSecurity of from None to RobloxScriptSecurity
- 649 Change Tags of from [Hidden, NotScriptable] to [Hidden]
- 649 Change ReadSecurity of from None to RobloxScriptSecurity
- 649 Add
- 649 Change WriteSecurity of AutoUpdate from None to RobloxScriptSecurity
- 649 Change Tags of AutoUpdate from [NotScriptable] to []
- 649 Change ReadSecurity of AutoUpdate from None to RobloxScriptSecurity
- 645 Change ValueType of from Content to ContentId
- 645 Change ValueType of PackageId from Content to ContentId
- 601 Add SerializedDefaultAttributes
- 601 Add DefaultName
- 553 Change Default of VersionNumber from to 0
- 553 Add
- 553 Change Default of Status from to Up To Date
- 553 Change Default of PermissionLevel from to None
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 553 Change Default of AutoUpdate from to false
- 544 Change Tags of VersionNumber from [Hidden, NotReplicated] to [NotReplicated]
- 544 Change CanLoad of VersionNumber from false to true
- 544 Remove Version Number
- 544 Change Tags of PackageId from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 544 Remove Package Id
- 532 Change Tags of VersionNumber from [NotReplicated] to [Hidden, NotReplicated]
- 532 Change CanLoad of VersionNumber from true to false
- 532 Add Version Number
- 532 Change Tags of PackageId from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
- 532 Add Package Id
- 486 Change ThreadSafety of VersionNumber from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Status from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PermissionLevel from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PackageId from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PackageAssetName from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Creator from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AutoUpdate from ReadOnly to ReadSafe
- 470 Add PermissionLevel
- 470 Add PackageAssetName
- 470 Add Creator
- 462 Change ThreadSafety of VersionNumber from to ReadOnly
- 462 Change ThreadSafety of Status from to ReadOnly
- 462 Change ThreadSafety of PackageId from to ReadOnly
- 462 Change ThreadSafety of AutoUpdate from to ReadOnly
- 375 Change WriteSecurity of VersionNumber from None to NotAccessibleSecurity
- 375 Change Tags of VersionNumber from [ReadOnly, NotReplicated] to [NotReplicated]
- 375 Change CanSave of VersionNumber from true to false
- 375 Change CanLoad of VersionNumber from false to true
- 374 Add AutoUpdate
- 362 Change Tags of PackageLink from [NotCreatable] to [NotCreatable, NotBrowsable]
- 359 Add Status
- 354 Add VersionNumber
- 354 Remove VersionId
- 353 Change ValueType of VersionId from int to int64
- 353 Change ValueType of PackageId from int to Content
- 351 Add VersionId
- 351 Add PackageId
- 351 Add PackageLink
- 350 Remove PackageLink
- 351 Add VersionId
- 351 Add PackageId
- 351 Add PackageLink
Members 12
AutoUpdate
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Link |
| Loaded/Saved | true |
History 8
- 726 Change Default of AutoUpdate from false to
- 649 Change WriteSecurity of AutoUpdate from None to RobloxScriptSecurity
- 649 Change Tags of AutoUpdate from [NotScriptable] to []
- 649 Change ReadSecurity of AutoUpdate from None to RobloxScriptSecurity
- 553 Change Default of AutoUpdate from to false
- 486 Change ThreadSafety of AutoUpdate from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AutoUpdate from to ReadOnly
- 374 Add AutoUpdate
Creator
| Type | Default | |
|---|---|---|
| string | ||
The creator of the package asset.
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
DefaultName
| Type | Default | |
|---|---|---|
| string | ||
| Write security | NotAccessibleSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Link |
| Loaded/Saved | true |
History 1
- 601 Add DefaultName
PackageAssetName
| Type | Default | |
|---|---|---|
| string | ||
The asset name of the package.
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 2
- 486 Change ThreadSafety of PackageAssetName from ReadOnly to ReadSafe
- 470 Add PackageAssetName
PackageContent
| Type | Default | |
|---|---|---|
| Content | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Link |
| Loaded/Saved | false/true |
History 2
- 726 Change Default of PackageContent from to
- 725 Add PackageContent
PackageId
| Type | Default | |
|---|---|---|
| ContentId | ||
The ID of the asset this package corresponds to.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Link |
| Loaded/Saved | false/true |
History 9
- 645 Change ValueType of PackageId from Content to ContentId
- 544 Change Tags of PackageId from [Hidden, ReadOnly, NotReplicated] to [ReadOnly, NotReplicated]
- 532 Change Tags of PackageId from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated]
- 486 Change ThreadSafety of PackageId from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PackageId from to ReadOnly
- 353 Change ValueType of PackageId from int to Content
- 351 Add PackageId
- 350 Remove PackageLink
- 351 Add PackageId
PermissionLevel
| Type | Default | |
|---|---|---|
| PackagePermission | ||
The package permission for the current Studio user.
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 726 Change Default of PermissionLevel from None to
- 553 Change Default of PermissionLevel from to None
- 486 Change ThreadSafety of PermissionLevel from ReadOnly to ReadSafe
- 470 Add PermissionLevel
SerializedDefaultAttributes
| Type | Default | |
|---|---|---|
| BinaryString | ||
| Write security | NotAccessibleSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Link |
| Loaded/Saved | true |
History 1
Status
| Type | Default | |
|---|---|---|
| string | ||
The status of the package. It can be one of the following statuses: Up To Date, Changed, New Version Available, Changed + New Version Available.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Link |
| Loaded/Saved | false |
VersionNumber
| Type | Default | |
|---|---|---|
| int64 | ||
This property refers to a revision of a specific package
This property is not replicated. Its interface does not cross the network boundary.
| Write security | NotAccessibleSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Link |
| Loaded/Saved | true/false |
History 13
- 726 Change Default of VersionNumber from 0 to
- 553 Change Default of VersionNumber from to 0
- 544 Change Tags of VersionNumber from [Hidden, NotReplicated] to [NotReplicated]
- 544 Change CanLoad of VersionNumber from false to true
- 532 Change Tags of VersionNumber from [NotReplicated] to [Hidden, NotReplicated]
- 532 Change CanLoad of VersionNumber from true to false
- 486 Change ThreadSafety of VersionNumber from ReadOnly to ReadSafe
- 462 Change ThreadSafety of VersionNumber from to ReadOnly
- 375 Change WriteSecurity of VersionNumber from None to NotAccessibleSecurity
- 375 Change Tags of VersionNumber from [ReadOnly, NotReplicated] to [NotReplicated]
- 375 Change CanSave of VersionNumber from true to false
- 375 Change CanLoad of VersionNumber from false to true
- 354 Add VersionNumber
Removed members 8
Package Id
| Type | Default | |
|---|---|---|
| Content | ||
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Link |
| Loaded/Saved | false |
History 2
- 544 Remove Package Id
- 532 Add Package Id
Version Number
| Type | Default | |
|---|---|---|
| int64 | ||
This property is not scriptable. It cannot be accessed by script code.
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Link |
| Loaded/Saved | false |
History 2
- 544 Remove Version Number
- 532 Add Version Number
VersionId
| Type | Default | |
|---|---|---|
| int64 | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Category | Link |
|---|---|
| Loaded/Saved | false/true |