Type Function Return value none Revision Release 2024.3703 Keywords ads, advertising, SuperAwesome, show See also superawesome.hide() superawesome.init() superawesome.load() superawesome.isLoaded() superawesome.*
Shows a SuperAwesome ad which was previously loaded via superawesome.load().
superawesome.show( placementID [, params] )
String. The placement ID for the ad, retrieved from the SuperAwesome dashboard.
Table. Table containing optional parameters for ads — see the next section for details.
The params
table can include properties for ads:
Boolean. Indicates if a parental gate (simple math question popup) will be shown when an ad is clicked. Default is false
.
Boolean. Applies to video ads only; indicates whether the ad will automatically close when its playback completes. Default is false
.
Boolean. Applies to video ads only; if true
, displays a small clickable text element at the bottom of the ad, leaving the rest of the ad unclickable. If false
, the entire ad is clickable. Default is false
.
String. Does not apply to banners; allows you to lock the orientation of the ad. Valid values are "landscape"
and "portrait"
. By default, the ad will change orientation according to the device orientation.
String or Number. Only applies to banner ads, specifying the banner's y position on the screen. If you supply a string, valid position values are "top"
, "center"
and "bottom"
. Alternatively, you can set a custom y position by specifying a number in content coodinates where 0
indicates the top edge of the screen or where a negative value specifies an offset from the bottom edge of the screen to the bottom edge of the banner. Default is "bottom"
.
local superawesome = require( "plugin.superawesome" ) -- Pre-declare a placement ID local myPlacementID = "YOUR_PLACEMENT_ID" local function adListener( event ) if ( event.phase == "init" ) then -- Successful initialization -- Load a banner ad superawesome.load( "banner", { placementId=myPlacementID } ) elseif ( event.phase == "loaded" ) then -- The ad was successfully loaded print( event.type ) print( event.placementId ) elseif ( event.phase == "failed" ) then -- The ad failed to load print( event.type ) print( event.placementId ) print( event.isError ) end end -- Initialize the SuperAwesome plugin superawesome.init( adListener, { testMode=true } ) -- Sometime later, show the ad if ( superawesome.isLoaded( myPlacementID ) ) then superawesome.show( myPlacementID, { y="bottom" } ) end