Unlockables queued unlock feature.

base.go

@@ -194,7 +194,7 @@ func (sc *systemConfig) GetExtra() any {
 }
 
 // OnReward is a function which can be used by each gameplay system to provide an override reward.
-type OnReward[T any] func(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string, source T, rewardConfig *EconomyConfigReward, reward *Reward) (*Reward, error)
+type OnReward[T any] func(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, sourceID string, source T, rewardConfig *EconomyConfigReward, reward *Reward) (*Reward, error)
 
 // A System is a base type for a gameplay system.
 type System interface {

economy.go

@@ -180,6 +180,14 @@ type EconomyConfigStoreItemCost struct {
 	Sku        string           `json:"sku,omitempty"`
 }
 
+// EconomyPlacementInfo contains information about a placement instance.
+type EconomyPlacementInfo struct {
+	// Placement configuration.
+	Placement *EconomyConfigPlacement `json:"placement,omitempty"`
+	// Metadata, if any was set when the placement was started.
+	Metadata map[string]string `json:"metadata,omitempty"`
+}
+
 // The EconomySystem is the foundation of a game's economy.
 //
 // It provides functionality for 4 different reward types: basic, gacha, weighted table, and custom. These rolled
@@ -206,16 +214,16 @@ type EconomySystem interface {
 	DonationGet(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userIDs []string) (*EconomyDonationsByUserList, error)
 
 	// DonationGive will contribute to a particular donation for a user ID.
-	DonationGive(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, donationID, fromUserID string) (map[string]int64, *Inventory, *Reward, error)
+	DonationGive(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, donationID, fromUserID string) (map[string]int64, *Inventory, []*ActiveRewardModifier, *Reward, int64, error)
 
 	// DonationRequest will create a donation request for a given donation ID and user ID.
 	DonationRequest(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, donationID string) (*EconomyDonation, bool, error)
 
 	// List will get the defined store items and placements within the economy system.
-	List(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string) (map[string]*EconomyConfigStoreItem, map[string]*EconomyConfigPlacement, error)
+	List(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string) (map[string]*EconomyConfigStoreItem, map[string]*EconomyConfigPlacement, []*ActiveRewardModifier, int64, error)
 
 	// Grant will add currencies, and reward modifiers to a user's economy by ID.
-	Grant(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string, currencies map[string]int64, items map[string]int64, modifiers []*RewardModifier, walletMetadata map[string]interface{}) (map[string]int64, error)
+	Grant(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID string, currencies map[string]int64, items map[string]int64, modifiers []*RewardModifier, walletMetadata map[string]interface{}) (map[string]int64, []*ActiveRewardModifier, int64, error)
 
 	// UnmarshalWallet unmarshals and returns the account's wallet as a map[string]int64.
 	UnmarshalWallet(account *api.Account) (map[string]int64, error)
@@ -233,13 +241,13 @@ type EconomySystem interface {
 	PlacementStatus(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, rewardID, placementID string, retryCount int) (*EconomyPlacementStatus, error)
 
 	// PlacementStart will indicate that a user ID has begun viewing an ad placement.
-	PlacementStart(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, placementID string) (*EconomyPlacementStatus, error)
+	PlacementStart(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, placementID string, metadata map[string]string) (*EconomyPlacementStatus, error)
 
 	// PlacementSuccess will indicate that the user ID has successfully viewed an ad placement and provide the appropriate reward.
-	PlacementSuccess(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, rewardID, placementID string) (*Reward, error)
+	PlacementSuccess(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, rewardID, placementID string) (*Reward, map[string]string, error)
 
 	// PlacementFail will indicate that the user ID has failed to successfully view the ad placement.
-	PlacementFail(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, rewardID, placementID string) error
+	PlacementFail(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, rewardID, placementID string) (map[string]string, error)
 
 	// SetOnDonationClaimReward sets a custom reward function which will run after a donation's reward is rolled.
 	SetOnDonationClaimReward(fn OnReward[*EconomyConfigDonation])
@@ -248,7 +256,7 @@ type EconomySystem interface {
 	SetOnDonationContributorReward(fn OnReward[*EconomyConfigDonation])
 
 	// SetOnPlacementReward sets a custom reward function which will run after a placement's reward is rolled.
-	SetOnPlacementReward(fn OnReward[*EconomyConfigPlacement])
+	SetOnPlacementReward(fn OnReward[*EconomyPlacementInfo])
 
 	// SetOnStoreItemReward sets a custom reward function which will run after store item's reward is rolled.
 	SetOnStoreItemReward(fn OnReward[*EconomyConfigStoreItem])

go.sum

@@ -1,14 +1,6 @@
-github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
 github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
-github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/heroiclabs/nakama-common v1.31.0 h1:oaJbwVRUiFXA77gXF3XNrGCmR0CXf7+2vXEvaBLkP6w=
-github.com/heroiclabs/nakama-common v1.31.0/go.mod h1:Os8XeXGvHAap/p6M/8fQ3gle4eEXDGRQmoRNcPQTjXs=
 github.com/heroiclabs/nakama-common v1.32.0 h1:aCWyYf9mQzifeVu3bXBiRRL9Z/dGBgwY/rgUWoYCnQM=
 github.com/heroiclabs/nakama-common v1.32.0/go.mod h1:lPG64MVCs0/tEkh311Cd6oHX9NLx2vAPx7WW7QCJHQ0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
-google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
-google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg=
 google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=