logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityLeaderboardSettings

    ScriptableObject configuration for the Unity Leaderboard service: which boards exist, how player identity is resolved, and which backend they persist through.

    Inheritance
    object
    UnityLeaderboardSettings
    Implements
    ILeaderboardSettings
    IFoundationSettings
    Namespace: Serenity.Leaderboard.Infrastructure.Settings
    Assembly: Serenity.UnityLeaderboard.Infrastructure.dll
    Syntax
    public class UnityLeaderboardSettings : ScriptableObject, ILeaderboardSettings, IFoundationSettings

    Constructors

    UnityLeaderboardSettings()

    Declaration
    public UnityLeaderboardSettings()

    Fields

    Backend

    Declaration
    public UnityStructuredBackendDefinition Backend
    Field Value
    Type Description
    UnityStructuredBackendDefinition

    Backend selection: a shared, consumer-agnostic UnityStructuredBackendDefinition asset whose concrete type picks the store (create one under Assets ▸ Create ▸ Serenity ▸ Persistence ▸ Backends). Left unassigned, boards persist through the device's PlayerPrefs key-value store.

    Boards

    Declaration
    public LeaderboardBoardSetting[] Boards
    Field Value
    Type Description
    LeaderboardBoardSetting[]

    The configured boards.

    DefaultDisplayName

    Declaration
    public string DefaultDisplayName
    Field Value
    Type Description
    string

    The display name used when no player-specific display name is available.

    Guid

    Declaration
    public string Guid
    Field Value
    Type Description
    string

    GUID for this settings asset.

    Id

    Declaration
    public string Id
    Field Value
    Type Description
    string

    Unique identifier for this settings asset.

    IdentitySource

    Declaration
    public PlayerIdentitySource IdentitySource
    Field Value
    Type Description
    PlayerIdentitySource

    Where a player's identity for leaderboard purposes comes from.

    TableOrCollectionName

    Declaration
    public string TableOrCollectionName
    Field Value
    Type Description
    string

    Table or collection name storing leaderboard entries. Blank falls back to DefaultTableName.

    Implements

    ILeaderboardSettings
    IFoundationSettings
    In this article
    © 2026 Serenity. All Rights Reserved