Skip to main content

​
Quick Start

local success = exports.lation_ui:skillCheck('Lockpick', 'easy', 'E')

if success then
    print('Success')
else
    print('Failed')
end

​
Functions

Start an interactive skill check mini-game.
local success = exports.lation_ui:skillCheck(title, difficulty, inputs, size)
Parameters:
  • title (string, required) - Title for the skill check
  • difficulty (string | table, required) - Difficulty level or array of difficulties (see Difficulty Levels)
  • inputs (string | table, optional) - Single input key or array of input keys (default: 'E')
  • size (string, optional) - Size variant: 'normal' or 'compact' (default: 'normal')
Returns:
  • success (boolean) - true if all skill checks completed successfully, false if failed or cancelled
Cancel the currently active skill check.
exports.lation_ui:cancelSkillCheck()
Check if a skill check is currently active.
local isActive = exports.lation_ui:skillCheckActive()
Returns:
  • isActive (boolean) - true if a skill check is active, false otherwise

​
Configuration

​
Options

​
title
string
required
Title displayed for the skill check
​
difficulty
string | table
required
Difficulty level or array of difficulty levelsSee Difficulty Levels for available options
​
inputs
string | table
default:"E"
Single input key or array of input keysCan be a single key (e.g., 'E') or multiple keys for sequential checks (e.g., {'W', 'A', 'S', 'D'})
​
size
string
default:"normal"
Size variant of the skill check UIAvailable options:
  • 'normal' - Full UI with instructions
  • 'compact' - Minimal UI (just circle and key)

​
Difficulty Levels

Use predefined difficulty levels for quick setup.
​
easy
string
Large target area, slow speed
​
medium
string
Medium target area, medium speed
​
hard
string
Small target area, fast speed
Example:
-- Single difficulty
local success = exports.lation_ui:skillCheck('Lockpick', 'easy', 'E')

-- Multiple difficulties (sequential)
local success = exports.lation_ui:skillCheck('Lockpick', {'easy', 'medium', 'hard'}, {'E', 'E', 'E'})

​
Preview

Skill Check Preview