1. Epic GamesDeveloper
  3. FOnlinePurchaseSteam

FOnlinePurchaseSteam

The Steam purchase interface is designed to handle microtransactions in-game, not DLC entitlements (use the external UI to show the Steam store for those) Steam microtransactions are not defined by the server, but rather by the client.

API > API/Plugins > API/Plugins/OnlineSubsystemSteam

Inheritance Hierarchy

References

   
Module OnlineSubsystemSteam
Header /Engine/Plugins/Online/OnlineSubsystemSteam/Source/Public/OnlinePurchaseInterfaceSteam.h
Include #include "OnlinePurchaseInterfaceSteam.h"

Syntax

class FOnlinePurchaseSteam :  
    public IOnlinePurchase ,  
    public TSharedFromThis< FOnlinePurchaseSteam, ESPMode::ThreadSafe >

Remarks

The Steam purchase interface is designed to handle microtransactions in-game, not DLC entitlements (use the external UI to show the Steam store for those) Steam microtransactions are not defined by the server, but rather by the client. UE lets us define these microtransactions in two ways

1) Config Driven Config driven microtransactions can be datamined, and can possibily be tampered if your backend server does not have the proper protections in place to verify the transaction. Therefore it is only recommended for development/debug flows. To add a new static microtransaction to Steam, add the following in your game's Engine file [OnlineSubsystemSteam] +StaticMicrotransactions=(Id=32bitinteger, Amount=costofitem, Description=myMicroTransaction)

2) Server-driven

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void  
Public function Const TSharedPtr< FOnlineStoreOffer >

GetStoreOffer ( const FUniqueOfferId& OfferId
)

  
Public function Const void  
Public function void  

Overridden from IOnlinePurchase

  Type Name Description
Public function Virtual void

Checkout ( const FUniqueNetId& UserId,
const FPurchaseCheckoutRequest& CheckoutRequest,
const FOnPurchaseCheckoutComplete& Delegate
)

 Initiate the checkout process for purchasing offers via payment
Public function Virtual void

Checkout ( const FUniqueNetId& UserId,
const FPurchaseCheckoutRequest& CheckoutRequest,
const FOnPurchaseReceiptlessCheckoutComplete& Delegate
)

 Initiate the checkout process for purchasing offers via payment without receipts returned Recommended for use when the entitlement or receipt information of the purchase is not needed by the caller
Public function Virtual void

FinalizePurchase ( const FUniqueNetId& UserId,
const FString& ReceiptId
)

 Finalizes a purchase with the supporting platform Acknowledges that the purchase has been properly redeemed by the application
Public function Virtual void

FinalizeReceiptValidationInfo ( const FUniqueNetId& UserId,
FString& InReceiptValidationInfo,
const FOnFinalizeReceiptValidationInfoComplete& Delegate
)

  
Public function Virtual Const void

GetReceipts ( const FUniqueNetId& UserId,
TArray< FPurchaseReceipt >& OutReceipts
)

 Get list of cached receipts for user (includes transactions currently being processed)
Public function Virtual bool

IsAllowedToPurchase ( const FUniqueNetId& UserId
)

 Determine if user is allowed to purchase from store
Public function Virtual void

QueryReceipts ( const FUniqueNetId& UserId,
bool bRestoreReceipts,
const FOnQueryReceiptsComplete& Delegate
)

 Query for all of the user's receipts from prior purchases
Public function Virtual void

RedeemCode ( const FUniqueNetId& UserId,
const FRedeemCodeRequest& RedeemCodeRequest,
const FOnPurchaseRedeemCodeComplete& Delegate
)

 Initiate the checkout process for obtaining offers via code redemption

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page