Minigames

lation ui has three minigames. Each export waits until the game ends and returns true on success or false on failure, so run it from a thread, command or event handler. One of each can run at a time: calling one while it's already running returns false at once.

Skill checkCopy Anchor Link

A ring with a green zone and a moving line. The player presses the shown key while the line is in the zone.

skillCheckCopy Anchor Link

local success = exports.lation_ui:skillCheck(title, difficulty, inputs, size)

A custom difficulty is { areaSize = 30, speedMultiplier = 2.0 }: the zone's size in degrees, and the speed against easy.

A round fails when the player presses the shown key outside the zone, presses another key from inputs, or lets the line go all the way round. Keys that aren't in inputs are ignored. With a list of difficulties, the first failed round ends the game.

local success = exports.lation_ui:skillCheck('Picking lock', { 'easy', 'easy', 'medium' }, { 'W', 'A', 'S', 'D' })

cancelSkillCheckCopy Anchor Link

local cancelled = exports.lation_ui:cancelSkillCheck()

Ends the running skill check as a failure: its skillCheck call returns false.

skillCheckActiveCopy Anchor Link

local active = exports.lation_ui:skillCheckActive()

Signal breachCopy Anchor Link

A row of nodes and a dial that moves along a bar. For each node the player presses the shown key while the dial is inside the window. Hitting every node wins; one miss fails.

signalBreachCopy Anchor Link

local success = exports.lation_ui:signalBreach(title, difficulty, inputs, options)

A custom difficulty is { nodes = 6, windowSize = 22, speed = 0.40 }. nodes is held to 1 to 20, windowSize (percent of the bar) to 3 to 80, and speed to 0.05 to 2, on the same scale as the presets.

Escape or Backspace gives up, which counts as a failure, unless those keys are in inputs. The breach also fails if the minigame doesn't open within 3 seconds, or if the player loses focus on it for about a second and a half, so a stuck screen never leaves your script waiting.

local success = exports.lation_ui:signalBreach('Crack encryption', {
    nodes = 6,
    windowSize = 22,
    speed = 0.40
}, 'E', {
    speedIncrease = 0.06,
    windowDecrease = 2,
    onNode = function(node, hit)
        print(('Node %d: %s'):format(node, hit and 'hit' or 'miss'))
    end
})

onNodeCopy Anchor Link

onNode = function(node, success) end

Runs each time the player presses the node's key or, with failOnWrongKey, a wrong one. Giving up with Escape doesn't run it.

cancelSignalBreachCopy Anchor Link

local cancelled = exports.lation_ui:cancelSignalBreach()

Ends the running breach as a failure: its signalBreach call returns false.

signalBreachActiveCopy Anchor Link

local active = exports.lation_ui:signalBreachActive()

Pattern lockCopy Anchor Link

A grid of dots lights up in sequence. The player then clicks the dots in the same order before the timer runs out.

patternLockCopy Anchor Link

local success = exports.lation_ui:patternLock(title, difficulty)

A custom difficulty is { gridSize = 4, sequenceLength = 6, showSpeed = 400, inputTimeout = 15 }. gridSize is held to 3 to 5, sequenceLength to 2 to 12, showSpeed (milliseconds) to 150 to 1500, and inputTimeout (seconds) to 5 to 30.

A wrong dot, running out of time or pressing Escape fails the round. With a list of difficulties, the first failed round ends the game.

local success = exports.lation_ui:patternLock('Thermite prep', { 'easy', 'medium', 'hard' })

cancelPatternLockCopy Anchor Link

local cancelled = exports.lation_ui:cancelPatternLock()

Ends the running pattern lock as a failure: its patternLock call returns false.

patternLockActiveCopy Anchor Link

local active = exports.lation_ui:patternLockActive()

-- The alarm went off: stop whichever minigame the player is in
RegisterNetEvent('my_heist:alarm', function()
    if exports.lation_ui:skillCheckActive() then exports.lation_ui:cancelSkillCheck() end
    if exports.lation_ui:signalBreachActive() then exports.lation_ui:cancelSignalBreach() end
    if exports.lation_ui:patternLockActive() then exports.lation_ui:cancelPatternLock() end
end)