potatojam/defold-ads-wrapper/ads_wrapper.ads_networks.yandex
Ads Wrapper network for Yandex Games on HTML5, through the defold-yagames extension.
- 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_yandex from "ads_wrapper.ads_networks.yandex"
- Pick a release from potatojam/defold-ads-wrapper releases and add its Source code (zip) URL (or a packaged
Functions
set_yandex_extention(ex_yagames: unknown)get_player(callback?: ads_callback | undefined)setup(params: LuaTable)init(callback?: ads_callback | undefined)is_supported(): booleanget_lang(): string | undefinedis_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_storage_supported(): booleanis_player_authorized(): 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)set_banner_position(position: LuaTable): ads_responseset_banner_size(size: LuaTable): ads_responseis_banner_showed(): boolean
set_yandex_extention(ex_yagames: unknown)
Sets yandex extention
Parameters
ex_yagames:unknown
get_player(callback?: ads_callback | undefined)
Asks the player sdk to save data
Parameters
callback?:ads_callback | undefined— the function is called after execution.
setup(params: LuaTable)
Parameters
params:LuaTable
init(callback?: ads_callback | undefined)
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_supported(): boolean
Check if the environment supports yandex api
Returns
boolean
get_lang(): string | undefined
Returns Yandex.Games interface language in ISO 639-1 format.
Returns
string | undefined
is_initialized(): boolean
Check if the yandex is initialized
Returns
boolean
show_rewarded(callback?: ads_callback | undefined)
Parameters
callback?:ads_callback | undefined— the function is called after execution.
load_rewarded(callback?: ads_callback | undefined)
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_rewarded_loaded(): boolean
Returns
boolean
show_interstitial(callback?: ads_callback | undefined)
Parameters
callback?:ads_callback | undefined— the function is called after execution.
load_interstitial(callback?: ads_callback | undefined)
Parameters
callback?:ads_callback | undefined— the function is called after execution.
is_interstitial_loaded(): boolean
Returns
boolean
is_storage_supported(): boolean
Check if the yandex supports safe storage
Returns
boolean
is_player_authorized(): boolean
Check if the yandex player is authorized
Returns
boolean
is_banner_setup(): boolean
Check if the banner is set up
Returns
boolean
load_banner(callback?: ads_callback | undefined)
Loads banner. Use ads.T_BANNER parameter.
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.
set_banner_position(position: LuaTable): ads_response
Sets banner position.
Parameters
position:LuaTable— table{x = string, y = string}
Returns
ads_response
set_banner_size(size: LuaTable): ads_response
Sets banner size.
Parameters
size:LuaTable— table{width = string, height = string}
Returns
ads_response
is_banner_showed(): boolean
Check if the banner is showed
Returns
boolean