editable/client.lua

All hooks live in editable/client.lua (escrow-open). Return values must match the signatures below.

Skill checks

Called while maintaining a still. Return true if the player passed.

function StillSkillcheck()
    -- https://github.com/Legends-Rising/legends-keypress
    if GetResourceState('legends-keypress') ~= 'started' then
        return true
    end
    return exports['legends-keypress']:startkp(math.random(8, 10), math.random(6, 8))
end

Called while stirring mash. Return true if the player passed.

function MashSkillcheck()
    -- https://github.com/Legends-Rising/legends-keypress
    if GetResourceState('legends-keypress') ~= 'started' then
        return true
    end
    return exports['legends-keypress']:startkp(math.random(15, 20), math.random(12, 16))
end

Replace the legends-keypress export with any minigame that returns a boolean.

Equipment placement

Fired before equipment is placed. equipmentType is 'Still' or 'Mash'. Return false to block.

function CanPlaceEquipment(equipmentType)
    if equipmentType == 'Still' then
        return true
    end

    if equipmentType == 'Mash' then
        return true
    end

    return false
end

Can interact

Fired after a player completes an equipment UIPrompt. Return false to block the action.

The function name keeps the historical spelling (CanInteractWithEquipmennt).

function CanInteractWithEquipmennt()
    return true
end

Skill checks

Equipment placement

Can interact

On this page