Navigation
API > API/Runtime > API/Runtime/Engine
| Name | UInGameAdManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/InGameAdManager.h |
| Include Path | #include "Engine/InGameAdManager.h" |
Syntax
UCLASS ()
class UInGameAdManager : public UPlatformInterfaceBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPlatformInterfaceBase → UInGameAdManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UInGameAdManager
(
const FObjectInitializer& ObjectInitializer |
Engine/InGameAdManager.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bShouldPauseWhileAdOpen | uint32 | If true, the game will pause when the user clicks on the ad, which could take over the screen | Engine/InGameAdManager.h | |
| ClickedBannerDelegates | TArray< FOnUserClickedBanner > | Engine/InGameAdManager.h | ||
| ClosedAdDelegates | TArray< FOnUserClosedAdvertisement > | Engine/InGameAdManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddClickedBannerDelegate
(
FOnUserClickedBanner InDelegate |
Adds a delegate to the list of listeners | Engine/InGameAdManager.h | |
virtual void AddClosedAdDelegate
(
FOnUserClosedAdvertisement InDelegate |
Adds a delegate to the list of listeners | Engine/InGameAdManager.h | |
virtual void ClearClickedBannerDelegate
(
FOnUserClickedBanner InDelegate |
Removes a delegate from the list of listeners | Engine/InGameAdManager.h | |
virtual void ClearClosedAdDelegate
(
FOnUserClosedAdvertisement InDelegate |
Removes a delegate from the list of listeners | Engine/InGameAdManager.h | |
virtual void ForceCloseAd () |
If the game absolutely must close an opened (clicked on) advertisement, call this function. | Engine/InGameAdManager.h | |
virtual void HideBanner () |
Hides the advertisement banner shown with ShowInGameAdvertisementBanner. | Engine/InGameAdManager.h | |
virtual void Init() |
Perform any needed initialization | Engine/InGameAdManager.h | |
void OnUserClickedBanner () |
Called by platform when the user clicks on the ad banner. | Engine/InGameAdManager.h | |
void OnUserClosedAd() |
Called by platform when an opened ad is closed. Will unpause the game before calling the delegates | Engine/InGameAdManager.h | |
virtual void SetPauseWhileAdOpen
(
bool bShouldPause |
Sets the value of bShouldPauseWhileAdOpen | Engine/InGameAdManager.h | |
virtual void ShowBanner
(
bool bShowBottomOfScreen |
Allows the platform to put up an advertisement on top of the viewport. | Engine/InGameAdManager.h |