LGF Interaction (Interaction System with DUI)

FiveM Releases
, , , ,
1

The LGF Interaction System is a fully open-source DUI (Draw User Interface) handler designed in TypeScript. It facilitates dynamic in-game interactions with a variety of entities, including pedestrians, vehicles, and models, providing a seamless, user-friendly interface for players to interact with the game world.

image

Features

  • Dynamic Interaction Points: Supports proximity-based interactions with pedestrians, vehicles, and models, creating a more immersive and responsive game environment.

  • Customizable Options: Easily modify interaction settings through Lua tables, allowing server owners to adapt interactions to specific gameplay needs.

  • User-Friendly Interface: Uses NUI to display interaction menus, providing players with an intuitive and visually appealing experience.

  • Job-Based Interactions: Enables interactions that are accessible only to players with specific job roles, adding a layer of role-playing as only designated players can engage with these interactions.

  • Unique Interaction IDs: Each interaction is assigned a unique ID, allowing server owners to easily reference, modify, or remove specific interactions without affecting others.

  • Flexible Entity Interactions:

  • Pedestrian Interactions: Triggers an interaction menu when a player approaches a pedestrian.

  • Vehicle Interactions: Allows players to interact with nearby vehicles, such as opening or closing doors.

  • Model Interactions: Facilitates interactions with specified in-game models, so players can access unique options when within range of these models.

Information

Dependency

  • ox_lib
  • LGF_Utility (for various Framework Functions)

Note

As an open-source project, LGF Interaction System welcomes contributions of all kinds. If you have ideas, improvements, or bug fixes, feel free to submit them! We’re open to any changes that enhance the system and make it better for everyone.

16 Likes
2

Really nice script!

1 Like
3

appreciated Roda!

4

As a matter of principle I have completely rewritten the code, I have updated the documentation with the new exports (Obviously it will be updated gradually with new Common)

5

Looks good!

6

Update:

  • Correct Imports Font Awesome Library
  • Optimization nearby cb Void
  • Return all Istance
  • Added Debug for Ped and Zone using Sphere Drawmarker, for Vehicle using DrawOutline

I have Updated the Docs and Implemented New Exports

Example Usage:

local model = lib.requestModel("a_f_m_fatcult_01")
local entity = CreatePed(0, model, GetEntityCoords(cache.ped), GetEntityHeading(cache.ped), false, false)
exports.LGF_Interaction:addInteractionEntity({
    closest = 3.0,
    distance = 5.0,
    offsetCoords = vec3(0.0, 0.0, 1.0),            -- OffsetCoords (optional)
    netID = NetworkGetNetworkIdFromEntity(entity), -- Is required NetID for a safe approac,
    debug = false,
    dataBind = {
        {
            index = 1,
            title = "Open Safe ",
            description = "Click to open the safe.",
            icon = "lock",
            onClick = function(index)
                -- Some Stuff here
            end,
            canInteract = function(distance, interactionID, myPed)
                -- Simple Check example If the player have inventory open or if is not closest to the required distance
                return distance < 3.0 and not LocalPlayer.state.invOpen
            end
        },
    },
    onEnter = function(self)

    end,
    onExit = function(self)
    end,
    nearby = function(interactionID)
    end
})

Entity Exports

exports.LGF_Interaction:addInteractionEntity(data)
exports.LGF_Interaction:removeInteractionEntity(netID)
exports.LGF_Interaction:getInteractionEntities()

Vehicle Exports

exports.LGF_Interaction:addInteractionVehicle(data)
exports.LGF_Interaction:removeInteractionVehicle(vehicle)
exports.LGF_Interaction:getInteractionVehicles()

Ped Exports

exports.LGF_Interaction:addInteractionPed(data)
exports.LGF_Interaction:removeInteractionPed(pedID, interactionid)
exports.LGF_Interaction:removePed(pedID)
exports.LGF_Interaction:getInteractionPeds()

Default Exports

exports.LGF_Interaction:addInteraction(data)
exports.LGF_Interaction:removeInteraction(interactionID)