/qb-target

A better interaction system for FiveM

Primary LanguageLuaGNU General Public License v3.0GPL-3.0

qb-target

qb-target is a targeting solution that allows interaction with any predefined entity, model, entity type, or polyzone. While activated you can easily and safely replace markers and distance checking, instead relying on intuitive design to improve player experiences and optimize interaction.

Credits

  • Lots of credits goes to qtarget for re-writing all of bt-target to make it more optimized!

  • All the credit goes to bt-target from brentN5 for making this awesome resource and making this repository exist!

  • Credit to ms-peds for allowing me to use their awesome ped spawner inside the target!

Dependencies

Information

This repository was originally a fork and now it's own repository as it's basically qtarget but with lots of changes to it to make it better, most of the code comes from qtarget as I find their work awesome on this and what they've achieved with it, mostly the optimization.

This version is for QBCore but can be used by any framework if you make your own changes to it.

You are free to help through Pull Requests and leave as much suggestions or issues, I love some help and want I'm always up for new challenges!

The TEMPLATES.md is always being improved and new examples can be made on request, just let me know!

The EXAMPLES.md is currently not advised and will be reworked in the future.

Features

  • Maintains compatibility with bt-target while providing improved utility and performance
  • Optimised and improved raycasting function allows interaction with a wider range of entities
  • Add generic options to apply for all players, peds, vehicles, or objects
  • Trigger an event, function or command after clicking an option, with the ability to pass any data through
  • Define distance on a per-option or overall basis when triggering a target option
  • Ability to redefine or remove options, and add new options without replacing old ones
  • Update option list when moving towards or away from a target with variable distances on their options
  • Support for entity bones, with builtin tables for opening doors
  • Support checking for job, items, or specific entities
  • Utilise the canInteract function for advanced checks to show or hide an option based on any trigger
  • Ped spawner to spawn peds in one place

Issues and Suggestions

Please use the GitHub issues system to report issues or make suggestions, when making suggestion, please keep [Suggestion] in the title to make it clear that it is a suggestion or join the discord.