potatojam/defold-ads-wrapper/ads_wrapper.platform
Platform constants and a check for the running platform, for Ads Wrapper network settings.
- 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 platform from "ads_wrapper.platform"
- Pick a release from potatojam/defold-ads-wrapper releases and add its Source code (zip) URL (or a packaged
Functions
is_same(value: Hash): boolean
Check if the platform is correct
Parameters
value:Hash
Returns
boolean
get(): Hash
Returns current hash platform
Returns
Hash
Variables
PL_ANDROID: Hash
Android, as returned by get and checked by is_same.
PL_IOS: Hash
iOS, as returned by get and checked by is_same.
PL_HTML5: Hash
HTML5, as returned by get and checked by is_same.
PL_OTHER: Hash
Any other platform, as returned by get and checked by is_same.
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