View Source Teiserver.Game (Teiserver v0.0.4)

The contextual module for:

Summary

Lobby

add_client_to_lobby(user_id, lobby_id)

See Teiserver.Game.LobbyLib.add_client_to_lobby/2.

can_add_client_to_lobby(user_id, lobby_id)

See Teiserver.Game.LobbyLib.can_add_client_to_lobby/2.

can_add_client_to_lobby(user_id, lobby_id, password)

See Teiserver.Game.LobbyLib.can_add_client_to_lobby/3.

close_lobby(lobby_id)

See Teiserver.Game.LobbyLib.close_lobby/1.

cycle_lobby(lobby_id)

See Teiserver.Game.LobbyLib.cycle_lobby/1.

get_lobby(lobby_id)

See Teiserver.Game.LobbyLib.get_lobby/1.

get_lobby_attribute(lobby_id, key)

See Teiserver.Game.LobbyLib.get_lobby_attribute/2.

get_lobby_summary(lobby_id)

See Teiserver.Game.LobbyLib.get_lobby_summary/1.

list_lobby_ids()

See Teiserver.Game.LobbyLib.list_lobby_ids/0.

list_local_lobby_ids()

See Teiserver.Game.LobbyLib.list_local_lobby_ids/0.

lobby_name_acceptable?(name)

See Teiserver.Game.LobbyLib.lobby_name_acceptable?/1.

lobby_start_match(lobby_id)

See Teiserver.Game.LobbyLib.lobby_start_match/1.

open_lobby(host_id, name)

See Teiserver.Game.LobbyLib.open_lobby/2.

remove_client_from_lobby(user_id, lobby_id)

See Teiserver.Game.LobbyLib.remove_client_from_lobby/2.

stream_lobby_summaries()

See Teiserver.Game.LobbyLib.stream_lobby_summaries/0.

stream_lobby_summaries(filters)

See Teiserver.Game.LobbyLib.stream_lobby_summaries/1.

subscribe_to_lobby(lobby_or_lobby_id)

See Teiserver.Game.LobbyLib.subscribe_to_lobby/1.

unsubscribe_from_lobby(lobby_or_lobby_id)

See Teiserver.Game.LobbyLib.unsubscribe_from_lobby/1.

update_lobby(lobby_id, value_map)

See Teiserver.Game.LobbyLib.update_lobby/2.

Match

change_match(match, attrs \\ %{})

See Teiserver.Game.MatchLib.change_match/2.

create_match(attrs)

See Teiserver.Game.MatchLib.create_match/1.

delete_match(match)

See Teiserver.Game.MatchLib.delete_match/1.

end_match(match_id, outcome)

See Teiserver.Game.MatchLib.end_match/2.

get_match(match_id, query_args \\ [])

See Teiserver.Game.MatchLib.get_match/2.

get_match!(match_id, query_args \\ [])

See Teiserver.Game.MatchLib.get_match!/2.

list_matches(args)

See Teiserver.Game.MatchLib.list_matches/1.

start_match(lobby)

See Teiserver.Game.MatchLib.start_match/1.

update_match(match, attrs)

See Teiserver.Game.MatchLib.update_match/2.

Match Type

change_match_type(match_type, attrs \\ %{})

See Teiserver.Game.MatchTypeLib.change_match_type/2.

create_match_type(attrs)

See Teiserver.Game.MatchTypeLib.create_match_type/1.

delete_match_type(match_type)

See Teiserver.Game.MatchTypeLib.delete_match_type/1.

get_match_type(match_type_id, query_args \\ [])

See Teiserver.Game.MatchTypeLib.get_match_type/2.

get_match_type!(match_type_id, query_args \\ [])

See Teiserver.Game.MatchTypeLib.get_match_type!/2.

get_or_create_match_type(name)

See Teiserver.Game.MatchTypeLib.get_or_create_match_type/1.

list_match_types(args)

See Teiserver.Game.MatchTypeLib.list_match_types/1.

update_match_type(match_type, attrs)

See Teiserver.Game.MatchTypeLib.update_match_type/2.

Match Setting

change_match_setting(match_setting, attrs \\ %{})

See Teiserver.Game.MatchSettingLib.change_match_setting/2.

create_match_setting(attrs)

See Teiserver.Game.MatchSettingLib.create_match_setting/1.

delete_match_setting(match_setting)

See Teiserver.Game.MatchSettingLib.delete_match_setting/1.

get_match_setting(match_id, setting_type_id, query_args \\ [])

See Teiserver.Game.MatchSettingLib.get_match_setting/3.

get_match_setting!(match_id, setting_type_id, query_args \\ [])

See Teiserver.Game.MatchSettingLib.get_match_setting!/3.

get_match_settings_map(match_id)

See Teiserver.Game.MatchSettingLib.get_match_settings_map/1.

list_match_settings(args)

See Teiserver.Game.MatchSettingLib.list_match_settings/1.

update_match_setting(match_setting, attrs)

See Teiserver.Game.MatchSettingLib.update_match_setting/2.

Match Setting Type

change_match_setting_type(match_setting_type, attrs \\ %{})

See Teiserver.Game.MatchSettingTypeLib.change_match_setting_type/2.

create_match_setting_type(attrs)

See Teiserver.Game.MatchSettingTypeLib.create_match_setting_type/1.

delete_match_setting_type(match_setting_type)

See Teiserver.Game.MatchSettingTypeLib.delete_match_setting_type/1.

get_match_setting_type(match_setting_type_id, query_args \\ [])

See Teiserver.Game.MatchSettingTypeLib.get_match_setting_type/2.

get_match_setting_type!(match_setting_type_id, query_args \\ [])

See Teiserver.Game.MatchSettingTypeLib.get_match_setting_type!/2.

get_or_create_match_setting_type(name)

See Teiserver.Game.MatchSettingTypeLib.get_or_create_match_setting_type/1.

list_match_setting_types(args)

See Teiserver.Game.MatchSettingTypeLib.list_match_setting_types/1.

update_match_setting_type(match_setting_type, attrs)

See Teiserver.Game.MatchSettingTypeLib.update_match_setting_type/2.

Functions

change_match_membership(match_membership, attrs \\ %{})

See Teiserver.Game.MatchMembershipLib.change_match_membership/2.

create_many_match_memberships(attr_list)

See Teiserver.Game.MatchMembershipLib.create_many_match_memberships/1.

create_many_match_settings(attr_list)

See Teiserver.Game.MatchSettingLib.create_many_match_settings/1.

create_match_membership(attrs)

See Teiserver.Game.MatchMembershipLib.create_match_membership/1.

delete_match_membership(match_membership)

See Teiserver.Game.MatchMembershipLib.delete_match_membership/1.

get_match_membership(match_id, user_id, query_args \\ [])

See Teiserver.Game.MatchMembershipLib.get_match_membership/3.

get_match_membership!(match_id, user_id, query_args \\ [])

See Teiserver.Game.MatchMembershipLib.get_match_membership!/3.

list_match_memberships(args)

See Teiserver.Game.MatchMembershipLib.list_match_memberships/1.

update_match_membership(match_membership, attrs)

See Teiserver.Game.MatchMembershipLib.update_match_membership/2.

Lobby

add_client_to_lobby(user_id, lobby_id)

@spec add_client_to_lobby(Teiserver.user_id(), Teiserver.Game.Lobby.id()) ::
  :ok | {:error, String.t()}

See Teiserver.Game.LobbyLib.add_client_to_lobby/2.

can_add_client_to_lobby(user_id, lobby_id)

@spec can_add_client_to_lobby(Teiserver.user_id(), Teiserver.Game.Lobby.id()) ::
  {boolean(), String.t() | nil}

See Teiserver.Game.LobbyLib.can_add_client_to_lobby/2.

can_add_client_to_lobby(user_id, lobby_id, password)

@spec can_add_client_to_lobby(
  Teiserver.user_id(),
  Teiserver.Game.Lobby.id(),
  String.t()
) ::
  {boolean(), String.t() | nil}

See Teiserver.Game.LobbyLib.can_add_client_to_lobby/3.

close_lobby(lobby_id)

@spec close_lobby(Teiserver.Game.Lobby.id()) :: :ok

See Teiserver.Game.LobbyLib.close_lobby/1.

cycle_lobby(lobby_id)

@spec cycle_lobby(Teiserver.Game.Lobby.id()) :: :ok

See Teiserver.Game.LobbyLib.cycle_lobby/1.

get_lobby(lobby_id)

@spec get_lobby(Teiserver.Game.Lobby.id()) :: Teiserver.Game.Lobby.t() | nil

See Teiserver.Game.LobbyLib.get_lobby/1.

get_lobby_attribute(lobby_id, key)

@spec get_lobby_attribute(Teiserver.Game.Lobby.id(), atom()) :: any()

See Teiserver.Game.LobbyLib.get_lobby_attribute/2.

get_lobby_summary(lobby_id)

@spec get_lobby_summary(Teiserver.Game.Lobby.id()) ::
  Teiserver.Game.LobbySummary.t() | nil

See Teiserver.Game.LobbyLib.get_lobby_summary/1.

list_lobby_ids()

@spec list_lobby_ids() :: [Teiserver.Game.Lobby.id()]

See Teiserver.Game.LobbyLib.list_lobby_ids/0.

list_local_lobby_ids()

@spec list_local_lobby_ids() :: [Teiserver.Game.Lobby.id()]

See Teiserver.Game.LobbyLib.list_local_lobby_ids/0.

lobby_name_acceptable?(name)

@spec lobby_name_acceptable?(String.t()) :: boolean()

See Teiserver.Game.LobbyLib.lobby_name_acceptable?/1.

lobby_start_match(lobby_id)

@spec lobby_start_match(Teiserver.Game.Lobby.id()) :: :ok

See Teiserver.Game.LobbyLib.lobby_start_match/1.

open_lobby(host_id, name)

@spec open_lobby(Teiserver.user_id(), Teiserver.Game.Lobby.name()) ::
  {:ok, Teiserver.Game.Lobby.id()} | {:error, String.t()}

See Teiserver.Game.LobbyLib.open_lobby/2.

remove_client_from_lobby(user_id, lobby_id)

@spec remove_client_from_lobby(Teiserver.user_id(), Teiserver.Game.Lobby.id()) ::
  :ok | nil

See Teiserver.Game.LobbyLib.remove_client_from_lobby/2.

stream_lobby_summaries()

@spec stream_lobby_summaries() :: Enumerable.t(Teiserver.Game.LobbySummary.t())

See Teiserver.Game.LobbyLib.stream_lobby_summaries/0.

stream_lobby_summaries(filters)

@spec stream_lobby_summaries(map()) :: Enumerable.t(Teiserver.Game.LobbySummary.t())

See Teiserver.Game.LobbyLib.stream_lobby_summaries/1.

subscribe_to_lobby(lobby_or_lobby_id)

@spec subscribe_to_lobby(Teiserver.Game.Lobby.id() | Teiserver.Game.Lobby.t()) :: :ok

See Teiserver.Game.LobbyLib.subscribe_to_lobby/1.

unsubscribe_from_lobby(lobby_or_lobby_id)

@spec unsubscribe_from_lobby(Teiserver.Game.Lobby.id() | Teiserver.Game.Lobby.t()) ::
  :ok

See Teiserver.Game.LobbyLib.unsubscribe_from_lobby/1.

update_lobby(lobby_id, value_map)

@spec update_lobby(Teiserver.Game.Lobby.id(), map()) :: :ok | nil

See Teiserver.Game.LobbyLib.update_lobby/2.

Match

change_match(match, attrs \\ %{})

@spec change_match(Teiserver.Game.Match.t(), map()) :: Ecto.Changeset.t()

See Teiserver.Game.MatchLib.change_match/2.

create_match(attrs)

@spec create_match(map()) ::
  {:ok, Teiserver.Game.Match.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchLib.create_match/1.

delete_match(match)

@spec delete_match(Teiserver.Game.Match.t()) ::
  {:ok, Teiserver.Game.Match.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchLib.delete_match/1.

end_match(match_id, outcome)

@spec end_match(Teiserver.Game.Match.id(), map()) :: Teiserver.Game.Match.t()

See Teiserver.Game.MatchLib.end_match/2.

get_match(match_id, query_args \\ [])

@spec get_match(Teiserver.Game.Match.id(), Teiserver.query_args()) ::
  Teiserver.Game.Match.t() | nil

See Teiserver.Game.MatchLib.get_match/2.

get_match!(match_id, query_args \\ [])

@spec get_match!(Teiserver.Game.Match.id(), Teiserver.query_args()) ::
  Teiserver.Game.Match.t()

See Teiserver.Game.MatchLib.get_match!/2.

list_matches(args)

@spec list_matches(Teiserver.query_args()) :: [Teiserver.Game.Match.t()]

See Teiserver.Game.MatchLib.list_matches/1.

start_match(lobby)

@spec start_match(Teiserver.Game.Lobby.t()) :: Teiserver.Game.Match.t()

See Teiserver.Game.MatchLib.start_match/1.

update_match(match, attrs)

@spec update_match(Teiserver.Game.Match, map()) ::
  {:ok, Teiserver.Game.Match.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchLib.update_match/2.

Match Type

change_match_type(match_type, attrs \\ %{})

@spec change_match_type(Teiserver.Game.MatchType.t(), map()) :: Ecto.Changeset.t()

See Teiserver.Game.MatchTypeLib.change_match_type/2.

create_match_type(attrs)

@spec create_match_type(map()) ::
  {:ok, Teiserver.Game.MatchType.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchTypeLib.create_match_type/1.

delete_match_type(match_type)

@spec delete_match_type(Teiserver.Game.MatchType.t()) ::
  {:ok, Teiserver.Game.MatchType.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchTypeLib.delete_match_type/1.

get_match_type(match_type_id, query_args \\ [])

@spec get_match_type(Teiserver.Game.MatchType.id(), Teiserver.query_args()) ::
  Teiserver.Game.MatchType.t() | nil

See Teiserver.Game.MatchTypeLib.get_match_type/2.

get_match_type!(match_type_id, query_args \\ [])

@spec get_match_type!(Teiserver.Game.MatchType.id(), Teiserver.query_args()) ::
  Teiserver.Game.MatchType.t()

See Teiserver.Game.MatchTypeLib.get_match_type!/2.

get_or_create_match_type(name)

@spec get_or_create_match_type(String.t()) :: Teiserver.Game.MatchType.id()

See Teiserver.Game.MatchTypeLib.get_or_create_match_type/1.

list_match_types(args)

@spec list_match_types(Teiserver.query_args()) :: [Teiserver.Game.MatchType.t()]

See Teiserver.Game.MatchTypeLib.list_match_types/1.

update_match_type(match_type, attrs)

@spec update_match_type(Teiserver.Game.MatchType, map()) ::
  {:ok, Teiserver.Game.MatchType.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchTypeLib.update_match_type/2.

Match Setting

change_match_setting(match_setting, attrs \\ %{})

@spec change_match_setting(Teiserver.Game.MatchSetting.t(), map()) ::
  Ecto.Changeset.t()

See Teiserver.Game.MatchSettingLib.change_match_setting/2.

create_match_setting(attrs)

@spec create_match_setting(map()) ::
  {:ok, Teiserver.Game.MatchSetting.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchSettingLib.create_match_setting/1.

delete_match_setting(match_setting)

@spec delete_match_setting(Teiserver.Game.MatchSetting.t()) ::
  {:ok, Teiserver.Game.MatchSetting.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchSettingLib.delete_match_setting/1.

get_match_setting(match_id, setting_type_id, query_args \\ [])

@spec get_match_setting(
  Teiserver.match_id(),
  Teiserver.Game.MatchSettingType.id(),
  Teiserver.query_args()
) :: Teiserver.Game.MatchSetting.t() | nil

See Teiserver.Game.MatchSettingLib.get_match_setting/3.

get_match_setting!(match_id, setting_type_id, query_args \\ [])

@spec get_match_setting!(
  Teiserver.match_id(),
  Teiserver.Game.MatchSettingType.id(),
  Teiserver.query_args()
) :: Teiserver.Game.MatchSetting.t()

See Teiserver.Game.MatchSettingLib.get_match_setting!/3.

get_match_settings_map(match_id)

@spec get_match_settings_map(Teiserver.match_id()) :: %{
  required(String.t()) => String.t()
}

See Teiserver.Game.MatchSettingLib.get_match_settings_map/1.

list_match_settings(args)

@spec list_match_settings(Teiserver.query_args()) :: [Teiserver.Game.MatchSetting.t()]

See Teiserver.Game.MatchSettingLib.list_match_settings/1.

update_match_setting(match_setting, attrs)

@spec update_match_setting(Teiserver.Game.MatchSetting, map()) ::
  {:ok, Teiserver.Game.MatchSetting.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchSettingLib.update_match_setting/2.

Match Setting Type

change_match_setting_type(match_setting_type, attrs \\ %{})

@spec change_match_setting_type(Teiserver.Game.MatchSettingType.t(), map()) ::
  Ecto.Changeset.t()

See Teiserver.Game.MatchSettingTypeLib.change_match_setting_type/2.

create_match_setting_type(attrs)

@spec create_match_setting_type(map()) ::
  {:ok, Teiserver.Game.MatchSettingType.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchSettingTypeLib.create_match_setting_type/1.

delete_match_setting_type(match_setting_type)

@spec delete_match_setting_type(Teiserver.Game.MatchSettingType.t()) ::
  {:ok, Teiserver.Game.MatchSettingType.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchSettingTypeLib.delete_match_setting_type/1.

get_match_setting_type(match_setting_type_id, query_args \\ [])

@spec get_match_setting_type(
  Teiserver.Game.MatchSettingType.id(),
  Teiserver.query_args()
) ::
  Teiserver.Game.MatchSettingType.t() | nil

See Teiserver.Game.MatchSettingTypeLib.get_match_setting_type/2.

get_match_setting_type!(match_setting_type_id, query_args \\ [])

@spec get_match_setting_type!(
  Teiserver.Game.MatchSettingType.id(),
  Teiserver.query_args()
) ::
  Teiserver.Game.MatchSettingType.t()

See Teiserver.Game.MatchSettingTypeLib.get_match_setting_type!/2.

get_or_create_match_setting_type(name)

@spec get_or_create_match_setting_type(String.t()) ::
  Teiserver.Game.MatchSettingType.id()

See Teiserver.Game.MatchSettingTypeLib.get_or_create_match_setting_type/1.

list_match_setting_types(args)

@spec list_match_setting_types(Teiserver.query_args()) :: [
  Teiserver.Game.MatchSettingType.t()
]

See Teiserver.Game.MatchSettingTypeLib.list_match_setting_types/1.

update_match_setting_type(match_setting_type, attrs)

@spec update_match_setting_type(Teiserver.Game.MatchSettingType, map()) ::
  {:ok, Teiserver.Game.MatchSettingType.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchSettingTypeLib.update_match_setting_type/2.

Functions

change_match_membership(match_membership, attrs \\ %{})

@spec change_match_membership(Teiserver.Game.MatchMembership.t(), map()) ::
  Ecto.Changeset.t()

See Teiserver.Game.MatchMembershipLib.change_match_membership/2.

create_many_match_memberships(attr_list)

@spec create_many_match_memberships([map()]) ::
  {:ok, Teiserver.Game.MatchMembership.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchMembershipLib.create_many_match_memberships/1.

create_many_match_settings(attr_list)

@spec create_many_match_settings([map()]) ::
  {:ok, Teiserver.Game.MatchSetting.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchSettingLib.create_many_match_settings/1.

create_match_membership(attrs)

@spec create_match_membership(map()) ::
  {:ok, Teiserver.Game.MatchMembership.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchMembershipLib.create_match_membership/1.

delete_match_membership(match_membership)

@spec delete_match_membership(Teiserver.Game.MatchMembership.t()) ::
  {:ok, Teiserver.Game.MatchMembership.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchMembershipLib.delete_match_membership/1.

get_match_membership(match_id, user_id, query_args \\ [])

@spec get_match_membership(
  Teiserver.match_id(),
  Teiserver.user_id(),
  Teiserver.query_args()
) ::
  Teiserver.Game.MatchMembership.t() | nil

See Teiserver.Game.MatchMembershipLib.get_match_membership/3.

get_match_membership!(match_id, user_id, query_args \\ [])

@spec get_match_membership!(
  Teiserver.match_id(),
  Teiserver.user_id(),
  Teiserver.query_args()
) ::
  Teiserver.Game.MatchMembership.t()

See Teiserver.Game.MatchMembershipLib.get_match_membership!/3.

list_match_memberships(args)

@spec list_match_memberships(Teiserver.query_args()) :: [
  Teiserver.Game.MatchMembership.t()
]

See Teiserver.Game.MatchMembershipLib.list_match_memberships/1.

update_match_membership(match_membership, attrs)

@spec update_match_membership(Teiserver.Game.MatchMembership, map()) ::
  {:ok, Teiserver.Game.MatchMembership.t()} | {:error, Ecto.Changeset.t()}

See Teiserver.Game.MatchMembershipLib.update_match_membership/2.