Class OnboardingSectionAttribute

Onboarding section meta data to be picked up by the multiplayer center. This can only be used once per type. If you wish to make the same section appear in multiple categories/conditions, please create two types inheriting from the same base class.

Inheritance
object
Attribute
OnboardingSectionAttribute
Inherited Members
Namespace: Unity.Multiplayer.Center.Common
Assembly: Unity.Multiplayer.Center.Common.dll
Syntax
[AttributeUsage(AttributeTargets.All, Inherited = false, AllowMultiple = false)]
public sealed class OnboardingSectionAttribute : Attribute

Constructors

OnboardingSectionAttribute(OnboardingSectionCategory, string)

Declaration
public OnboardingSectionAttribute(OnboardingSectionCategory category, string id)
Parameters
Type Name Description
OnboardingSectionCategory category
string id

Fields

Id

The id of that section (defines uniqueness and whether priority should be used)

Declaration
public readonly string Id
Field Value
Type Description
string

Properties

Category

The UI category the section will fall into

Declaration
public OnboardingSectionCategory Category { get; }
Property Value
Type Description
OnboardingSectionCategory

DisplayCondition

Optional: condition to display the section. By default, if the type exists in the project, the section is shown.

Declaration
public DisplayCondition DisplayCondition { get; set; }
Property Value
Type Description
DisplayCondition

InfrastructureDependency

Optional: dependency on a certain infrastructure.

Declaration
public InfrastructureDependency InfrastructureDependency { get; set; }
Property Value
Type Description
InfrastructureDependency

Order

Optional: this is the order in which the sections will be displayed in the UI within the section (the higher, the further down)

Declaration
public int Order { get; set; }
Property Value
Type Description
int

Priority

Optional: priority in case several onboarding sections are defined for the same package/id. Use-case: new version of a package needs a different onboarding and overrides what we ship with the Multiplayer Center.

Declaration
public int Priority { get; set; }
Property Value
Type Description
int

TargetPackageId

Optional: the package Id that this section is related to, e.g. "com.unity.transport"

Declaration
public string TargetPackageId { get; set; }
Property Value
Type Description
string