@rbxts/types 1.0.890 → 1.0.891
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -6,6 +6,7 @@ interface Services {
|
|
|
6
6
|
AccountService: AccountService;
|
|
7
7
|
AchievementService: AchievementService;
|
|
8
8
|
ActivityHistoryEventService: ActivityHistoryEventService;
|
|
9
|
+
AdService: AdService;
|
|
9
10
|
AnalyticsService: AnalyticsService;
|
|
10
11
|
AnimationClipProvider: AnimationClipProvider;
|
|
11
12
|
AnimationFromVideoCreatorService: AnimationFromVideoCreatorService;
|
|
@@ -2855,6 +2856,102 @@ interface AdPortal extends Instance {
|
|
|
2855
2856
|
*/
|
|
2856
2857
|
readonly Status: Enum.AdUnitStatus;
|
|
2857
2858
|
}
|
|
2859
|
+
/**
|
|
2860
|
+
* A class that allows the display of mobile video ads.
|
|
2861
|
+
*
|
|
2862
|
+
* - **Tags**: NotCreatable, Service
|
|
2863
|
+
*
|
|
2864
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService)
|
|
2865
|
+
*/
|
|
2866
|
+
interface AdService extends Instance {
|
|
2867
|
+
/**
|
|
2868
|
+
* **DO NOT USE!**
|
|
2869
|
+
*
|
|
2870
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
2871
|
+
* @hidden
|
|
2872
|
+
* @deprecated
|
|
2873
|
+
*/
|
|
2874
|
+
readonly _nominal_AdService: unique symbol;
|
|
2875
|
+
/**
|
|
2876
|
+
* Creates a reward to give users who watch an entire video ad.
|
|
2877
|
+
*
|
|
2878
|
+
* - **ThreadSafety**: Unsafe
|
|
2879
|
+
*
|
|
2880
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#CreateAdRewardFromDevProductId)
|
|
2881
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2882
|
+
* @param devProductId The ID of the developer product you want to grant as a reward.
|
|
2883
|
+
*/
|
|
2884
|
+
CreateAdRewardFromDevProductId(this: AdService, devProductId: number): AdReward;
|
|
2885
|
+
/**
|
|
2886
|
+
* **Deprecated:** `ShowVideoAd` has been decommissioned and is no longer operational.
|
|
2887
|
+
*
|
|
2888
|
+
* Show mobile video advertisements.
|
|
2889
|
+
*
|
|
2890
|
+
* - **ThreadSafety**: Unsafe
|
|
2891
|
+
* - **Tags**:
|
|
2892
|
+
*
|
|
2893
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowVideoAd)
|
|
2894
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2895
|
+
*
|
|
2896
|
+
* @deprecated
|
|
2897
|
+
*/
|
|
2898
|
+
ShowVideoAd(this: AdService): void;
|
|
2899
|
+
/**
|
|
2900
|
+
* - **ThreadSafety**: Unsafe
|
|
2901
|
+
*
|
|
2902
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#UnregisterAdOpportunity)
|
|
2903
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2904
|
+
* @param instance
|
|
2905
|
+
*/
|
|
2906
|
+
UnregisterAdOpportunity(this: AdService, instance: Instance): void;
|
|
2907
|
+
/**
|
|
2908
|
+
* Checks if a video ad is available to be played to the current user inside the experience.
|
|
2909
|
+
*
|
|
2910
|
+
* - **ThreadSafety**: Unsafe
|
|
2911
|
+
* - **Tags**: Yields
|
|
2912
|
+
*
|
|
2913
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetAdAvailabilityNowAsync)
|
|
2914
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2915
|
+
* @param adFormat The format of the requested ad. For example, `RewardedVideo`.
|
|
2916
|
+
*/
|
|
2917
|
+
GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): unknown;
|
|
2918
|
+
/**
|
|
2919
|
+
* - **ThreadSafety**: Unsafe
|
|
2920
|
+
* - **Tags**: Yields
|
|
2921
|
+
*
|
|
2922
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
|
|
2923
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2924
|
+
* @param instance
|
|
2925
|
+
* @param placementId
|
|
2926
|
+
*/
|
|
2927
|
+
RegisterAdOpportunityAsync(this: AdService, instance: Instance, placementId?: number): void;
|
|
2928
|
+
/**
|
|
2929
|
+
* Plays the video ad to the current user inside the experience.
|
|
2930
|
+
*
|
|
2931
|
+
* - **ThreadSafety**: Unsafe
|
|
2932
|
+
* - **Tags**: Yields
|
|
2933
|
+
*
|
|
2934
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#ShowRewardedVideoAdAsync)
|
|
2935
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2936
|
+
* @param player The `Player` object for whom you are fetching the ad for.
|
|
2937
|
+
* @param reward The reward object for the reward you want to grant the user who watches an ad to completion.
|
|
2938
|
+
* @param placementId The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements.
|
|
2939
|
+
*/
|
|
2940
|
+
ShowRewardedVideoAdAsync(this: AdService, player: Player, reward: AdReward, placementId?: number): Enum.ShowAdResult;
|
|
2941
|
+
/**
|
|
2942
|
+
* **Deprecated:** `VideoAdClosed` has been decommissioned and is no longer operational.
|
|
2943
|
+
*
|
|
2944
|
+
* Fires when an `AdService` video closes.
|
|
2945
|
+
*
|
|
2946
|
+
* - **ThreadSafety**: Unsafe
|
|
2947
|
+
* - **Tags**:
|
|
2948
|
+
*
|
|
2949
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#VideoAdClosed)
|
|
2950
|
+
*
|
|
2951
|
+
* @deprecated
|
|
2952
|
+
*/
|
|
2953
|
+
readonly VideoAdClosed: RBXScriptSignal<(adShown: boolean) => void>;
|
|
2954
|
+
}
|
|
2858
2955
|
/**
|
|
2859
2956
|
* Collection of methods that allows developers to track how users interact with their experiences.
|
|
2860
2957
|
*
|
|
@@ -6,6 +6,7 @@ interface Services {
|
|
|
6
6
|
AccountService: AccountService;
|
|
7
7
|
AchievementService: AchievementService;
|
|
8
8
|
ActivityHistoryEventService: ActivityHistoryEventService;
|
|
9
|
+
AdService: AdService;
|
|
9
10
|
AnalyticsService: AnalyticsService;
|
|
10
11
|
AnimationClipProvider: AnimationClipProvider;
|
|
11
12
|
AnimationFromVideoCreatorService: AnimationFromVideoCreatorService;
|
|
@@ -1080,6 +1081,23 @@ interface AdPortal extends Instance {
|
|
|
1080
1081
|
*/
|
|
1081
1082
|
readonly _nominal_AdPortal: unique symbol;
|
|
1082
1083
|
}
|
|
1084
|
+
/**
|
|
1085
|
+
* A class that allows the display of mobile video ads.
|
|
1086
|
+
*
|
|
1087
|
+
* - **Tags**: NotCreatable, Service
|
|
1088
|
+
*
|
|
1089
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService)
|
|
1090
|
+
*/
|
|
1091
|
+
interface AdService extends Instance {
|
|
1092
|
+
/**
|
|
1093
|
+
* **DO NOT USE!**
|
|
1094
|
+
*
|
|
1095
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
1096
|
+
* @hidden
|
|
1097
|
+
* @deprecated
|
|
1098
|
+
*/
|
|
1099
|
+
readonly _nominal_AdService: unique symbol;
|
|
1100
|
+
}
|
|
1083
1101
|
/**
|
|
1084
1102
|
* Collection of methods that allows developers to track how users interact with their experiences.
|
|
1085
1103
|
*
|