# `GameServer.Leaderboards.Leaderboard`
[🔗](https://github.com/appsinacup/game_server/blob/v1.0.26/lib/game_server/leaderboards/leaderboard.ex#L1)

Leaderboard struct from GameServer.

This is a stub module for SDK type definitions. The actual struct
is provided by GameServer at runtime.

## Fields

- `id` - Leaderboard ID (integer)
- `slug` - URL-friendly identifier that can be reused across seasons (string)
- `title` - Display title (string)
- `description` - Optional description (string)
- `sort_order` - `:desc` (higher is better) or `:asc` (lower is better)
- `operator` - Score update mode: `:set`, `:best`, `:incr`, `:decr`
- `starts_at` - Optional start time (DateTime)
- `ends_at` - Optional end time (DateTime)
- `metadata` - Arbitrary metadata (map)
- `inserted_at` - Creation timestamp
- `updated_at` - Last update timestamp

# `operator`

```elixir
@type operator() :: :set | :best | :incr | :decr
```

# `sort_order`

```elixir
@type sort_order() :: :desc | :asc
```

# `t`

```elixir
@type t() :: %GameServer.Leaderboards.Leaderboard{
  description: String.t() | nil,
  ends_at: DateTime.t() | nil,
  id: integer(),
  inserted_at: DateTime.t(),
  metadata: map(),
  operator: operator(),
  slug: String.t(),
  sort_order: sort_order(),
  starts_at: DateTime.t() | nil,
  title: String.t(),
  updated_at: DateTime.t()
}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*