Skip to Content
defold-typescript libraries
potatojamdefold-ads-wrapper

potatojam/defold-ads-wrapper/ads_wrapper.queue

The Ads Wrapper call queue, including the switch for its debug output.

  • GitHub: potatojam/defold-ads-wrapper — pinned to 1.5.1
    1. Pick a release from potatojam/defold-ads-wrapper releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as queue from "ads_wrapper.queue"

Functions

set_verbose_mode(mode: Hash)

Sets vebose mode. Allows to display all messages.

Parameters

  • mode: Hash

create(): ads_queue

Creates new queue

Returns

  • ads_queue

run(queue: ads_queue, network: ads_network, callback: ads_callback, params?: LuaTable | undefined): number

Runs queue

Parameters

  • queue: ads_queue
  • network: ads_network
  • callback: ads_callback — callback accepting the response result
  • params?: LuaTable | undefined — additional parameters

Returns

  • number

add(queue: ads_queue, fn: (network: ads_network, callback: ads_callback, params?: LuaTable) => void)

Adds function to queue. Function must be like func(network: network, callback: function)

Parameters

  • queue: ads_queue
  • fn: (network: ads_network, callback: ads_callback, params?: LuaTable) => void

cancel(id: number)

Cancel queue execution

Parameters

  • id: number

Types

ads_network

ads_network.setup(params?: unknown | undefined)

Api setup

Parameters

  • params?: unknown | undefined

ads_network.init(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Initializes admob sdk.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.request_idfa(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Requests IDFA

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.is_supported(): boolean

Check if the environment supports admob api

Returns

  • boolean

ads_network.is_initialized(): boolean

Check if the admob is initialized

Returns

  • boolean

ads_network.show_rewarded(callback?: ads_callback | undefined, params?: unknown)

Shows rewarded ads.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: unknown — additional parameters

ads_network.load_rewarded(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Loads rewarded ads

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.is_rewarded_loaded(params?: LuaTable | undefined): boolean

Check if the rewarded ads is loaded

Parameters

  • params?: LuaTable | undefined — additional parameters

Returns

  • boolean

ads_network.show_interstitial(callback?: ads_callback | undefined, params?: unknown)

Shows interstitial ads.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: unknown — additional parameters

ads_network.load_interstitial(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Loads interstitial ads

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.is_interstitial_loaded(params?: LuaTable | undefined): boolean

Check if the interstitial ads is loaded

Parameters

  • params?: LuaTable | undefined — additional parameters

Returns

  • boolean

ads_network.is_banner_setup(): boolean

Check if the banner is set up

Returns

  • boolean

ads_network.load_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Loads banner. Use ads.T_BANNER parameter.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.unload_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Unloads active banner.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.is_banner_loaded(params?: LuaTable | undefined): boolean

Check if the banner is loaded

Parameters

  • params?: LuaTable | undefined — additional parameters

Returns

  • boolean

ads_network.show_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Shows loaded banner.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.hide_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)

Hides loaded banner.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.
  • params?: LuaTable | undefined — additional parameters

ads_network.is_banner_showed(params?: LuaTable | undefined): boolean

Check if the banner is showed

Parameters

  • params?: LuaTable | undefined — additional parameters

Returns

  • boolean

ads_order

ads_order.id: number

ads_order.count: number | undefined

ads_mediator

ads_mediator.order: ads_network[]

ads_mediator.networks: LuaTable<number, ads_network>

ads_mediator.current_network_num: number

ads_mediator.repeater: number

ads_mediator.repeat_num: number

ads_response

ads_response.result: Hash

ads_response.message: string | undefined

ads_response.data: unknown | undefined

ads_response.code: Hash | undefined

ads_response.cancelled: boolean | undefined

ads_response.name: string | undefined

ads_response.network_name: string | undefined

On this page

Functionsset_verbose_mode(mode: Hash)create(): ads_queuerun(queue: ads_queue, network: ads_network, callback: ads_callback, params?: LuaTable | undefined): numberadd(queue: ads_queue, fn: (network: ads_network, callback: ads_callback, params?: LuaTable) => void)cancel(id: number)Typesads_networkads_network.setup(params?: unknown | undefined)ads_network.init(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.request_idfa(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.is_supported(): booleanads_network.is_initialized(): booleanads_network.show_rewarded(callback?: ads_callback | undefined, params?: unknown)ads_network.load_rewarded(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.is_rewarded_loaded(params?: LuaTable | undefined): booleanads_network.show_interstitial(callback?: ads_callback | undefined, params?: unknown)ads_network.load_interstitial(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.is_interstitial_loaded(params?: LuaTable | undefined): booleanads_network.is_banner_setup(): booleanads_network.load_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.unload_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.is_banner_loaded(params?: LuaTable | undefined): booleanads_network.show_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.hide_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)ads_network.is_banner_showed(params?: LuaTable | undefined): booleanads_orderads_order.id: numberads_order.count: number | undefinedads_mediatorads_mediator.order: ads_network[]ads_mediator.networks: LuaTable<number, ads_network>ads_mediator.current_network_num: numberads_mediator.repeater: numberads_mediator.repeat_num: numberads_responseads_response.result: Hashads_response.message: string | undefinedads_response.data: unknown | undefinedads_response.code: Hash | undefinedads_response.cancelled: boolean | undefinedads_response.name: string | undefinedads_response.network_name: string | undefined