Class AchievementViewAuthoring

The optional on-screen listing: whether a UnityAchievementsViewDefinition is authored alongside the settings, and what it says.

Inheritance

object

AchievementViewAuthoring

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Achievements.Infrastructure.Editor.Builder

Assembly: Serenity.UnityAchievements.Infrastructure.Editor.dll

Syntax

public sealed class AchievementViewAuthoring

Remarks

Only the fields a first authoring pass has to decide are here. Everything else the view definition carries — sort mode, filter, thumbnails, the points summary, the empty-state copy — keeps the definition's own documented defaults, which are the right answer for a project that has not decided otherwise yet and can be changed in the inspector afterwards.

Constructors

AchievementViewAuthoring()

Declaration

public AchievementViewAuthoring()

Fields

Create

Whether an achievements view definition is created alongside the settings.

Declaration

public bool Create

Field Value

Type	Description
bool

FolderPath

Folder the view definition lands in. Blank uses the run's target folder.

Declaration

public string FolderPath

Field Value

Type	Description
string

IsTranslatingOptionLabel

Whether OptionLabel is a localization key.

Declaration

public bool IsTranslatingOptionLabel

Field Value

Type	Description
bool

OptionLabel

Label the menu option renders.

Declaration

public string OptionLabel

Field Value

Type	Description
string

ReturnViewId

View id shown when the user cancels the achievements view. Never typed by the author: the wizard derives it from TargetMenu when a menu option is wired (cancel returns to the opener menu, with the ViewBrowser history entry popped), and leaves it blank otherwise (cancel simply hides the view). Mirrors CreateLeaderboardWindow.ResolveReturnViewId.

Declaration

public string ReturnViewId

Field Value

Type	Description
string

TargetMenu

The existing menu the option is added to.

Declaration

public UnityMenuSettingsDefinition TargetMenu

Field Value

Type	Description
UnityMenuSettingsDefinition

Title

Panel header text.

Declaration

public string Title

Field Value

Type	Description
string

ViewId

View id a menu option (or a ShowAchievementsSignal) transitions to. Also names the asset file.

Declaration

public string ViewId

Field Value

Type	Description
string

WireMenuOption

Whether an option that opens the view is added to TargetMenu.

Declaration

public bool WireMenuOption

Field Value

Type	Description
bool