logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class LeaderboardBoardSetting

    Inspector row describing a single leaderboard board configuration.

    Inheritance
    object
    LeaderboardBoardSetting
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.Leaderboard.Infrastructure.Settings
    Assembly: Serenity.UnityLeaderboard.Infrastructure.dll
    Syntax
    public class LeaderboardBoardSetting

    Constructors

    LeaderboardBoardSetting()

    Declaration
    public LeaderboardBoardSetting()

    Fields

    BoardId

    Declaration
    public string BoardId
    Field Value
    Type Description
    string

    The unique string identifier for this board.

    Direction

    Declaration
    public LeaderboardSortDirection Direction
    Field Value
    Type Description
    LeaderboardSortDirection

    The ordering used to rank entries on this board.

    DisplayName

    Declaration
    public string DisplayName
    Field Value
    Type Description
    string

    The display name for this board.

    MaxEntries

    Declaration
    public int MaxEntries
    Field Value
    Type Description
    int

    The maximum number of entries kept for this board. Zero means unbounded.

    RetentionMode

    Declaration
    public LeaderboardRetentionMode RetentionMode
    Field Value
    Type Description
    LeaderboardRetentionMode

    How this board retains submitted entries.

    SourceScoreKey

    Declaration
    public string SourceScoreKey
    Field Value
    Type Description
    string

    The key of the score metric this board is fed from.

    In this article
    © 2026 Serenity. All Rights Reserved