Health Regeneration on Grind Rails

using { /Fortnite.com/Devices }
using { /Verse.org/Simulation }
using { /Fortnite.com/Characters }

using { /UnrealEngine.com/Temporary/Diagnostics }

# See https://dev.epicgames.com/documentation/en-us/uefn/create-your-own-device-in-verse for how to create a verse device.
# A Verse-authored creative device that mucst be placed in a level for it to work

# This device will regenerate the player's health when they are grinding on a rail
# The amount of health to regenerate per second is chosen in the editor
# The rail that the player must grind on is chosen in the editor
health_regen_device := class(creative_device):
    
    # Grind rail in the level
    @editable
    GrindingRail:grind_rail_device = grind_rail_device{}
    
    # The cooldown period between health regen ticks
    @editable_number(float):
        MinValue:=option{0.1}
    Cooldown:float = 1.0

    # The amount of health to regenerate per second
    @editable_number(float):
        MinValue:=option{1.0}
    HealthRegenRate:float = 5.0
    
    OnBegin<override>()<suspends>:void=
        # Subscribe to the event that is fired when the player starts grinding
        GrindingRail.StartedGrindingEvent.Subscribe(OnGrindingStarted)