potatojam/defold-ads-wrapper/ads_wrapper.ads_networks.game_distribution
Ads Wrapper network for GameDistribution on HTML5, through the gd-defold extension, with its banner sizes and message listener key.
- 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_networks_game_distribution from "ads_wrapper.ads_networks.game_distribution"
- Pick a release from potatojam/defold-ads-wrapper releases and add its Source code (zip) URL (or a packaged
Functions
setup(params: LuaTable)init(callback?: ads_callback | undefined)is_supported(): booleanis_initialized(): booleanshow_rewarded(callback?: ads_callback | undefined)load_rewarded(callback?: ads_callback | undefined)is_rewarded_loaded(): booleanshow_interstitial(callback?: ads_callback | undefined)load_interstitial(callback?: ads_callback | undefined)is_interstitial_loaded(): booleanis_banner_setup(): booleanload_banner(callback?: ads_callback | undefined)unload_banner(callback?: ads_callback | undefined)is_banner_loaded(): booleanshow_banner(callback?: ads_callback | undefined)hide_banner(callback?: ads_callback | undefined)is_banner_showed(): boolean
setup(params: LuaTable)
Api setup
Parameters
params:LuaTable
init(callback?: ads_callback | undefined)
Initializes GameDistribution sdk.
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_supported(): boolean
Check if the environment supports GameDistribution api
Returns
boolean
is_initialized(): boolean
Check if the GameDistribution is initialized
Returns
boolean
show_rewarded(callback?: ads_callback | undefined)
Shows rewarded ads.
Parameters
callback?:ads_callback | undefined— the function is called after execution.
load_rewarded(callback?: ads_callback | undefined)
Loads rewarded ads
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_rewarded_loaded(): boolean
Check if the rewarded ads is loaded
Returns
boolean
show_interstitial(callback?: ads_callback | undefined)
Shows interstitial ads.
Parameters
callback?:ads_callback | undefined— the function is called after execution.
load_interstitial(callback?: ads_callback | undefined)
Loads interstitial ads
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_interstitial_loaded(): boolean
Check if the interstitial ads is loaded
Returns
boolean
is_banner_setup(): boolean
Check if the banner is set up
Returns
boolean
load_banner(callback?: ads_callback | undefined)
Loads banner
Parameters
callback?:ads_callback | undefined— the function is called after execution.
unload_banner(callback?: ads_callback | undefined)
Unloads active banner.
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_banner_loaded(): boolean
Check if the banner is loaded
Returns
boolean
show_banner(callback?: ads_callback | undefined)
Shows loaded banner.
Parameters
callback?:ads_callback | undefined— the function is called after execution.
hide_banner(callback?: ads_callback | undefined)
Hides loaded banner.
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_banner_showed(): boolean
Check if the banner is showed
Returns
boolean
Variables
LISTENER: Hash
Params key for a function(self, message_id, message) listener that receives every GameDistribution message.
SIZE_NONE: number
Banner size option that sets no fixed size.
SIZE_336x280: number
Banner size option for a 336x280 banner; the default.
SIZE_300x250: number
Banner size option for a 300x250 banner.
SIZE_970x250: number
Banner size option for a 970x250 banner.
SIZE_728x90: number
Banner size option for a 728x90 banner.
SIZE_120x600: number
Banner size option for a 120x600 banner.
SIZE_160x600: number
Banner size option for a 160x600 banner.