GameServer.Groups.Group (game_server_sdk v1.0.1077)

Copy Markdown View Source

Group struct from GameServer.

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

Fields

  • id - Group ID (integer)
  • title - Group title (string)
  • description - Group description (string)
  • icon_url - Optional icon URL; nil means clients show their type default
  • type - Group type: "public", "private", or "hidden" (string)
  • max_members - Maximum number of members (integer, default 100)
  • metadata - Arbitrary group metadata (map)
  • slowdown - Rate-limit slowdown in milliseconds (integer, default 0)
  • creator_id - ID of the user who created the group (integer)
  • inserted_at - Creation timestamp
  • updated_at - Last update timestamp

Summary

Types

t()

Types

t()

@type t() :: %GameServer.Groups.Group{
  creator_id: integer(),
  description: String.t(),
  icon_url: String.t() | nil,
  id: integer(),
  inserted_at: DateTime.t(),
  max_members: integer(),
  metadata: map(),
  slowdown: integer(),
  title: String.t(),
  type: String.t(),
  updated_at: DateTime.t()
}