godfist

v0.5.0

godfist v0.5.0 Godfist.Static

Module to interact with the Static data provided by Riot. I’m not going to provide examples in this Module unless it’s necessary. Just pass each region as an atom and id if it requires it.

On some of these functions I could have provided the ids as options and use the same function name but I thought that explicitly telling that you want a single rune or mastery is a better id so… You can do it like this intead.

Link to this section Summary

Functions

all_champs(region, opts \\ [])

Get a list of all champs

all_items(region, opts \\ [])

Get a list of all items

all_masteries(region, opts \\ [])

Get a list of all masteries

all_runes(region, opts \\ [])

Get a list of all runes

champion(region, id, opts \\ [])

Get a single champion by id

item(region, id, opts \\ [])

Get a single item by id

lang_strings(region)

Retrieve language strings data

languages(region)

Get support languages data

maps(region)

Get information about all maps

mastery(region, id, opts \\ [])

Get a single mastery by id

profile_icons(region)

Get a list of all profile icons

realms(region)

Retrieve realm data

reforged_rune_by_id(region, id)

Retrieves reforged rune by ID

reforged_rune_path_by_id(region, id)

Retrieves reforged rune path by ID

reforged_runes(region)

Retrieves reforged runes list

reforged_runes_path(region)

Retrieves reforged rune path list

rune(region, id, opts \\ [])

Get information about a single rune by id

spell(region, id, opts \\ [])

Get a single spell by id

sum_spells(region, opts \\ [])

Get a list of all summoner spells

tarball_links(region)

Retrieves full tarball link

versions(region)

Get version data

Link to this section Functions

Link to this function all_champs(region, opts \\ []) 
all_champs(atom, Keyword.t) :: {:ok, map} | {:error, String.t}

Get a list of all champs.

One option must be passed, otherwise “all” is returned. Options are given with the :filter key with one of these values.

  • all
  • allytips
  • altimages
  • blurb
  • enemytips
  • image
  • info
  • lore
  • partype
  • passive
  • recommended
  • skins
  • spells
  • stats
  • tags
Link to this function all_items(region, opts \\ []) 
all_items(atom, Keyword.t) :: {:ok, map} | {:error, String.t}

Get a list of all items.

One option must be passed, otherwise “all” is returned.

Pass on the :filter key with value of:

  • all
  • colloq
  • consumeOnFull
  • consumed
  • depth
  • from
  • gold
  • groups
  • hideFromAll
  • image
  • inStore
  • into
  • maps
  • requiredChampion
  • sanitizedDescription
  • specialRecipe
  • stacks
  • stats
  • tags
  • tree
Link to this function all_masteries(region, opts \\ []) 
all_masteries(atom, Kwyrod.t) ::
  {:ok, map} |
  {:error, String.t}

Get a list of all masteries.

Opts is atom :filter with a value of one of:

  • all (Default)
  • image
  • masteryTree
  • prereq
  • ranks
  • sanitizedDescription
  • tree
Link to this function all_runes(region, opts \\ []) 
all_runes(atom, Keyword.t) :: {:ok, map} | {:error, String.t}

Get a list of all runes.

Options are given with an atom :filter as key and values are:

  • all (Default)
  • image
  • sanitizedDescription
  • stats
  • tags
Link to this function champion(region, id, opts \\ []) 
champion(atom, integer, Keyword.t) ::
  {:ok, map} |
  {:error, String.t}

Get a single champion by id.

Refer to all_champs/2 for a list of options.

Link to this function item(region, id, opts \\ []) 
item(atom, integer, Keyword.t) ::
  {:ok, map} |
  {:error, String.t}

Get a single item by id.

Refer to all_items/2 for a list of options.

Link to this function lang_strings(region) 
lang_strings(atom) :: {:ok, map} | {:error, String.t}

Retrieve language strings data.

Link to this function languages(region) 
languages(atom) :: {:ok, map} | {:error, String.t}

Get support languages data.

Link to this function maps(region) 
maps(atom) :: {:ok, map} | {:error, String.t}

Get information about all maps.

Link to this function mastery(region, id, opts \\ []) 
mastery(atom, integer, Kwyrod.t) ::
  {:ok, map} |
  {:error, String.t}

Get a single mastery by id.

Refer to all_masteries/2 for a list of options.

Link to this function profile_icons(region) 
profile_icons(atom) :: {:ok, map} | {:error, String.t}

Get a list of all profile icons.

Link to this function realms(region) 
realms(atom) :: {:ok, map} | {:error, String.t}

Retrieve realm data.

Link to this function reforged_rune_by_id(region, id) 
reforged_rune_by_id(atom, integer) ::
  {:ok, list} |
  {:error, String.t}

Retrieves reforged rune by ID.

Link to this function reforged_rune_path_by_id(region, id) 
reforged_rune_path_by_id(atom, integer) ::
  {:ok, list} |
  {:error, String.t}

Retrieves reforged rune path by ID.

Link to this function reforged_runes(region) 
reforged_runes(atom) :: {:ok, list} | {:error, String.t}

Retrieves reforged runes list.

Link to this function reforged_runes_path(region) 
reforged_runes_path(atom) :: {:ok, list} | {:error, String.t}

Retrieves reforged rune path list.

Link to this function rune(region, id, opts \\ []) 
rune(atom, integer, Keyword.t) ::
  {:ok, map} |
  {:error, String.t}

Get information about a single rune by id.

Reger to all_runes/2 for a list of options.

Link to this function spell(region, id, opts \\ []) 
spell(atom, integer, Keyword.t) ::
  {:ok, map} |
  {:error, String.t}

Get a single spell by id.

Refer to sum_spells/1 for a list of options

Link to this function sum_spells(region, opts \\ []) 
sum_spells(atom, Keyword.t) :: {:ok, map} | {:error, String.t}

Get a list of all summoner spells.

Options are given with an atom :filter as key and values are:

  • all (Default)
  • cooldown
  • cooldownBurn
  • cost
  • costBurn
  • costType
  • effect
  • effectBurn
  • image
  • key
  • leveltip
  • maxrank
  • modes
  • range
  • rangeBurn
  • resource
  • sanitizedDescription
  • sanitizedTooltip
  • tooltip
  • vars
Link to this function tarball_links(region) 
tarball_links(atom) :: {:ok, String.t} | {:error, String.t}

Retrieves full tarball link

Link to this function versions(region) 
versions(atom) :: {:ok, map} | {:error, String.t}

Get version data.