PackageLink

Show Deprecated
Not Creatable
Not Browsable

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.

PackageLink in Studio Explorer

In this case PackageLink designates Model to be the root of the Package hierarchy.

They 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.

Summary

Properties

When this property is set to true, the package associated with the given PackageLink automatically updates to the latest version.

NOT SCRIPTABLE

The creator of the package asset.

READ ONLY
NOT REPLICATED
NOT SCRIPTABLE

The asset name of the package.

READ ONLY
NOT REPLICATED
NOT SCRIPTABLE

The id of the asset this package corresponds to.

READ ONLY
NOT REPLICATED

The package permission for the current studio user.

READ ONLY
NOT REPLICATED
NOT SCRIPTABLE

The status of the package.

READ ONLY
NOT REPLICATED

Refers to a revision of a specific package.

NOT REPLICATED

Events

Methods

Properties

AutoUpdate

Not Scriptable

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.

Creator

Read Only
Not Replicated
Not Scriptable

The creator of the package asset.

PackageAssetName

Read Only
Not Replicated
Not Scriptable

The asset name of the package.

PackageId

Read Only
Not Replicated

The id of the asset this package corresponds to.

PermissionLevel

Read Only
Not Replicated
Not Scriptable

The package permission for the current Studio user.

Status

Read Only
Not Replicated

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

Not Replicated

This property refers to a revision of a specific package

Events

Methods