Class OnboardingSectionAttribute

Onboarding section metadata 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

Attribute.Equals(object)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetHashCode()

Attribute.IsDefaultAttribute()

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.Match(object)

Attribute.TypeId

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

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)

Creates a new instance of the attribute.

Declaration

public OnboardingSectionAttribute(OnboardingSectionCategory category, string id)

Parameters

Type	Name	Description
OnboardingSectionCategory	category	The section category.
string	id	The identifier.

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

HostingModelDependency

Optional: dependency on a certain hosting model choice.

Declaration

public SelectedSolutionsData.HostingModel HostingModelDependency { get; set; }

Property Value

Type	Description
SelectedSolutionsData.HostingModel

NetcodeDependency

Optional: dependency on a certain netcode choice.

Declaration

public SelectedSolutionsData.NetcodeSolution NetcodeDependency { get; set; }

Property Value

Type	Description
SelectedSolutionsData.NetcodeSolution

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