Class CompanionPackage

Namespace

Stride.Core.Assets

Assembly

Stride.Core.Assets.dll

A package a host loads on behalf of the package declaring it (CompanionPackages); the game never references it.

[DataContract("CompanionPackage")]
public sealed class CompanionPackage

Inheritance

object

CompanionPackage

Extension Methods

UnsafeUtilities.As<T>(object?)

Properties

Kind

What the companion carries, copied from its own declaration.

[DataMember(2)]
public PackageKind Kind { get; set; }

Property Value

PackageKind

Name

Package id of the companion.

[DataMember(0)]
public string? Name { get; set; }

Property Value

string

Project

The companion's project, known when the declaring package comes from a project or its build manifest.

public UFile? Project { get; set; }

Property Value

UFile

Replaces

Companion packages declared elsewhere in the session that this one replaces; they are not loaded.

[DataMember(3)]
public List<string> Replaces { get; }

Property Value

List<string>

Toolkit

The UI toolkit of an Editor companion's views (Wpf); null for a toolkit-neutral one.

[DataMember(4)]
public string? Toolkit { get; set; }

Property Value

string

Version

Version the declaring package was packed with; the declaring package's own version when unset.

[DataMember(1)]
public PackageVersion? Version { get; set; }

Property Value

PackageVersion

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.