Daily Rewards

You are reading the documentation for Bridge SDK v2. If you need the obsolete v1 documentation, see Documentation (v1).

Daily login rewards: the game declares an ordered list of reward ids (one per day), and Bridge tracks the current day, claims, and streak resets.

Configuration

Declare the rewards in the config under the dailyRewards key:

{
    "dailyRewards": {
        "rewards": ["100_coins", "200_coins", "1_gem", "300_coins", "2_gems", "500_coins", "5_gems"],
        "cycle": true,        // optional, default true — restart from day 1 after the last reward
        "resetOnMiss": true   // optional, default true — reset the streak when a day is missed
    }
}

Get Rewards

Returns the configured ordered list of reward ids.

const rewards = await bridge.dailyRewards.getRewards() // string[]

Bridge.dailyRewards.GetRewards((success, rewards) =>
{
    if (success)
    {
        // rewards is an ordered string[] of reward ids
    }
});

Call the Daily Rewards Get Rewards action, then handle the On Daily Rewards Get Rewards Completed trigger. Read the result with the DailyRewardsCount and DailyRewardsReward(index) expressions, or take the whole list with DailyRewardsAsJSON.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"daily-rewards-get-rewards","objectClass":"PlaygamaBridge"}]},{"eventType":"block","conditions":[{"id":"on-daily-rewards-get-rewards-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"for","objectClass":"System","parameters":{"name":"\"rewards\"","start-index":"0","end-index":"PlaygamaBridge.DailyRewardsCount - 1"}}],"actions":[{"id":"log","objectClass":"Browser","parameters":{"type":"log","message":"PlaygamaBridge.DailyRewardsReward(loopindex(\"rewards\"))"}}]}]}]}

Call the Daily Rewards Get Rewards action, then handle the On Daily Rewards Get Rewards Completed condition. Read the result with the PlaygamaBridge::DailyRewardsCount() and PlaygamaBridge::DailyRewardId(index) expressions, or take the whole list with PlaygamaBridge::DailyRewardsAsJSON().

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::DailyRewardsGetRewards"},"parameters":["",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnDailyRewardsGetRewardsCompleted"},"parameters":["",""]}],"actions":[{"type":{"value":"SetNumberVariable"},"parameters":["CurrentIndex","=","0"]}],"events":[{"type":"BuiltinCommonInstructions::Repeat","repeatExpression":"PlaygamaBridge::DailyRewardsCount()","conditions":[],"actions":[],"events":[{"type":"BuiltinCommonInstructions::Standard","conditions":[],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["PlaygamaBridge::DailyRewardId(CurrentIndex)","\"info\"",""]},{"type":{"value":"SetNumberVariable"},"parameters":["CurrentIndex","+","1"]}]}]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

Bridge.daily_rewards.get_rewards(funcref(self, "_on_get_rewards_completed"))

func _on_get_rewards_completed(success, rewards):
    if success:
        for reward in rewards:
            print(reward)

Bridge.daily_rewards.get_rewards(Callable(self, "_on_get_rewards_completed"))

func _on_get_rewards_completed(success, rewards):
    if success:
        for reward in rewards:
            print(reward)

playgama_bridge_daily_rewards_get_rewards()

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_daily_rewards_get_rewards_callback" {
    if async_load[? "success"] {
        var rewards = json_parse(async_load[? "data"])
    }
}

local bridge = require("bridge.bridge")

function init(self)
    bridge.daily_rewards.get_rewards(
        function (_, rewards_json)
            local rewards = json.decode(rewards_json)
            for _, reward in ipairs(rewards) do
                print(reward)
            end
        end,
        function ()
            -- error
        end
    )
end

const rewards = await bridge.dailyRewards.getRewards() // string[]

Get Current Day

Returns the 0-based index (into the rewards list) of the reward the player is currently on.

const day = await bridge.dailyRewards.getCurrentDay() // number

Bridge.dailyRewards.GetCurrentDay((success, day) =>
{
    Debug.Log($"Current day: {day}");
});

Call the Daily Rewards Get Current Day action, then handle the On Daily Rewards Get Current Day Completed trigger and read the DailyRewardsCurrentDay expression.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"daily-rewards-get-current-day","objectClass":"PlaygamaBridge"}]},{"eventType":"block","conditions":[{"id":"on-daily-rewards-get-current-day-completed","objectClass":"PlaygamaBridge"}],"actions":[{"id":"log","objectClass":"Browser","parameters":{"type":"log","message":"PlaygamaBridge.DailyRewardsCurrentDay"}}]}]}

Call the Daily Rewards Get Current Day action, then handle the On Daily Rewards Get Current Day Completed condition and read the PlaygamaBridge::DailyRewardsCurrentDay() expression.

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::DailyRewardsGetCurrentDay"},"parameters":["",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnDailyRewardsGetCurrentDayCompleted"},"parameters":["",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["ToString(PlaygamaBridge::DailyRewardsCurrentDay())","\"info\"",""]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

Bridge.daily_rewards.get_current_day(funcref(self, "_on_get_current_day_completed"))

func _on_get_current_day_completed(success, day):
    print(day)

Bridge.daily_rewards.get_current_day(Callable(self, "_on_get_current_day_completed"))

func _on_get_current_day_completed(success, day):
    print(day)

playgama_bridge_daily_rewards_get_current_day()

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_daily_rewards_get_current_day_callback" {
    if async_load[? "success"] {
        var day = real(async_load[? "data"])
    }
}

local bridge = require("bridge.bridge")

function init(self)
    bridge.daily_rewards.get_current_day(
        function (_, day)
            print(day)
        end,
        function ()
            -- error
        end
    )
end

const day = await bridge.dailyRewards.getCurrentDay() // number

Get Current Reward

Returns the id of the reward claimable today, or null when nothing can be claimed (already claimed today, or the streak is finished and cycle is off).

const reward = await bridge.dailyRewards.getCurrentReward() // string | null

Bridge.dailyRewards.GetCurrentReward((success, reward) =>
{
    if (success && reward != null)
    {
        // reward is claimable today
    }
});

Call the Daily Rewards Get Current Reward action, then handle the On Daily Rewards Get Current Reward Completed trigger. The Is Daily Rewards Current Reward Available condition tells whether anything can be claimed; read the id with the DailyRewardsCurrentReward expression.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"daily-rewards-get-current-reward","objectClass":"PlaygamaBridge"}]},{"eventType":"block","conditions":[{"id":"on-daily-rewards-get-current-reward-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"is-daily-rewards-current-reward-available","objectClass":"PlaygamaBridge"}],"actions":[{"id":"log","objectClass":"Browser","parameters":{"type":"log","message":"PlaygamaBridge.DailyRewardsCurrentReward"}}]}]}]}

Call the Daily Rewards Get Current Reward action, then handle the On Daily Rewards Get Current Reward Completed condition and read the PlaygamaBridge::DailyRewardsCurrentReward() expression (empty string when nothing can be claimed).

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::DailyRewardsGetCurrentReward"},"parameters":["",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnDailyRewardsGetCurrentRewardCompleted"},"parameters":["",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["PlaygamaBridge::DailyRewardsCurrentReward()","\"info\"",""]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

Bridge.daily_rewards.get_current_reward(funcref(self, "_on_get_current_reward_completed"))

func _on_get_current_reward_completed(success, reward):
    if success and reward != null:
        # reward is claimable today
        print(reward)

Bridge.daily_rewards.get_current_reward(Callable(self, "_on_get_current_reward_completed"))

func _on_get_current_reward_completed(success, reward):
    if success and reward != null:
        # reward is claimable today
        print(reward)

playgama_bridge_daily_rewards_get_current_reward()

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_daily_rewards_get_current_reward_callback" {
    if async_load[? "success"] {
        var reward = async_load[? "data"] // undefined when nothing can be claimed
    }
}

local bridge = require("bridge.bridge")

function init(self)
    bridge.daily_rewards.get_current_reward(
        function (_, reward)
            if reward then
                -- reward is claimable today
                print(reward)
            end
        end,
        function ()
            -- error
        end
    )
end

const reward = await bridge.dailyRewards.getCurrentReward() // string | null

Claim Current Reward

Claims today's reward. Resolves to true on success and advances the streak, or false when nothing is claimable.

bridge.dailyRewards.claimCurrentReward()
    .then(() => {
        // grant the current reward
    })

Bridge.dailyRewards.ClaimCurrentReward(claimed =>
{
    if (claimed)
    {
        // grant the current reward
    }
});

Call the Daily Rewards Claim Current Reward action, then handle the On Daily Rewards Claim Current Reward Completed trigger — Is Last Action Completed Successfully is true only when the reward was actually claimed.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"daily-rewards-claim-current-reward","objectClass":"PlaygamaBridge"}]},{"eventType":"block","conditions":[{"id":"on-daily-rewards-claim-current-reward-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"is-last-action-completed-successfully","objectClass":"PlaygamaBridge"}],"actions":[{"type":"comment","text":"claimed - grant the current reward"}]}]}]}

Call the Daily Rewards Claim Current Reward action, then handle the On Daily Rewards Claim Current Reward Completed condition — Is Last Action Completed Successfully is true only when the reward was actually claimed.

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::DailyRewardsClaimCurrentReward"},"parameters":["",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnDailyRewardsClaimCurrentRewardCompleted"},"parameters":["",""]}],"events":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::IsLastActionCompletedSuccessfully"},"parameters":["",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"claimed\"","\"info\"",""]}]}],"actions":[]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

Bridge.daily_rewards.claim_current_reward(funcref(self, "_on_claim_current_reward_completed"))

func _on_claim_current_reward_completed(claimed):
    if claimed:
        # grant the current reward
        pass

Bridge.daily_rewards.claim_current_reward(Callable(self, "_on_claim_current_reward_completed"))

func _on_claim_current_reward_completed(claimed):
    if claimed:
        # grant the current reward
        pass

playgama_bridge_daily_rewards_claim_current_reward()

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_daily_rewards_claim_current_reward_callback" {
    if async_load[? "success"] {
        // claimed - grant the current reward
    }
}

local bridge = require("bridge.bridge")

function init(self)
    bridge.daily_rewards.claim_current_reward(
        function ()
            -- claimed, grant the current reward
        end,
        function ()
            -- nothing claimable or error
        end
    )
end

bridge.dailyRewards.claimCurrentReward()
    .then(() => {
        // grant the current reward
    })

PreviousTasks NextSocial

Last updated 1 month ago