Interact
Library
Updated a month ago ·
v1.3.7i
Client Module - This can only be used on the client
lib.interact.register
Create a new player interaction
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | String | true | Unique reference for the interaction |
| data | Object | true | Options for the interact, refer to Data Structure |
lib.interact.get
Get information regarding an interaction
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | String | true | Unique reference for the interaction |
lib.interact.destroy
Completely remove an interaction by name
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Unique reference for the interaction |
lib.interact.entity
Add an interaction to a specific entity
| Parameter | Type | Required | Description |
|---|---|---|---|
| entity | number | yes | Entity handle |
| data | table | yes | Interaction options |
lib.interact.addModels
Add interactions to one or more models globally
lib.interact.addGlobalVehicle
Add interactions to all vehicles
lib.interact.addCoords
Add an interaction at specific world coordinates
lib.interact.addGlobalPlayer
Add interactions to all players
lib.interact.addGlobalPed
Add interactions to all peds
lib.interact.removeById
Remove an interaction by its ID
lib.interact.removeEntity
Remove all interactions from an entity
lib.interact.removeGlobalModel
Remove global model interactions
lib.interact.removeGlobalPlayer
Remove global player interactions
Data Structure
This is the data structure of an interaction and the valid options
There are multiple different interactions seen below:
Circle
Poly
Box
Marker
Text
!
This documentation is pending confirmation
Was this page helpful?
This page was last updated on 12 March 2026