Reference API Roblox

Engine API

Website

Related

Reference API Roblox

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 categoryInstances
Tags: [NotCreatable, NotBrowsable]

Member index 15

HistoryMember
649AutoUpdate: bool
486Creator: string
601DefaultName: string
486PackageAssetName: string
645PackageId: ContentId
553PermissionLevel: PackagePermission
601SerializedDefaultAttributes: BinaryString
553Status: string
553VersionNumber: int64
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 3

HistoryMember
544Package Id: Content
544Version Number: int64
354VersionId: 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 63

Members 15

AutoUpdate

TypeDefault
boolfalse

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 will be false upon creation of a package.

This property would allows you to decide if a given package should be automatically updated to the latest version when entering a given place. The game will periodically check for new updates while a place is open.

SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryLink
Loaded/Savedtrue

History 7

Creator

TypeDefault
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 safetyReadSafe
CategoryData
Loaded/Savedfalse

History 2

Tags: [ReadOnly, NotReplicated, NotScriptable]

DefaultName

TypeDefault
string
Write securityNotAccessibleSecurity
Thread safetyReadSafe
CategoryLink
Loaded/Savedtrue

History 1

PackageAssetName

TypeDefault
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 safetyReadSafe
CategoryData
Loaded/Savedfalse

History 2

Tags: [ReadOnly, NotReplicated, NotScriptable]

PackageId

TypeDefault
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 safetyReadSafe
CategoryLink
Loaded/Savedfalse/true

History 9

Tags: [ReadOnly, NotReplicated]

PermissionLevel

TypeDefault
PackagePermissionNone

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 safetyReadSafe
CategoryData
Loaded/Savedfalse

History 3

Tags: [ReadOnly, NotReplicated, NotScriptable]

SerializedDefaultAttributes

TypeDefault
BinaryString
Write securityNotAccessibleSecurity
Thread safetyReadSafe
CategoryLink
Loaded/Savedtrue

History 1

Status

TypeDefault
stringUp To Date

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.
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryLink
Loaded/Savedfalse

History 4

Tags: [ReadOnly, NotReplicated]

VersionNumber

TypeDefault
int640

This property refers to a revision of a specific package

This property is not replicated. Its interface does not cross the network boundary.
Write securityNotAccessibleSecurity
Thread safetyReadSafe
CategoryLink
Loaded/Savedtrue/false

History 12

Tags: [NotReplicated]

Removed members 3

Package Id

TypeDefault
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 safetyReadSafe
CategoryLink
Loaded/Savedfalse

History 2

Tags: [ReadOnly, NotReplicated, NotScriptable]

Version Number

TypeDefault
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 safetyReadSafe
CategoryLink
Loaded/Savedfalse

History 2

Tags: [NotReplicated, NotScriptable]

VersionId

TypeDefault
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.
CategoryLink
Loaded/Savedfalse/true

History 5

Tags: [ReadOnly, NotReplicated]

Settings