Skip to content
⌘ K

Riddle Minigame

Riddle Game Minigame Documentation#

This documentation explains the usage and integration of the "Riddle Game" minigame for FiveM.

What is the Riddle Game?#

The "Riddle Game" is a grid-based puzzle game where players must arrange blocks to form specific shapes, such as an inverted L, zigzag, or other predefined patterns. Players are given a limited amount of time to complete the task by moving the blocks within the grid.

Key Features:

  • Timed Gameplay: Players must complete the task within the given time frame.
  • Shape Matching: Players are tasked with forming specific shapes by manipulating the grid blocks.
  • Success/Failure Condition: Success is achieved if the shape is completed within the time. Failure occurs if time runs out or the wrong shape is formed.

Export Usage#

This minigame can be triggered and controlled via the export function provided.

Parameters:

  • callback (function): The function to be triggered when the game ends.
  • duration (integer): The time limit for the game (in seconds).
  • header (string): The text displayed at the top of the game as a header.
  • text (string): Descriptive or instructional text for the game.
  • cols (integer): Number of columns in the grid.
  • rows (integer): Number of rows in the grid.

Command Example:

lua
RegisterCommand("riddletest", function()
    exports['frkn-riddlegame']:riddleGame(function(success)
        if success then
            TriggerEvent("chatMessage", "SYSTEM", "success", "Riddle Game completed!")
        else
            TriggerEvent("chatMessage", "SYSTEM", "error", "Riddle Game failed!")
        end
    end, 30, "Riddle Game", "Form the specified shape", 5, 5)
end)

General Information#

The "Riddle Game" can be integrated into any FiveM project that requires puzzle-solving elements. The player is tasked with arranging blocks into specific shapes, such as an inverted L or other patterns, within a set duration. Success or failure is determined based on whether the shape is completed in time.

To implement this minigame into your project, use the riddleGame function as shown above.