potatojam/defold-ads-wrapper/ads_wrapper.ads_wrapper
Ads Wrapper is a wrapper for advertising services. It allows you to use one interface for different services and show ads from different sources. Supports various services such as Admob, Unity Ads, Poki, Yandex, Vk Bridge, Applovin Max
- GitHub: potatojam/defold-ads-wrapper — pinned to
1.5.1- Pick a release from potatojam/defold-ads-wrapper releases and add its Source code (zip) URL (or a packaged
.zipasset, if the library ships one) togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as ads_wrapper from "ads_wrapper.ads_wrapper"
- Pick a release from potatojam/defold-ads-wrapper releases and add its Source code (zip) URL (or a packaged
Functions
is_internet_connected(): booleanclear_networks()register_network(network:ads_network, params?: unknown | undefined): number | undefinedsetup_video(order:ads_order[], repeat_count?: number | undefined)setup_banner(order:ads_order[], repeat_count?: number | undefined, _banner_auto_hide?: boolean | undefined)init(initialize_video?: boolean | undefined, initialize_banner?: boolean | undefined, callback?: ads_callback | undefined, params?: LuaTable | undefined)init_video_networks(callback?: ads_callback | undefined, params?: LuaTable | undefined)init_banner_networks(callback?: ads_callback | undefined, params?: LuaTable | undefined)load_rewarded(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefinedshow_rewarded(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefinedload_interstitial(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefinedshow_interstitial(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefinedload_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefinedshow_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefinedhide_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)unload_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)is_banner_setup(): booleanis_video_setup(): booleanis_initialized(): booleanis_interstitial_loaded(check_current?: boolean | undefined, params?: LuaTable | undefined): booleanis_rewarded_loaded(check_current?: boolean | undefined, params?: LuaTable | undefined): booleanis_banner_loaded(check_current?: boolean | undefined, params?: LuaTable | undefined): booleanget_current_network(check_banner?: boolean | undefined):ads_network| undefinedget_next_network(check_banner?: boolean | undefined):ads_network| undefinedcancel(id: number)
is_internet_connected(): boolean
Checks for internet connection
Returns
boolean
clear_networks()
Remove all registered networks
register_network(network: ads_network, params?: unknown | undefined): number | undefined
Registers network. Returns id
Parameters
network:ads_networkparams?:unknown | undefined— parameters to be passed to the network.setup function
Returns
number | undefined
setup_video(order: ads_order[], repeat_count?: number | undefined)
Setups interstitial and reward mediator
Parameters
order:ads_order[]repeat_count?:number | undefined— Specified if after the first cycle in queue it is necessary to cut off a part of the order. Default: the total number of all networks.
setup_banner(order: ads_order[], repeat_count?: number | undefined, _banner_auto_hide?: boolean | undefined)
Setups banner mediator
Parameters
order:ads_order[]repeat_count?:number | undefined— Specified if after the first cycle in queue it is necessary to cut off a part of the order. Default: the total number of all networks._banner_auto_hide?:boolean | undefined— The banner will be automatically hidden if hide_banner was called after show_banner, but the banner did not have time to load. Default:false
init(initialize_video?: boolean | undefined, initialize_banner?: boolean | undefined, callback?: ads_callback | undefined, params?: LuaTable | undefined)
Initializes all networks.
Parameters
initialize_video?:boolean | undefined— check if need to initialize video networksinitialize_banner?:boolean | undefined— check if need to initialize banner networkscallback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
init_video_networks(callback?: ads_callback | undefined, params?: LuaTable | undefined)
Initialize video networks
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
init_banner_networks(callback?: ads_callback | undefined, params?: LuaTable | undefined)
Initialize banner networks
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
load_rewarded(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefined
Loads rewarded ads for next network
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
Returns
number | undefined
show_rewarded(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefined
Shows rewarded ads for next network
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
Returns
number | undefined
load_interstitial(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefined
Loads interstitial ads for next network
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
Returns
number | undefined
show_interstitial(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefined
Shows interstitial ads for next network
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
Returns
number | undefined
load_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefined
Loads banner for for next network.
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
Returns
number | undefined
show_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined): number | undefined
Shows setup banner for next network. Hides the previous banner if it was displayed.
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
Returns
number | undefined
hide_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)
Hides setup banner for current network
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
unload_banner(callback?: ads_callback | undefined, params?: LuaTable | undefined)
Unloads banner for current networks.
Parameters
callback?:ads_callback | undefined— the function is called after execution.params?:LuaTable | undefined— additional parameters
is_banner_setup(): boolean
Check if the banner mediator is set up
Returns
boolean
is_video_setup(): boolean
Check if the interstitial and rewarded video mediator is set up
Returns
boolean
is_initialized(): boolean
Check if wrapper is initiailzed
Returns
boolean
is_interstitial_loaded(check_current?: boolean | undefined, params?: LuaTable | undefined): boolean
Check if the interstitial video is loaded.
Default checks the next network in mediator.
Parameters
check_current?:boolean | undefined—Optionalif need check current network. Defaultfalseparams?:LuaTable | undefined— additional parameters
Returns
boolean
is_rewarded_loaded(check_current?: boolean | undefined, params?: LuaTable | undefined): boolean
Check if the rewarded video is loaded.
Default checks the next network in mediator.
Parameters
check_current?:boolean | undefined—Optionalif need check current network. Defaultfalseparams?:LuaTable | undefined— additional parameters
Returns
boolean
is_banner_loaded(check_current?: boolean | undefined, params?: LuaTable | undefined): boolean
Check if the banner is loaded.
Default checks the next network in mediator.
Parameters
check_current?:boolean | undefined—Optionalif need check current network. Defaultfalseparams?:LuaTable | undefined— additional parameters
Returns
boolean
get_current_network(check_banner?: boolean | undefined): ads_network | undefined
Returns the current network pointed to by mediator Default returns for the video mediator
Parameters
check_banner?:boolean | undefined—Optionalneed to return mediator for banners. Defaultfalse
Returns
ads_network | undefined
get_next_network(check_banner?: boolean | undefined): ads_network | undefined
Returns the next network pointed to by mediator Default returns for the video mediator
Parameters
check_banner?:boolean | undefined—Optionalneed to return mediator for banners. Defaultfalse
Returns
ads_network | undefined
cancel(id: number)
Cancel execution
Parameters
id:number
Variables
T_REWARDED: Hash
Rewarded-video ad type, used to set network parameters.
T_INTERSTITIAL: Hash
Interstitial ad type, used to set network parameters.
T_BANNER: Hash
Banner ad type, used to set network parameters.
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