tallgrass/contest/effect

Types

pub type ContestEffect {
  ContestEffect(
    id: Int,
    appeal: Int,
    jam: Int,
    effect_entries: List(Effect),
    flavor_text_entries: List(FlavorText),
  )
}

Constructors

  • ContestEffect(
      id: Int,
      appeal: Int,
      jam: Int,
      effect_entries: List(Effect),
      flavor_text_entries: List(FlavorText),
    )

Functions

pub fn fetch(client: Client) -> Result(PaginatedResource, Error)

Fetches a paginated list of contest effect resources.

Example

let result = effect.new() |> effect.fetch()
pub fn fetch_by_id(
  client: Client,
  id: Int,
) -> Result(ContestEffect, Error)

Fetches a contest effect given the contest effect ID.

Example

let result = effect.new() |> effect.fetch_by_id(1)
pub fn fetch_resource(
  client: Client,
  resource: Resource,
) -> Result(ContestEffect, Error)

Fetches a contest effect given a contest effect resource.

Example

let client = effect.new()
use res <- result.try(client |> effect.fetch())
let assert Ok(first) = res.results |> list.first
client |> effect.fetch_resource(first)
pub fn new() -> Client

Creates a new Client. This is a re-export of client.new, for the sake of convenience.

Search Document