roseeast/qte

qte

qte is a compact Quick Time Event and skill-check include for SA-MP 0.3.7 and open.mp. It creates a PlayerTextDraw timing bar, moves a pointer across the track, and reports success or failure through callbacks.

The include is designed for roleplay interactions such as lockpicking, fishing, repair jobs, crafting checks, medical actions, and other short timing-based tasks.

Preview

Features

Installation

sa-mp :

#include <a_samp>
#include <qte>

open.mp:

#include <open.mp>
#include <qte>

Quick Start

#include <open.mp>
#include <zcmd>
#include <qte>

#define QTE_LOCKPICK (101)

CMD:lockpick(playerid, params[])
{
    if(IsPlayerInQTE(playerid))
    {
        return SendClientMessage(playerid, 0xE74C3CFF, "You are already doing a skill check.");
    }

    QTE_ResetPlayerStyle(playerid);
    SetPlayerQTEColors(playerid, 0x111827FF, 0x38BDF8FF, 0xF97316FF, 0xFFFFFFFF, 0xE5E7EBFF);
    SetPlayerQTEText(playerid, "~w~LOCKPICK ~y~[%s] ~w~ON GREEN", "~y~PIN ~w~%d/%d");

    StartPlayerQTE(playerid, KEY_WALK, 3.0, 20.0, 3, QTE_LOCKPICK);
    SendClientMessage(playerid, 0xF1C40FFF, "Press ALT/WALK when the pointer enters the green zone.");
    return 1;
}

public OnPlayerQTEComplete(playerid, bool:success, stages_cleared, total_stages, extra_id)
{
    if(extra_id != QTE_LOCKPICK)
    {
        return 1;
    }

    if(success)
    {
        SendClientMessage(playerid, 0x2ECC71FF, "Lockpick completed.");
    }
    else
    {
        SendClientMessage(playerid, 0xE74C3CFF, "Lockpick failed.");
    }
    return 1;
}

public OnPlayerQTEResult(playerid, result, stages_cleared, total_stages, extra_id)
{
    if(extra_id == QTE_LOCKPICK && result == QTE_RESULT_CANCELLED)
    {
        SendClientMessage(playerid, 0xAAAAAAFF, "Lockpick cancelled.");
    }
    return 1;
}

API

Functions

StartPlayerQTE Parameters

Callbacks

Example callback signatures:

forward OnPlayerQTEComplete(playerid, bool:success, stages_cleared, total_stages, extra_id);
forward OnPlayerQTESuccessStage(playerid, current_stage, total_stages, extra_id);
forward OnPlayerQTEFailedStage(playerid, current_stage, total_stages, extra_id);
forward OnPlayerQTECancel(playerid, stages_cleared, total_stages, extra_id);
forward OnPlayerQTEResult(playerid, result, stages_cleared, total_stages, extra_id);

Result Values

Configuration

Use the runtime style functions when different systems need different QTE looks. This works well in gamemodes where lockpicking, fishing, repair jobs, and other features live in separate script modules.

Call QTE_ResetPlayerStyle(playerid) before applying a feature-specific style if you do not want the player to inherit the style from the previous QTE.

#define QTE_FISHING (201)

StartFishingQTE(playerid)
{
    QTE_ResetPlayerStyle(playerid);
    SetPlayerQTELayout(playerid, QTE_ORIENTATION_VERTICAL, 585.0, 170.0, 170.0, 12.0);
    SetPlayerQTEColors(playerid, 0x082F49FF, 0x22C55EFF, 0xF8FAFCFF, 0xFFFFFFFF, 0xE5E7EBFF);
    SetPlayerQTEText(playerid, "~w~FISHING ~y~[%s] ~w~ON GREEN", "~y~FISH ~w~%d/%d");
    SetPlayerQTETextDrawStyle(playerid, -22.0, 6.0);

    return StartPlayerQTE(playerid, KEY_SPRINT, 2.4, 24.0, 2, QTE_FISHING);
}

Runtime Style Reference

Default Macros

Define these before including qte only when you want to change the default style for the whole script. Runtime setters can still override these defaults per player before StartPlayerQTE.

Global default example:

#define QTE_TICK_RATE 35
#define QTE_ZONE_MIN_SIZE 8.0
#define QTE_ZONE_MAX_SIZE 65.0
#define QTE_TRACK_TOP 360.0
#define QTE_TRACK_COLOR 0x111827FF
#define QTE_ZONE_COLOR 0x38BDF8FF
#define QTE_POINTER_COLOR 0xF97316FF
#define QTE_PROMPT_COLOR 0xFFFFFFFF
#define QTE_STAGE_COLOR 0xE5E7EBFF
#define QTE_PROMPT_FORMAT "~w~TEKAN ~y~[%s] ~w~SAAT MASUK AREA HIJAU"
#define QTE_PROMPT_SIZE 128
#define QTE_STAGE_FORMAT "~y~PIN ~w~%d/%d"
#define QTE_SUCCESS_SOUND 1057
#define QTE_FAIL_SOUND 1085

#include <open.mp>
#include <qte>

Global Vertical Default

This makes the default style vertical for the whole script. For per-feature vertical QTEs, prefer SetPlayerQTELayout.

#define QTE_ORIENTATION QTE_ORIENTATION_VERTICAL
#define QTE_TRACK_LEFT 585.0
#define QTE_TRACK_TOP 170.0
#define QTE_TRACK_WIDTH 170.0
#define QTE_TRACK_HEIGHT 12.0

#define QTE_PROMPT_OFFSET_Y -22.0
#define QTE_STAGE_OFFSET_Y 6.0

#include <open.mp>
#include <qte>

Compatibility Notes

Android Clients

Android clients can map some controls differently from desktop clients. For public features, prefer simple keys such as KEY_YES, KEY_NO, KEY_SPRINT, and KEY_ACTION. For desktop ALT/WALK prompts, use KEY_WALK.

License

Released under the MIT License. See LICENSE.