Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LevelCreator

A creator for levels

Hierarchy

Index

Methods

Methods

byCreator

  • Search for the by a logged in creator

    async

    Parameters

    • creator: LoggedInUser

      The logged in creator to get the levels for

    • Optional config: Omit<SearchConfig, "query" | "orderBy">

      The query to use when searching for the levels

    Returns Promise<LoggedInSearchedLevel>

    The levels by the provided creator

  • Search for levels by a logged in creator

    async

    Parameters

    • creator: LoggedInUser

      The logged in creator to get the levels for

    • config: Omit<SearchConfig, "query" | "orderBy">

      The query to use when searching for the levels

    • num: number

      The number of results to get

    Returns Promise<LoggedInSearchedLevel[]>

    The levels by the provided creator

  • Search for levels by a creator

    async

    Parameters

    • creator: StatlessSearchedUser | User | number

      The creator to get the levels for

    • Optional config: Omit<SearchConfig, "query" | "orderBy">

      The query to use when searching for the levels

    Returns Promise<SearchedLevel>

    The levels by the provided creator

  • Search for levels by a creator

    async

    Parameters

    • creator: StatlessSearchedUser | User | number

      The creator to get the levels for

    • config: Omit<SearchConfig, "query" | "orderBy">

      The query to use when searching for the levels

    • num: number

      The number of results to get

    Returns Promise<SearchedLevel[]>

    The levels by the provided creator

get

  • get(levelID: string | number, resolve?: false): Promise<SearchedLevel>
  • get(levelID: string | number, resolve: true): Promise<Level>

  • Gets a level

    async

    Parameters

    • levelID: string | number

      The level name or ID to get

    • Optional resolve: false

      Whether to get the full level or not. Will cause an extra request.

    Returns Promise<SearchedLevel>

    The level with the given ID

  • Gets a level

    async

    Parameters

    • levelID: string | number

      The level name or ID to get

    • resolve: true

      Whether to get the full level or not. Will cause an extra request.

    Returns Promise<Level>

    The level with the given ID

search

  • Search for a level with a query

    async

    Parameters

    • config: SearchConfig & { query: number | string }

      The query to use when searching for the level

    Returns Promise<SearchedLevel>

    The level that matches the query

  • Search for levels with their numeric IDs

    async

    Parameters

    • config: SearchConfig & { query: number[] }

      The IDs of levels to get

    Returns Promise<SearchedLevel[]>

    The levels with the associated IDs

  • Search for levels with a query

    async

    Parameters

    • config: SearchConfig & { query: string }

      The query to use when searching for the levels

    • num: number

      The number of results to get

    Returns Promise<SearchedLevel[]>

    The levels that match the query

Generated using TypeDoc