Skip to main content

Quick Start

Functions

Start an interactive signal breach hacking mini-game.
Parameters:
  • title (string, optional) - Title for the signal breach
  • difficulty (string | table, required) - Difficulty level or custom config object (see Difficulty Levels)
  • inputs (string | table, optional) - Single input key or array of input keys (default: 'E')
  • options (table, optional) - Additional options (see Options)
Returns:
  • success (boolean) - true if the signal breach was completed successfully, false if failed or cancelled
Cancel the currently active signal breach.
Check if a signal breach is currently active.
Returns:
  • isActive (boolean) - true if a signal breach is active, false otherwise

Configuration

Options

title
string
Title displayed for the signal breach
difficulty
string | table
required
Difficulty level or custom difficulty objectSee Difficulty Levels for available options
inputs
string | table
default:"E"
Single input key or array of input keys
options.speedIncrease
number
Amount to increase the indicator speed after each successful node (e.g. 0.08)
options.windowDecrease
number
Amount to shrink the target window after each successful node (e.g. 2)
options.failOnWrongKey
boolean
If true, pressing the wrong key immediately fails the breach (default: false)
options.onNode
function
Callback fired after each node attempt

Difficulty Levels

Use predefined difficulty levels for quick setup.
easy
string
3 nodes, large window, slow speed
medium
string
4 nodes, medium window, medium speed
hard
string
5 nodes, small window, fast speed
Example:

Preview

Signal Breach Example