Minigame <BadgeClient/>

A module to run interactive minigames in your scripts.

JO Functions > jo.minigame.cancel()

<!-- @include: ./slots/headers.md#client|jo.minigame.cancel -->

Cancels the currently running minigame. <br>

<!-- @include: ./slots/descriptions.md#client|jo.minigame.cancel -->

JO Functions > jo.minigame.cancel() > Syntax

jo.minigame.cancel()

JO Functions > jo.minigame.cancel() > Return Value

Type : boolean

<!-- @include: ./slots/examples.md#client|jo.minigame.cancel -->

<!-- @include: ./slots/footers.md#client|jo.minigame.cancel -->

JO Functions > jo.minigame.lockpick()

<!-- @include: ./slots/headers.md#client|jo.minigame.lockpick -->

Starts the lockpick minigame. <br>

<!-- @include: ./slots/descriptions.md#client|jo.minigame.lockpick -->

JO Functions > jo.minigame.lockpick() > Syntax

jo.minigame.lockpick(config)

JO Functions > jo.minigame.lockpick() > Parameters

config : table <BadgeOptional />

The lockpick configuration

config.pins : integer - Number of lockpicks available before failure; default: 1 <BadgeOptional />

config.pinHealth : integer - Health of each lockpick; default: 100 <BadgeOptional />

config.pinDamage : integer - Damage applied when forcing the lock at a wrong angle; default: 20 <BadgeOptional />

config.pinDamageInterval : integer - Minimum delay in milliseconds between two damage ticks; default: 150 <BadgeOptional />

config.solvePadding : number - Angle tolerance in degrees around the correct position; default: 4 <BadgeOptional />

config.maxDistFromSolve : number - Maximum angle distance used to calculate cylinder allowance; default: 45 <BadgeOptional />

config.cylRotSpeed : number - Cylinder rotation speed per tick while pushing; default: 3 <BadgeOptional />

config.onPinBroken : function - Called each time a lockpick pin breaks <BadgeOptional />

config.animPostFx : string|false - AnimPostFX effect to play while the minigame is open; default: "PauseMenuIn"; use false to disable <BadgeOptional />

JO Functions > jo.minigame.lockpick() > Return Value

Type : "success"|"failed"|"canceled"|"busy"

<!-- @include: ./slots/examples.md#client|jo.minigame.lockpick -->

<!-- @include: ./slots/footers.md#client|jo.minigame.lockpick -->

JO Functions > jo.minigame.qte()

<!-- @include: ./slots/headers.md#client|jo.minigame.qte -->

Starts the QTE minigame. <br>

<!-- @include: ./slots/descriptions.md#client|jo.minigame.qte -->

JO Functions > jo.minigame.qte() > Syntax

jo.minigame.qte(config)

JO Functions > jo.minigame.qte() > Parameters

config : table <BadgeOptional />

The QTE configuration

config.roundCount : integer - Number of QTE rounds to complete; default: 4 <BadgeOptional />

config.allowedKeys : string[] - Allowed keys; default: A-Z <BadgeOptional />

config.rotationCount : integer - Number of full indicator rotations allowed per round; default: 1 <BadgeOptional />

config.targetStartAngle : table - Target segment start angle range in degrees <BadgeOptional />

config.targetStartAngle.min : number - Minimum target start angle; default: 100 <BadgeOptional />

config.targetStartAngle.max : number - Maximum target start angle; default: 300 <BadgeOptional />

config.targetArcSize : table - Target segment size angle range in degrees <BadgeOptional />

config.targetArcSize.min : number - Minimum target size; default: 50 <BadgeOptional />

config.targetArcSize.max : number - Maximum target size; default: 60 <BadgeOptional />

config.rotationDuration : table - Full rotation duration range in milliseconds <BadgeOptional />

config.rotationDuration.min : integer - Minimum duration; default: 2000 <BadgeOptional />

config.rotationDuration.max : integer - Maximum duration; default: 3000 <BadgeOptional />

config.introDelay : integer - Delay in milliseconds before the indicator starts after the intro animation; default: 200 <BadgeOptional />

config.successDelay : integer - Delay in milliseconds before continuing after a successful round; default: 450 <BadgeOptional />

config.failureDelay : integer - Delay in milliseconds before closing after a failed round; default: 550 <BadgeOptional />

config.roundDelay : integer - Delay in milliseconds between a successful round and the next intro; default: 100 <BadgeOptional />

config.animPostFx : string|false - AnimPostFX effect to play while the minigame is open; default: "PauseMenuIn"; use false to disable <BadgeOptional />

JO Functions > jo.minigame.qte() > Return Value

Type : "success"|"failed"|"canceled"|"busy"

<!-- @include: ./slots/examples.md#client|jo.minigame.qte -->

<!-- @include: ./slots/footers.md#client|jo.minigame.qte -->