Skip to content
T1KTheOneKit

t1k:unity:tof:leaderboard

FieldValue
Moduletof
Version2.2.2
Effortmedium
Tools—

Keywords: leaderboard, ranking, scoreboard, social

How to invoke

Section titled “How to invoke”
/t1k:unity:tof:leaderboard

Leaderboard

Section titled “Leaderboard”

Purpose

Section titled “Purpose”

Core implementation of leaderboard core feature for Unity games

Public API

Section titled “Public API”

interface

  • ILeaderboardService (ILeaderboardService.cs) class
  • DummyLeaderboardService (DummyLeaderboardService.cs)
  • LeaderboardConfig (LeaderboardConfig.cs)
  • LeaderboardCoreValidator (LeaderboardCoreValidator.cs)
  • LeaderboardVContainer (LeaderboardVContainer.cs)
  • PassedLevelsTracker (PassedLevelsTracker.cs)
  • PassedLevelsTrackerVContainer (PassedLevelsTrackerVContainer.cs)
  • PlayerLeaderboardEntry (PlayerLeaderboardEntry.cs)
  • PlayerLeaderboardEntryView (PlayerLeaderboardEntryView.cs)
  • PositionColorView (PositionColorView.cs)
  • PositionObjectView (PositionObjectView.cs)
  • PositionTextView (PositionTextView.cs)
  • PositionView (PositionView.cs)
  • ScoreTextView (ScoreTextView.cs)
  • ScoreView (ScoreView.cs)

Signals / Events

Section titled “Signals / Events”

None detected.

Config / ScriptableObjects

Section titled “Config / ScriptableObjects”

None detected.

Integration Steps

Section titled “Integration Steps”
  1. Reference package TheOneFeature in your project.
  2. Register the Leaderboard services via VContainer (see Architecture).
  3. Configure any ScriptableObjects listed in Config section.
  4. Subscribe to signals listed in Signals / Events to react to state changes.

Architecture

Section titled “Architecture”

Detected public types (16): interface

  • ILeaderboardService (ILeaderboardService.cs) class
  • DummyLeaderboardService (DummyLeaderboardService.cs)
  • LeaderboardConfig (LeaderboardConfig.cs)
  • LeaderboardCoreValidator (LeaderboardCoreValidator.cs)
  • LeaderboardVContainer (LeaderboardVContainer.cs)
  • PassedLevelsTracker (PassedLevelsTracker.cs)
  • PassedLevelsTrackerVContainer (PassedLevelsTrackerVContainer.cs)
  • PlayerLeaderboardEntry (PlayerLeaderboardEntry.cs)
  • PlayerLeaderboardEntryView (PlayerLeaderboardEntryView.cs)
  • PositionColorView (PositionColorView.cs)
  • PositionObjectView (PositionObjectView.cs)
  • PositionTextView (PositionTextView.cs)
  • PositionView (PositionView.cs)
  • ScoreTextView (ScoreTextView.cs)
  • ScoreView (ScoreView.cs) enum
  • HighScoreType (HighScoreType.cs)

Detected DI registrations:

  • DummyLeaderboardService
  • LeaderboardConfig
  • PassedLevelsTracker

Dependencies

Section titled “Dependencies”

Run with FEATURE_MATRIX/DEPENDENCY_GRAPH integration to fill.

Gotchas

Section titled “Gotchas”

(None reported yet — open an issue in The1Studio/theonekit-unity if you hit one.)

References

Section titled “References”
  • Source: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Leaderboard/
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Leaderboard/Core/README.md
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Leaderboard/PassedLevelsTracker/README.md
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Leaderboard/Core/CHANGELOG.md
  • Doc: UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/Leaderboard/PassedLevelsTracker/CHANGELOG.md
  • Namespace: TheOne.Features.Leaderboard.Core.DI, TheOne.Features.Leaderboard.Core.Models.Configs, TheOne.Features.Leaderboard.Core.Models, TheOne.Features.Leaderboard.Core.Services, TheOne.Features.Leaderboard.Core.Views, TheOne.Features.Leaderboard.Core.Views.Score, TheOne.Features.Leaderboard.PassedLevelsTracker.DI, TheOne.Features.Leaderboard.Editor, TheOne.Features.Leaderboard.PassedLevelsTracker.Models.LocalData, TheOne.Features.Leaderboard.PassedLevelsTracker.Services