Genie's Lamp of Threefold Rubbing

using { /Fortnite.com/Devices }
using { /Verse.org/Simulation }
using { /Fortnite.com/Characters }
using { /Fortnite.com/Game }
using { /UnrealEngine.com/Temporary/SpatialMath }
using { /UnrealEngine.com/Temporary/Diagnostics }

# Genie's Lamp Puzzle - rub the lamp three times in a row to summon
# the genie and reveal a hidden reward.
genies_lamp_puzzle_device := class(creative_device):

    # The lamp itself - the player interacts with this to "rub" it.
    @editable
    LampTrigger : trigger_device = trigger_device{}

    # A hidden trigger that reveals the reward once the puzzle is solved
    # (wire this to whatever prop/vault/door you want unlocked in-world).
    @editable
    RewardTrigger : trigger_device = trigger_device{}

    # Gives the player feedback as they work through the puzzle.
    @editable
    FeedbackHUD : hud_message_device = hud_message_device{}

    # How many rubs the lamp needs before the genie appears.
    var RubCount : int = 0
    RubsNeeded : int = 3

    # --- Message text, built with <localizes> so it can hold a message type ---
    WelcomeMessage<localizes>() : message = "A dusty lamp sits before you... Rub it to awaken the genie!"
    ProgressMessage<localizes>(Count : int, Needed : int) : message = "The lamp shimmers... ({Count}/{Needed})"
    UnlockedMessage<localizes>() : message = "The genie appears! Your hidden reward is revealed!"

    OnBegin<override>()<suspends> : void =
        # Show the opening message to everyone on the island.
        FeedbackHUD.SetText(WelcomeMessage())
        FeedbackHUD.Show()

        # Listen for every rub of the lamp.
        LampTrigger.TriggeredEvent.Subscribe(OnLampRubbed)

    OnLampRubbed(MaybeAgent : ?agent) : void =
        # Unwrap the agent that triggered the lamp (fails safely if none).
        if (Agent := MaybeAgent?):
            set RubCount += 1

            if (RubCount = RubsNeeded):
                # Puzzle solved! Fire the hidden reward trigger and celebrate.
                FeedbackHUD.SetText(UnlockedMessage())
                FeedbackHUD.Show(Agent)
                RewardTrigger.Trigger(Agent)
                # Lock the lamp so it can't be rubbed (and re-solved) again.
                LampTrigger.Disable()
            else:
                # Still working toward the goal - give progress feedback.
                FeedbackHUD.SetText(ProgressMessage(RubCount, RubsNeeded))
                FeedbackHUD.Show(Agent)