mirror of
https://github.com/jimathy/jim_bridge.git
synced 2026-08-17 14:06:02 +01:00
Compare commits
40 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c3ce0ccc54 | ||
|
|
0b7c96f66a | ||
|
|
3daa6a9772 | ||
|
|
c86cdf9227 | ||
|
|
ca78c1b100 | ||
|
|
398701c4d7 | ||
|
|
00e420fd45 | ||
|
|
a07cbc467d | ||
|
|
ccd5144e7b | ||
|
|
195182f850 | ||
|
|
c2b48c444c | ||
|
|
156b44a49b | ||
|
|
a48b83155c | ||
|
|
e455d1b43d | ||
|
|
14c2a79673 | ||
|
|
97a1d97678 | ||
|
|
5001642504 | ||
|
|
5f413a2823 | ||
|
|
4d04682b33 | ||
|
|
cb38d275d1 | ||
|
|
84cfe1c97d | ||
|
|
47b01df621 | ||
|
|
7e073b16ec | ||
|
|
ab4298fa2d | ||
|
|
7997ea45b7 | ||
|
|
7aa9d90d0d | ||
|
|
451e4cbbdb | ||
|
|
520758b355 | ||
|
|
e4e9ef0fb2 | ||
|
|
ada724069b | ||
|
|
9198068a19 | ||
|
|
263d5160aa | ||
|
|
65137207ae | ||
|
|
3bd9935346 | ||
|
|
23e2488cd1 | ||
|
|
e9bbdd4ce0 | ||
|
|
f5a7ec9291 | ||
|
|
d80ea38a39 | ||
|
|
e64912622b | ||
|
|
04b25e2c06 |
@@ -20,35 +20,48 @@ end
|
|||||||
|
|
||||||
function CheckBridgeVersion()
|
function CheckBridgeVersion()
|
||||||
if IsDuplicityVersion() then
|
if IsDuplicityVersion() then
|
||||||
CreateThread(function()
|
CreateThread(function()
|
||||||
Wait(4000)
|
Wait(4000)
|
||||||
local currentVersionRaw = GetResourceMetadata("jim_bridge", 'version')
|
local currentVersionRaw = GetResourceMetadata("jim_bridge", 'version')
|
||||||
PerformHttpRequest('https://raw.githubusercontent.com/jimathy/jim_bridge/master/version.txt', function(err, newestVersionRaw, headers)
|
--PerformHttpRequest('https://raw.githubusercontent.com/jimathy/UpdateVersions/master/test.txt', function(err, body, headers)
|
||||||
if not newestVersionRaw then
|
PerformHttpRequest('https://raw.githubusercontent.com/jimathy/jim_bridge/master/version.txt', function(err, body, headers)
|
||||||
print("^1Unable to run version check for ^7'^3jim_bridge^7' (^3"..currentVersionRaw.."^7)")
|
if not body then
|
||||||
return
|
print("^1Unable to run version check for ^7'^3jim_bridge^7' (^3"..currentVersionRaw.."^7)")
|
||||||
end
|
return
|
||||||
|
end
|
||||||
|
|
||||||
newestVersionRaw = newestVersionRaw:match("[^\r\n]+")
|
local lines = {}
|
||||||
local compareResult = compareVersions(currentVersionRaw, newestVersionRaw)
|
for line in body:gmatch("[^\r\n]+") do
|
||||||
|
table.insert(lines, line)
|
||||||
|
end
|
||||||
|
|
||||||
if compareResult == 0 then
|
local newestVersionRaw = lines[1] or "0.0.0"
|
||||||
print("^7'^3jim_bridge^7' - ^2You are running the latest version^7. ^7(^3"..currentVersionRaw.."^7)")
|
local changelog = {}
|
||||||
elseif compareResult < 0 then
|
for i = 2, #lines do
|
||||||
-- Made the check a bit more obvious
|
table.insert(changelog, lines[i])
|
||||||
print("^1----------------------------------------------------------------------^7")
|
end
|
||||||
print("^7'^3jim_bridge^7' - ^1You are running an outdated version^7! ^7(^3"..currentVersionRaw.."^7 → ^3"..newestVersionRaw.."^7)")
|
|
||||||
print("^1----------------------------------------------------------------------^7")
|
local compareResult = compareVersions(currentVersionRaw, newestVersionRaw)
|
||||||
SetTimeout(1200000, function()
|
|
||||||
-- Do a naughty repeat message every 20 minutes until the the script is updated
|
if compareResult == 0 then
|
||||||
CheckBridgeVersion()
|
print("^7'^3jim_bridge^7' - ^2You are running the latest version^7. ^7(^3"..currentVersionRaw.."^7)")
|
||||||
end)
|
elseif compareResult < 0 then
|
||||||
else
|
print("^1----------------------------------------------------------------------^7")
|
||||||
print("^7'^3jim_bridge^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..newestVersionRaw.."^7)")
|
print("^7'^3jim_bridge^7' - ^1You are running an outdated version^7! ^7(^3"..currentVersionRaw.."^7 → ^3"..newestVersionRaw.."^7)")
|
||||||
end
|
for _, line in ipairs(changelog) do
|
||||||
end)
|
print((line:find("http") and "^7" or "^5")..line)
|
||||||
end)
|
end
|
||||||
end
|
print("^1----------------------------------------------------------------------^7")
|
||||||
|
SetTimeout(1200000, function()
|
||||||
|
CheckBridgeVersion()
|
||||||
|
end)
|
||||||
|
else
|
||||||
|
print("^7'^3jim_bridge^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..newestVersionRaw.."^7)")
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
CheckBridgeVersion()
|
CheckBridgeVersion()
|
||||||
58
documentation/animal_ped_support.md
Normal file
58
documentation/animal_ped_support.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
## Animal Ped Support
|
||||||
|
### isAnimal.lua
|
||||||
|
This module provides logic to detect if a Ped or model is an animal and classify it into specific categories (cat, dog, coyote, etc.). Useful for wildlife, animal roles, or pet systems.
|
||||||
|
|
||||||
|
❔At player load in, it attempts to get what kind of ped/animal you are but there are functions to double check in scripts
|
||||||
|
|
||||||
|
❔Alot of this is used to determine what models/animations are available
|
||||||
|
|
||||||
|
Global flags:
|
||||||
|
- `isCat`, `isDog`, `isBigDog`, `isSmallDog`, `isCoyote`, `isAnimal` — used to store classification of the player's current ped.
|
||||||
|
|
||||||
|
- **isPedAnimal(ped?)**
|
||||||
|
|
||||||
|
- Checks if a ped is an animal based on predefined animal models.
|
||||||
|
- Sets global `isAnimal` to true if matched.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local isPlayerAnimal = isPedAnimal()
|
||||||
|
local isOtherPedAnimal = isPedAnimal(GetPedInVehicleSeat(vehicle, -1))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **isCat(ped)**
|
||||||
|
|
||||||
|
- Returns true if the ped model matches a cat.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if isCat() then print("You're a cat!") end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **isDog(ped)**
|
||||||
|
|
||||||
|
- Returns two values:
|
||||||
|
- `true`, `true` — if ped is a big dog
|
||||||
|
- `true`, `false` — if ped is a small dog
|
||||||
|
- `false`, `nil` — if not a dog
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local isDog, isBig = isDog()
|
||||||
|
if isDog then print(isBig and "Big Dog" or "Small Dog") end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getAnimalModels()**
|
||||||
|
|
||||||
|
- Returns a flat list of all registered animal model hashes.
|
||||||
|
- Can be used to check ped models against
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
for _, model in pairs(getAnimalModels()) do print(model) end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getAnimalAnims(ped)**
|
||||||
|
|
||||||
|
- Returns the animation set defined for the given animal model.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local anims = getAnimalAnims(PlayerPedId())
|
||||||
|
if anims then playAnim(anims.sitDict, anims.sitAnim) end
|
||||||
|
```
|
||||||
177
documentation/helper_functions/helpers.md
Normal file
177
documentation/helper_functions/helpers.md
Normal file
@@ -0,0 +1,177 @@
|
|||||||
|
### helpers.lua
|
||||||
|
This utility module provides functions for resource checks, debugging, formatting, coordinate math, vector calculations, progress bars, and drawing tools.
|
||||||
|
|
||||||
|
- **isStarted(script)**
|
||||||
|
- Returns `true` if a resource is started.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if isStarted("myResource") then print("Resource is running") end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getScript()**
|
||||||
|
- Caches and returns the name of the current resource.
|
||||||
|
- Easier than typing `GetCurrentResourceName()` over and over
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
print("Current script:", getScript())
|
||||||
|
```
|
||||||
|
|
||||||
|
- **isServer()**
|
||||||
|
- Returns true if running on the server.
|
||||||
|
- This was mainly made becuase `IsDuplicityVersion()` kept confusing me
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if isServer() then print("Server-side!") end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **debugPrint(...)** / **eventPrint(...)**
|
||||||
|
- Prints messages with debug context if debugMode is enabled.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
debugPrint("Loaded object:", objName)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **jsonPrint(table)**
|
||||||
|
- Pretty-prints a table with colorized JSON if debugMode is enabled.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
jsonPrint(myData)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **keyGen()**
|
||||||
|
- Generates a 3-character unique ID.
|
||||||
|
- Good grabbing randomly generated strings
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
print("Generated Key:", keyGen())
|
||||||
|
```
|
||||||
|
|
||||||
|
- **cv(amount)**
|
||||||
|
- Comma-separates a number (e.g., `1000000` to `1,000,000`).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
print(cv(1000000)) -- "1,000,000"
|
||||||
|
```
|
||||||
|
|
||||||
|
- **formatCoord(vec)**
|
||||||
|
- Outputs a formatted string from vector types.
|
||||||
|
- Compacts and adds console colours to the vector to be printed
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
print(formatCoord(vector3(123.45, 678.9, 10.0)))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getCenterOfZones(coords)**
|
||||||
|
- Returns average center position of a vector3 list.
|
||||||
|
- A few use cases, but I used it to see how well spaced blips were together
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local center = getCenterOfZones({vector3(0,0,0), vector3(10,10,0)})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **countTable(tbl)**
|
||||||
|
- Returns the number of entries in a table.
|
||||||
|
- Simple function to print how many "entires" are in a table
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
print(countTable({a=1,b=2,c=3})) -- 3
|
||||||
|
```
|
||||||
|
|
||||||
|
- **pairsByKeys(tbl)**
|
||||||
|
- Iterator for sorted keys.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
for k, v in pairsByKeys(myTable) do print(k, v) end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **concatenateText(tbl)**
|
||||||
|
- Joins string table entries with newlines.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
print(concatenateText({"Line 1", "Line 2"}))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **RotationToDirection(rot)**
|
||||||
|
- Converts a heading vector to a directional vector.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local dir = RotationToDirection(rotation)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **basicBar(percent)**
|
||||||
|
- Returns a bar like `████░░░░░` at 50%.
|
||||||
|
- Basically a progress bar but as a string, I use this in drawTexts when progressbars aren't able to be used
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
print(basicBar(50))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **normalizeVector(vec)**
|
||||||
|
- Returns a normalized version of a vector3.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local norm = normalizeVector(vector3(3,4,0))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **drawLine(start, end, color)** / **drawSphere(pos, color)**
|
||||||
|
- Debug drawing helpers.
|
||||||
|
- Stays visible for more than one frame
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
drawLine(vector3(0,0,0), vector3(10,10,10), vector4(255,0,0,255))
|
||||||
|
drawSphere(vector3(5,5,5), vector4(0,255,0,255))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **PerformRaycast(start, end, entity?, flags?)**
|
||||||
|
- Raycast with material detection. Returns ray hit data.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local hit, hitPos, material = PerformRaycast(startVec, endVec, playerPed, 1)
|
||||||
|
if hit == 1 then
|
||||||
|
print("Hit at position:", hitPos)
|
||||||
|
print("Material:", material)
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **adjustForGround(coords)**
|
||||||
|
- Adjusts a z-coordinate to ground height.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
coords = adjustForGround(vector3(100, 200, 300))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **ensureNetToVeh(id)** / **ensureNetToEnt(id)**
|
||||||
|
- Resolves net ID to entity safely.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local veh = ensureNetToVeh(netId)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **sendLog(text)** / **sendServerLog(data)**
|
||||||
|
- Logging helpers, includes player name, coords, script source.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
sendLog("Suspicious activity detected")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **GetGroundMaterialAtPosition(coords)**
|
||||||
|
- Returns the material hash + readable name from the surface below coords.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local hash, name = GetGroundMaterialAtPosition(vector3(0,0,0))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **GetPropDimensions(model)**
|
||||||
|
- Loads a model and returns width, depth, height.
|
||||||
|
- I use this to parse a model to create a box target instead of entity target when creating distProps/distPeds
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local w,d,h = GetPropDimensions("prop_barrel_01a")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **GetEntityForwardVector(entity)**
|
||||||
|
- Returns the forward direction vector based on entity heading.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local fwd = GetEntityForwardVector(PlayerPedId())
|
||||||
|
```
|
||||||
89
documentation/helper_functions/loaders.md
Normal file
89
documentation/helper_functions/loaders.md
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
### loaders.lua
|
||||||
|
This module provides loading utilities for common asset types such as models, animations, texture dictionaries, and audio banks. It also provides animation and sound helpers.
|
||||||
|
|
||||||
|
- **loadModel(model)**
|
||||||
|
- Loads a model into memory if valid and not already loaded.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
loadModel('prop_chair_01a')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **unloadModel(model)**
|
||||||
|
- Unloads a model from memory.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
unloadModel('prop_chair_01a')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **loadAnimDict(animDict)**
|
||||||
|
- Loads an animation dictionary into memory.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
loadAnimDict('amb@world_human_hang_out_street@male_c@base')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **unloadAnimDict(animDict)**
|
||||||
|
- Removes an animation dictionary from memory.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
unloadAnimDict('amb@world_human_hang_out_street@male_c@base')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **loadPtfxDict(ptFxName)**
|
||||||
|
- Loads a particle effect (ptfx) dictionary.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
loadPtfxDict('core')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **unloadPtfxDict(dict)**
|
||||||
|
- Unloads a particle effect dictionary from memory.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
unloadPtfxDict('core')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **loadTextureDict(dict)**
|
||||||
|
- Loads a streamed texture dictionary.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
loadTextureDict('commonmenu')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **loadScriptBank(bank)**
|
||||||
|
- Loads a script audio bank.
|
||||||
|
- Returns true on success.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local success = loadScriptBank('DLC_HEISTS_GENERAL_FRONTEND_SOUNDS')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **loadAmbientBank(bank)**
|
||||||
|
- Loads an ambient audio bank.
|
||||||
|
- Returns true on success.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local success = loadAmbientBank('AMB_REVERB_GENERIC')
|
||||||
|
```
|
||||||
|
|
||||||
|
- **playAnim(animDict, animName, duration?, flag?, ped?, speed?)**
|
||||||
|
- Plays an animation on a ped.
|
||||||
|
- Loads the dictionary if not already loaded.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
playAnim('amb@world_human_hang_out_street@male_c@base', 'base', 5000, 1, PlayerPedId(), 1.0)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **stopAnim(animDict, animName, ped?)**
|
||||||
|
- Stops an animation and unloads the dictionary.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
stopAnim('amb@world_human_hang_out_street@male_c@base', 'base', PlayerPedId())
|
||||||
|
```
|
||||||
|
|
||||||
|
- **playGameSound(audioBank, soundSet, soundRef, coords, synced, range?)**
|
||||||
|
- Plays a game sound from a coordinate or entity.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
playGameSound('DLC_HEIST_HACKING_SNAKE_SOUNDS', 'Beep', vector3(0, 0, 0), false, 15.0)
|
||||||
|
```
|
||||||
38
documentation/main_functions/callbacks.md
Normal file
38
documentation/main_functions/callbacks.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
### callback.lua
|
||||||
|
|
||||||
|
These functions wrap the native callback handling of the selected framework (e.g., OX, QBCore, ESX) instead of implementing a standalone callback system, ensuring full compatibility.
|
||||||
|
|
||||||
|
- **createCallback(callbackName, funct)**
|
||||||
|
|
||||||
|
- Registers a callback function with the appropriate framework.
|
||||||
|
- This function checks which framework is started (e.g., OX, QB, ESX) and registers the callback accordingly.
|
||||||
|
- It adapts the callback function to match the expected signature for the framework.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local table = { ["info"] = "HI" }
|
||||||
|
createCallback('myCallback', function(source, ...)
|
||||||
|
return table
|
||||||
|
end)
|
||||||
|
|
||||||
|
createCallback("callback:checkVehicleOwned", function(source, plate)
|
||||||
|
local result = isVehicleOwned(plate)
|
||||||
|
if result then
|
||||||
|
return true
|
||||||
|
else
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **triggerCallback(callbackName, ...)**
|
||||||
|
|
||||||
|
- Triggers a server callback and returns the result.
|
||||||
|
- This function uses the appropriate framework's method to call the server-side callback and awaits the result.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local result = triggerCallback('myCallback')
|
||||||
|
jsonPrint(result)
|
||||||
|
|
||||||
|
local result = triggerCallback("callback:checkVehicleOwned", plate)
|
||||||
|
print(result)
|
||||||
|
```
|
||||||
28
documentation/main_functions/cameras.md
Normal file
28
documentation/main_functions/cameras.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
### cameras.lua
|
||||||
|
This module provides utilities for managing temporary in-game cameras, useful for cutscenes, cinematic views, or scripted perspectives.
|
||||||
|
|
||||||
|
- **createTempCam(ent, coords)**
|
||||||
|
|
||||||
|
- Creates a temporary camera at the specified coordinates or relative to an entity.
|
||||||
|
- If `ent` is an entity, the camera position is calculated as an offset from the entity's position using `GetOffsetFromEntityInWorldCoords`.
|
||||||
|
- If `ent` is a `vector3`, it is used directly as the camera's position.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local cam = createTempCam(PlayerPedId(), GetEntityCoords(PlayerPedId()) + vector3(0, 2.0, 1.0))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **startTempCam(cam)**
|
||||||
|
|
||||||
|
- Activates and renders the temporary camera.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
startTempCam(cam)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **stopTempCam()**
|
||||||
|
|
||||||
|
- Deactivates and deletes all currently running custom camera, restoring normal view.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
stopTempCam()
|
||||||
|
```
|
||||||
45
documentation/main_functions/contextmenus.md
Normal file
45
documentation/main_functions/contextmenus.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
### contextmenus.lua
|
||||||
|
|
||||||
|
These functions provide a unified way to interact with different context menu systems, such as OX and WarMenu, depending on what's available on the server.
|
||||||
|
|
||||||
|
- **openMenu(Menu, data)**
|
||||||
|
|
||||||
|
- Opens a context menu using the preferred menu system.
|
||||||
|
- Automatically selects between supported systems like OX or WarMenu based on availability.
|
||||||
|
- The `Menu` parameter should be a list of menu entries, and the `data` parameter can be used to set headers, subtexts, and actions like `onBack`, `onExit`, and `canClose`.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
openMenu({
|
||||||
|
{ header = "Option 1", txt = "Description 1", onSelect = function() print("Option 1 selected") end },
|
||||||
|
{ header = "Option 2", txt = "Description 2", onSelect = function() print("Option 2 selected") end },
|
||||||
|
}, {
|
||||||
|
header = "Main Menu",
|
||||||
|
headertxt = "Select an option",
|
||||||
|
onBack = function() print("Return selected") end,
|
||||||
|
onExit = function() print("Menu closed") end,
|
||||||
|
canClose = true,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **isOx()**
|
||||||
|
|
||||||
|
- Checks whether the OX context menu system is available on the server.
|
||||||
|
- Allows to do specific things if ox_lib menu is in use
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if isOx() then
|
||||||
|
print("OX Context Menu is available")
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **isWarMenuOpen()**
|
||||||
|
|
||||||
|
- Returns whether WarMenu is currently open.
|
||||||
|
- Useful to prevent opening a new menu if one is already active.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if not isWarMenuOpen() then
|
||||||
|
openMenu("main_menu", menuData)
|
||||||
|
end
|
||||||
|
```
|
||||||
|
- Returns whether the WarMenu is currently open.
|
||||||
39
documentation/main_functions/crafting.md
Normal file
39
documentation/main_functions/crafting.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
### crafting.lua
|
||||||
|
|
||||||
|
These functions support crafting logic, such as opening crafting menus, handling multi-craft operations, and creating item data from recipes.
|
||||||
|
|
||||||
|
- **craftingMenu(data)**
|
||||||
|
|
||||||
|
- Opens a menu for selecting the quantity to craft.
|
||||||
|
- Presents the player with multiple crafting quantities based on `Config.Crafting.MultiCraftAmounts`.
|
||||||
|
- **Parameters:**
|
||||||
|
- `item` (`string`): The item to craft.
|
||||||
|
- `craft` (`table`): The crafting recipe.
|
||||||
|
- `craftable` (`table`): Crafting options.
|
||||||
|
- `coords` (`vector3`): Where crafting occurs.
|
||||||
|
- `stashName` (`string`): The stash name(s) for item availability.
|
||||||
|
- `onBack` (`function`): Callback when returning.
|
||||||
|
- `metadata` (`table`, optional): Metadata for the crafted item.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
craftingMenu({
|
||||||
|
craftable = {
|
||||||
|
Header = "Weapon Crafting",
|
||||||
|
Recipes = {
|
||||||
|
[1] = {
|
||||||
|
["weapon_pistol"] = { ["steel"] = 5, ["plastic"] = 2 },
|
||||||
|
amount = 1,
|
||||||
|
},
|
||||||
|
-- More recipes...
|
||||||
|
},
|
||||||
|
Anims = {
|
||||||
|
animDict = "amb@prop_human_parking_meter@male@idle_a",
|
||||||
|
anim = "idle_a",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
coords = vector3(100.0, 200.0, 300.0),
|
||||||
|
stashTable = "crafting_stash",
|
||||||
|
job = "mechanic",
|
||||||
|
onBack = function() print("Returning to previous menu") end,
|
||||||
|
})
|
||||||
|
```
|
||||||
25
documentation/main_functions/drawtext.md
Normal file
25
documentation/main_functions/drawtext.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
### drawText.lua
|
||||||
|
|
||||||
|
These functions handle drawing and hiding styled on-screen prompts or UI overlays, compatible with different styling frameworks such as OX Lib.
|
||||||
|
|
||||||
|
- **drawText(image, input, style, oxStyleTable)**
|
||||||
|
|
||||||
|
- Displays styled text or prompts on screen.
|
||||||
|
- Designed to adapt styling depending on which UI system (e.g., OX) is in use.
|
||||||
|
- **Parameters:**
|
||||||
|
- `image` (`string`): Optional icon or image path.
|
||||||
|
- `input` (`string`): The main text to display.
|
||||||
|
- `style` (`string|table`): Preset or custom styling.
|
||||||
|
- `oxStyleTable` (`table`, optional): Extended style options if using OX UI.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
drawText("img_link", { "Test line 1", "Test Line 2" }, "~g~")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **hideText()**
|
||||||
|
|
||||||
|
- Hides any active text or UI element previously drawn with `drawText()`.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
hideText()
|
||||||
|
```
|
||||||
31
documentation/main_functions/duifunctions.md
Normal file
31
documentation/main_functions/duifunctions.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
### duifunctions.lua
|
||||||
|
|
||||||
|
These functions support dynamic UI image rendering in 3D environments using runtime texture dictionaries. Ideal for integrating `nui://` or external `http://` image URLs into MLOs or world props.
|
||||||
|
|
||||||
|
- **createDui(name, http, size, txd))**
|
||||||
|
|
||||||
|
- Sets up a runtime texture dictionary and links an image from a `nui://` or `http://` URL.
|
||||||
|
- This function should be used once to create the texture dictionary needed for rendering Dui images.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createDui("logo", "https://example.com/logo.png", { x = 512, y = 256 }, scriptTxd)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **DuiSelect(data)**
|
||||||
|
|
||||||
|
- Updates the URL on an existing texture dictionary to change the rendered image.
|
||||||
|
- Can be used at runtime to swap out visuals in MLOs or props.
|
||||||
|
- **Parameters:**
|
||||||
|
- `textureDict` (`string`): The texture dictionary to target.
|
||||||
|
- `texture` (`string`): The specific texture name to override.
|
||||||
|
- `url` (`string`): The new image URL.
|
||||||
|
- `width`, `height` (`number`): The texture resolution.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
DuiSelect({
|
||||||
|
name = "logo",
|
||||||
|
texn = "logoTex",
|
||||||
|
texd = "someTxd",
|
||||||
|
size = { x = 512, y = 256 }
|
||||||
|
})
|
||||||
|
```
|
||||||
25
documentation/main_functions/input.md
Normal file
25
documentation/main_functions/input.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
### input.lua
|
||||||
|
|
||||||
|
This function displays a customizable input dialog for user text or number entry. It supports both simple and complex input structures.
|
||||||
|
|
||||||
|
- **createInput(title, opts)**
|
||||||
|
- Opens a styled input dialog with configurable fields, labels, input types, and validation.
|
||||||
|
- Supports multiple field types including `text`, `number`, `password`, `checkbox`, `color`, `slider`, and more.
|
||||||
|
- **Parameters:**
|
||||||
|
- `title` (`string`): Title displayed at the top of the input box.
|
||||||
|
- `opts` (`table`): A table of fields with attributes like `label`, `name`, `type`, `value`, and more.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local userInput = createInput("Enter Details", {
|
||||||
|
{ type = "text", text = "Name", name = "playerName", isRequired = true },
|
||||||
|
{ type = "number", text = "Age", name = "playerAge", min = 18, max = 99 },
|
||||||
|
{ type = "radio", label = "Gender", name = "playerGender", options = {
|
||||||
|
{ text = "Male", value = "male" },
|
||||||
|
{ text = "Female", value = "female" },
|
||||||
|
{ text = "Other", value = "other" },
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
if userInput then
|
||||||
|
print(json.encode(userInput))
|
||||||
|
end
|
||||||
|
```
|
||||||
144
documentation/main_functions/inventories.md
Normal file
144
documentation/main_functions/inventories.md
Normal file
@@ -0,0 +1,144 @@
|
|||||||
|
### inventories.lua
|
||||||
|
|
||||||
|
These functions manage inventory locking, item checking, and player inventory retrieval.
|
||||||
|
|
||||||
|
- **lockInv(toggle)**
|
||||||
|
|
||||||
|
- Locks or unlocks the player's inventory.
|
||||||
|
- Freezes/unfreezes movement and toggles hotbar state.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
lockInv(true) -- Lock inventory
|
||||||
|
lockInv(false) -- Unlock inventory
|
||||||
|
```
|
||||||
|
|
||||||
|
- **hasItem(items, amount, src)**
|
||||||
|
|
||||||
|
- Checks if a player has the specified item(s) in sufficient quantity.
|
||||||
|
- **Returns:**
|
||||||
|
- `boolean`: Whether the player has the item(s).
|
||||||
|
- `table`: Details of available item counts.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local hasAll, details = hasItem({"health_potion", "mana_potion"}, 2, playerId)
|
||||||
|
if hasAll then
|
||||||
|
-- Proceed with action
|
||||||
|
else
|
||||||
|
-- Inform the player about missing items
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getPlayerInv(src)**
|
||||||
|
|
||||||
|
- Retrieves the player’s current inventory.
|
||||||
|
- May be used for inventory UI, logging, or crafting systems.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local inventory = getPlayerInv(playerId)
|
||||||
|
for k, item in pairs(inventory) do
|
||||||
|
print(item.name, item.amount)
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
### itemcontrol.lua
|
||||||
|
|
||||||
|
This module includes a variety of utility functions for managing items in player inventories, including giving, removing, durability, and use logic.
|
||||||
|
|
||||||
|
- **createUseableItem(item, funct)**
|
||||||
|
|
||||||
|
⚠️ This doesn't work for `ox_inv`, you will need to add the event info to it's `items.lua`
|
||||||
|
- Registers a useable item and binds it to a callback function.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createUseableItem("bandage", function(source)
|
||||||
|
-- Heal logic here
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **invImg(item)**
|
||||||
|
|
||||||
|
- Returns the inventory image path for an item.
|
||||||
|
- Automatically grabs the inventory image link based on inventory script
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local imagePath = invImg("water_bottle")
|
||||||
|
print(imagePath)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **addItem(item, amount, info, src)**
|
||||||
|
|
||||||
|
⚠️ Requires Auth callback if called from client side
|
||||||
|
- Adds a specific amount of an item to a player's inventory.
|
||||||
|
- Automatically attempts to add items using detected inventory script
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
-- Client Side
|
||||||
|
addItem("lockpick", 3, {})
|
||||||
|
|
||||||
|
-- Server Side
|
||||||
|
addItem("lockpick", 3, {}, source)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **removeItem(item, amount, src, slot)**
|
||||||
|
|
||||||
|
- Removes a specific amount of an item from a player’s inventory.
|
||||||
|
- Automatically attempts to remove item using detected inventory script
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
-- Client Side
|
||||||
|
removeItem(
|
||||||
|
"ammo_pistol",
|
||||||
|
30,
|
||||||
|
nil,
|
||||||
|
slot --[[optional]]--
|
||||||
|
)
|
||||||
|
|
||||||
|
-- Server Side
|
||||||
|
removeItem(
|
||||||
|
"ammo_pistol",
|
||||||
|
30,
|
||||||
|
source,
|
||||||
|
slot --[[optional]]--
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **dupeWarn(src, item, amount)**
|
||||||
|
|
||||||
|
- Logs or handles a potential duplication exploit involving an item.
|
||||||
|
- This is called automatically if a player has been triggered exploit detection
|
||||||
|
- Disabled if debugMode is enabled
|
||||||
|
|
||||||
|
- **breakTool(data)**
|
||||||
|
|
||||||
|
- Breaks a tool or item, often due to exceeding durability.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
breakTool({ item = "drill", damage = 10 })
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getDurability(item)**
|
||||||
|
|
||||||
|
- Returns the current durability value of a given item.
|
||||||
|
- Searched for the lowest slot number (eg. slot 1) and retreives that items durability
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local durability, slot = getDurability("drill")
|
||||||
|
if durability then
|
||||||
|
print("Durability:", durability)
|
||||||
|
print("Slot:", slot)
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **canCarry(itemTable, src)**
|
||||||
|
|
||||||
|
⚠️ Currently server side only
|
||||||
|
- Checks if a player can carry the item(s) specified in `itemTable`.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local carryCheck = canCarry({ ["health_potion"] = 2, ["mana_potion"] = 3 }, playerId)
|
||||||
|
if carryCheck["health_potion"] and carryCheck["mana_potion"] then
|
||||||
|
-- Player can carry items.
|
||||||
|
else
|
||||||
|
-- Notify player.
|
||||||
|
end
|
||||||
|
```
|
||||||
64
documentation/main_functions/jobfunctions.md
Normal file
64
documentation/main_functions/jobfunctions.md
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
### jobfunctions.lua
|
||||||
|
|
||||||
|
This module provides functions for managing job-based logic, such as checking player roles, toggling duty status, and simulating job-related interactions.
|
||||||
|
|
||||||
|
- **makeBossRoles(role)**
|
||||||
|
|
||||||
|
- Sets up boss-level permissions or access for the specified job role.
|
||||||
|
- Often used to determine if a player can access job menus or perform administrative actions.
|
||||||
|
- Used mainly for creating boss locked target tables
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
makeBossRoles("police")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **jobCheck(job)**
|
||||||
|
|
||||||
|
- Simple check if the player has the specified job.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if jobCheck("mechanic") then
|
||||||
|
-- Allow mechanic features.
|
||||||
|
else
|
||||||
|
-- Deny access.
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **toggleDuty()**
|
||||||
|
|
||||||
|
- Toggles the player’s on/off duty status, typically used for jobs like police, EMS, etc.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
toggleDuty()
|
||||||
|
```
|
||||||
|
|
||||||
|
- **washHands(data)**
|
||||||
|
|
||||||
|
- Simulates the action of washing hands, used in job scripts or medical job logic.
|
||||||
|
- Currently only animation and a notfication
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
washHands({ coords = vector3(200.0, 300.0, 40.0) })
|
||||||
|
```
|
||||||
|
|
||||||
|
- **useToilet(data)**
|
||||||
|
|
||||||
|
- Triggers toilet-use interaction, likely includes animation or sound.
|
||||||
|
- Currently only animation and a notfication
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
useToilet({ urinal = true })
|
||||||
|
-- Player uses a urinal with corresponding animations and notifications
|
||||||
|
|
||||||
|
useToilet({ urinal = false, sitcoords = vector4(215.76, -810.12, 29.73, 90.0) })
|
||||||
|
-- Player sits down to use a toilet with corresponding animations and notifications
|
||||||
|
```
|
||||||
|
|
||||||
|
- **useDoor(data)**
|
||||||
|
|
||||||
|
- Handles interactions with doors that aren't openable and teleports the player
|
||||||
|
- eg. Recycle Center, it's used to teleport the player from outside a building to the IPL
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
useDoor({ telecoords = vector4(215.76, -810.12, 29.73, 90.0) })
|
||||||
|
```
|
||||||
156
documentation/main_functions/makefunctions.md
Normal file
156
documentation/main_functions/makefunctions.md
Normal file
@@ -0,0 +1,156 @@
|
|||||||
|
### makeBlip.lua
|
||||||
|
|
||||||
|
This module provides simple utilities for adding static or entity-based blips to the minimap.
|
||||||
|
|
||||||
|
❔ This has basic support for RedM too
|
||||||
|
- **makeBlip(data)**
|
||||||
|
|
||||||
|
- This function adds a map blip at the provided coordinates and sets various display properties such as sprite, color, scale, and more.
|
||||||
|
- It also handles attaching a preview image to the blip if certain resources are running and a preview is provided.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local blipData = {
|
||||||
|
coords = vector3(123.4, 567.8, 90.1),
|
||||||
|
sprite = 1,
|
||||||
|
col = 2,
|
||||||
|
scale = 0.8,
|
||||||
|
disp = 4,
|
||||||
|
category = 7,
|
||||||
|
name = "My Blip",
|
||||||
|
preview = "http://example.com/preview.png"
|
||||||
|
}
|
||||||
|
local blip = makeBlip(blipData)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **makeEntityBlip(data)**
|
||||||
|
|
||||||
|
- This function adds a map blip attached to the provided entity and sets various display properties such as sprite, color, scale, and more.
|
||||||
|
- It also handles attaching a preview image to the blip if certain resources are running and a preview is provided.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local blipData = {
|
||||||
|
entity = myEntity,
|
||||||
|
sprite = 1,
|
||||||
|
col = 2,
|
||||||
|
scale = 0.8,
|
||||||
|
disp = 4,
|
||||||
|
category = 7,
|
||||||
|
name = "Entity Blip",
|
||||||
|
preview = "http://example.com/preview.png"
|
||||||
|
}
|
||||||
|
local blip = makeEntityBlip(blipData)
|
||||||
|
```
|
||||||
|
|
||||||
|
### makePed.lua
|
||||||
|
This module provides tools to create persistent or distance-based NPCs with optional animations, scenarios, and config randomization.
|
||||||
|
|
||||||
|
- **makeDistPed(data, coords, freeze, collision, scenario, anim, synced)**
|
||||||
|
|
||||||
|
- Creates a ped that only spawns when nearby (performance optimization).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
makeDistPed({model = "a_m_y_business_03" }, -- model data
|
||||||
|
vector4(450.0, -980.0, 30.0, 100.0), -- coords
|
||||||
|
true, -- freeze entity
|
||||||
|
false, -- collision
|
||||||
|
'WORLD_HUMAN_STAND_IMPATIENT', -- Scenario Animation
|
||||||
|
{ dict = "amb@world_human_clipboard@male@idle_a", anim = "idle_c" }, -- Anim Table
|
||||||
|
true -- Network Synced
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **makePed(data, coords, freeze, collision, scenario, anim, synced)**
|
||||||
|
|
||||||
|
- Spawns a ped with more persistent behavior at the given location.
|
||||||
|
- Supports animation playback and freezing.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
makePed({model = "a_m_y_business_03" }, -- model data
|
||||||
|
vector4(450.0, -980.0, 30.0, 100.0), -- coords
|
||||||
|
true, -- freeze entity
|
||||||
|
false, -- collision
|
||||||
|
'WORLD_HUMAN_STAND_IMPATIENT', -- Scenario Animation
|
||||||
|
{ dict = "amb@world_human_clipboard@male@idle_a", anim = "idle_c" }, -- Anim Table
|
||||||
|
true -- Network Synced
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **GenerateRandomPedData(data)**
|
||||||
|
|
||||||
|
- Returns randomized ped model/configuration based on input table.
|
||||||
|
- Useful for dynamic NPC generation.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local pedData = GenerateRandomPedData({ model = `MP_M_Freemode_01`, custom = {} })
|
||||||
|
```
|
||||||
|
|
||||||
|
### makeProp.lua
|
||||||
|
This module allows you to spawn static or distance-loaded props in the world.
|
||||||
|
|
||||||
|
- **makeProp(data, freeze, synced)**
|
||||||
|
|
||||||
|
- This function loads the model, creates the object, sets its heading, and freezes it if specified.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local propData = {
|
||||||
|
prop = 'prop_chair_01a',
|
||||||
|
coords = vector4(123.4, 567.8, 90.1, 180.0)
|
||||||
|
}
|
||||||
|
local prop = makeProp(propData, true, false)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **makeDistProp(data, freeze, synced, range)**
|
||||||
|
- Same as `makeProp`, but only spawns if the player is within the specified range.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local propData = {
|
||||||
|
prop = 'prop_chair_01a',
|
||||||
|
coords = vector4(123.4, 567.8, 90.1, 180.0)
|
||||||
|
}
|
||||||
|
makeDistProp(propData, true, false)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **destroyProp(entity)**
|
||||||
|
- Removes a previously created or targeted prop from the world.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
destroyProp(barrel)
|
||||||
|
```
|
||||||
|
|
||||||
|
### makeVeh.lua
|
||||||
|
This module provides functionality for spawning vehicles, including distance-based optimization and entity management.
|
||||||
|
|
||||||
|
- **makeVeh(model, coords)**
|
||||||
|
|
||||||
|
- This function loads the vehicle model, creates the vehicle in the world at the given coordinates, sets initial properties, and returns the vehicle handle.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local vehicle = makeVeh("adder", vector3(250.0, -1000.0, 30.0))
|
||||||
|
```
|
||||||
|
|
||||||
|
- **makeDistVehicle(data, radius, onEnter, onExit)**
|
||||||
|
|
||||||
|
- Creates a vehicle that spawns when the player enters a designated polyzone area.
|
||||||
|
- This is used for `jim-parking` to create a static vehicle that can't move
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
makeDistVehicle({
|
||||||
|
model = "blista",
|
||||||
|
coords = vector3(400.0, -800.0, 30.0),
|
||||||
|
heading = 180.0
|
||||||
|
}, 50.0)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **removeDistVehicleZone(zoneId)**
|
||||||
|
- Removes a previously created distance-based vehicle zone.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
removeDistVehicleZone("garage_zone_1")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **deleteVehicle(vehicle)**
|
||||||
|
- Deletes a specified vehicle entity.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
deleteVehicle(vehicle)
|
||||||
|
```
|
||||||
32
documentation/main_functions/metahandlers.md
Normal file
32
documentation/main_functions/metahandlers.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
### metaHandlers.lua
|
||||||
|
|
||||||
|
This module provides access and control over player metadata, which is useful for storing temporary or persistent player-specific values like stats, states, or tags.
|
||||||
|
|
||||||
|
- **GetPlayer(source)**
|
||||||
|
|
||||||
|
⚠️ Server side only
|
||||||
|
- Retrieves the player object (as defined by the framework in use) from the given `source` ID.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local player = GetPlayer(playerId)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **GetMetadata(player, key)**
|
||||||
|
|
||||||
|
- Retrieves the value of a metadata field from the given player.
|
||||||
|
- If called client-side (player is nil), it triggers a server callback to retrieve metadata.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local stress = GetMetadata(player, "stress")
|
||||||
|
print("Player stress level:", stress)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **SetMetadata(player, key, value)**
|
||||||
|
|
||||||
|
⚠️ Server side only
|
||||||
|
- Updates or assigns a value to a specific metadata key for a player.
|
||||||
|
- The function updates the player's metadata using the active core export.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
SetMetadata(player, "stress", 0)
|
||||||
|
```
|
||||||
21
documentation/main_functions/notify.md
Normal file
21
documentation/main_functions/notify.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
### notify.lua
|
||||||
|
|
||||||
|
This module provides a unified interface to trigger styled notifications across supported frameworks.
|
||||||
|
|
||||||
|
- **triggerNotify(title, message, type, src)**
|
||||||
|
|
||||||
|
- Sends a notification to a player (or to the entire client if `src` is `nil`).
|
||||||
|
- The notification style is determined by `type` (e.g., `success`, `error`, `info`).
|
||||||
|
- **Parameters:**
|
||||||
|
- `title` (`string`): The title or header of the notification.
|
||||||
|
- `message` (`string`): The body or detail text.
|
||||||
|
- `type` (`string`): Type of message (e.g., "success", "error", "info").
|
||||||
|
- `src` (`number`, optional): Server ID of the player to notify (omit to notify locally).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
-- Client-side usage without specifying a player (shows to the current player)
|
||||||
|
triggerNotify("Success", "You have completed the task!", "success")
|
||||||
|
|
||||||
|
-- Server-side usage specifying a player by their server ID
|
||||||
|
triggerNotify("Alert", "You have been warned for misconduct.", "error", source)
|
||||||
|
```
|
||||||
21
documentation/main_functions/phones.md
Normal file
21
documentation/main_functions/phones.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
### phones.lua
|
||||||
|
|
||||||
|
This module allows you to send in-game mail/messages to player phones, depending on the phone system integrated (e.g., QB, NPWD).
|
||||||
|
|
||||||
|
- **sendPhoneMail(data)**
|
||||||
|
|
||||||
|
- Sends a mail message to a player's in-game phone app.
|
||||||
|
- Typically used to notify players about deliveries, missions, or reminders.
|
||||||
|
- **Parameters:**
|
||||||
|
- `data` (`table`): Must contain phone/mail system-compatible fields like `sender`, `subject`, `message`, and `receiver`.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
sendPhoneMail({
|
||||||
|
subject = "Welcome!",
|
||||||
|
sender = "Admin",
|
||||||
|
message = "Thank you for joining our server.",
|
||||||
|
actions = {
|
||||||
|
{ label = "Reply", action = replyFunction }
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
115
documentation/main_functions/playerfunctions.md
Normal file
115
documentation/main_functions/playerfunctions.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
### playerfunctions.lua
|
||||||
|
|
||||||
|
This module contains helper functions for manipulating player states, interactions, and utility checks.
|
||||||
|
|
||||||
|
- **instantLookEnt(ent, ent2)**
|
||||||
|
|
||||||
|
- Instantly turns an entity to face a target (entity or coordinates) without animation.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
instantLookEnt(nil, vector3(200.0, 300.0, 40.0))
|
||||||
|
instantLookEnt(ped1, ped2)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **lookEnt(entity)**
|
||||||
|
|
||||||
|
- Makes the current player look toward the given entity.
|
||||||
|
- Usually called after when opening a menu or something similar to make the player visually face the location
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
lookEnt(vector3(200.0, 300.0, 40.0))
|
||||||
|
lookEnt(pedEntity)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **setThirst(src, thirst)**
|
||||||
|
|
||||||
|
⚠️ Server Side Only
|
||||||
|
- Sets the thirst level of a player.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
setThirst(source, 75)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **setHunger(src, hunger)**
|
||||||
|
|
||||||
|
⚠️ Server Side Only
|
||||||
|
- Sets the hunger level of a player.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
setHunger(source, 50)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **chargePlayer(cost, moneyType, newsrc)**
|
||||||
|
|
||||||
|
⚠️ Server Side Only
|
||||||
|
- Deducts money from a player of the specified type (`cash`, `bank`, etc).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
chargePlayer(100, "cash", source)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **fundPlayer(fund, moneyType, newsrc)**
|
||||||
|
|
||||||
|
⚠️ Server Side Only
|
||||||
|
- Adds money to a player's balance of a given type.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
fundPlayer(250, "bank", source)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **ConsumeSuccess(itemName, type, data)**
|
||||||
|
|
||||||
|
- Handles logic when an item is successfully consumed (e.g., food, drink, etc).
|
||||||
|
- Supports hunger and thirst info directly from table eg. `{ hunger = 10, thirst = 20 }`
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
ConsumeSuccess("health_pack", "food", { hunger = 10 })
|
||||||
|
|
||||||
|
ConsumeSuccess("beer", "alcohol", { thirst = 20 })
|
||||||
|
```
|
||||||
|
|
||||||
|
- **hasJob(job, source, grade)**
|
||||||
|
|
||||||
|
- Checks if a player has a certain job and optionally checks for a specific grade.
|
||||||
|
- Similar to `jobCheck()` but also retrieves as much player job info as possible
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
-- Check if the player has the 'police' job and is on duty
|
||||||
|
local hasPoliceJob, isOnDuty = hasJob("police")
|
||||||
|
if hasPoliceJob and isOnDuty then
|
||||||
|
-- Grant access to police-specific features
|
||||||
|
end
|
||||||
|
|
||||||
|
-- Check if a specific player has the 'gang_leader' job with at least grade 2
|
||||||
|
local hasGangLeaderJob, _ = hasJob("gang_leader", playerId, 2)
|
||||||
|
if hasGangLeaderJob then
|
||||||
|
-- Allow gang leader actions
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getPlayer(source)**
|
||||||
|
|
||||||
|
- Retrieves basic player information (name, cash, bank, job, etc.) based on the active core/inventory system.
|
||||||
|
- Can be called server-side (passing a player source) or client-side (for current player).
|
||||||
|
- Called often in my scripts as its makes use of frameworks "GetPlayerData" etc.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
-- Get information for a specific player
|
||||||
|
local playerInfo = getPlayer(playerId)
|
||||||
|
print(playerInfo.name, playerInfo.cash, playerInfo.bank)
|
||||||
|
|
||||||
|
-- Get information for the current player (client-side)
|
||||||
|
local myInfo = getPlayer()
|
||||||
|
print(myInfo.name, myInfo.cash, myInfo.bank)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **GetPlayersFromCoords(coords, radius)**
|
||||||
|
|
||||||
|
- Returns a list of players within a specified radius of a set of coordinates.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local nearby = GetPlayersFromCoords(GetEntityCoords(PlayerPedId()), 10.0)
|
||||||
|
for _, playerId in pairs(nearby) do
|
||||||
|
print("Nearby player ID:", playerId)
|
||||||
|
end
|
||||||
|
```
|
||||||
44
documentation/main_functions/polyzone.md
Normal file
44
documentation/main_functions/polyzone.md
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
### polyZone.lua
|
||||||
|
|
||||||
|
This module provides helpers for creating and removing polygon or circular zones using PolyZone-compatible data structures.
|
||||||
|
|
||||||
|
- **createPoly(data)**
|
||||||
|
|
||||||
|
- Creates a polygonal zone using the detected polyzone library (ox_lib or PolyZone).
|
||||||
|
- Automatically checks which polyzone script is active. When using ox_lib, it converts the provided 2D points to 3D (setting a constant z value) and sets a thickness value.
|
||||||
|
- For PolyZone, it creates the zone and attaches onEnter and onExit callbacks for ease of use.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createPoly({
|
||||||
|
name = 'testZone',
|
||||||
|
debug = true,
|
||||||
|
points = { vec2(100.0, 100.0), vec2(200.0, 100.0), vec2(200.0, 200.0), vec2(100.0, 200.0) },
|
||||||
|
onEnter = function() print("Entered Test Zone") end,
|
||||||
|
onExit = function() print("Exited Test Zone") end,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **createCirclePoly(data)**
|
||||||
|
|
||||||
|
- When using ox_lib, it creates a sphere zone. For PolyZone, it creates a CircleZone and attaches onEnter and onExit callbacks.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createCirclePoly({
|
||||||
|
name = 'circleZone',
|
||||||
|
coords = vector3(150.0, 150.0, 20.0),
|
||||||
|
radius = 50.0,
|
||||||
|
onEnter = function() print("Entered Circle Zone") end,
|
||||||
|
onExit = function() print("Exited Circle Zone") end,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **removePolyZone(Location)**
|
||||||
|
|
||||||
|
- Removes a previously created polygon or circle zone by name.
|
||||||
|
- Detects the active polyzone library and calls the appropriate removal method.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local zone = createPoly({...})
|
||||||
|
---
|
||||||
|
removePolyZone(zone)
|
||||||
|
```
|
||||||
23
documentation/main_functions/progressbars.md
Normal file
23
documentation/main_functions/progressbars.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
### progressBars.lua
|
||||||
|
This module provides a unified progress bar system compatible with various UI frameworks.
|
||||||
|
|
||||||
|
❔It also contains an experimental "Shared Progressbar" system which was created for things like "giving an item to another player"
|
||||||
|
|
||||||
|
- **progressBar(data)**
|
||||||
|
- Displays a progress bar using the current configured system (e.g., ox_lib, qb, etc).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local success = progressBar({
|
||||||
|
label = "Processing...",
|
||||||
|
time = 5000,
|
||||||
|
dict = "amb@world_human_hang_out_street@female_hold_arm@base",
|
||||||
|
anim = "base",
|
||||||
|
flag = 49,
|
||||||
|
cancel = true,
|
||||||
|
})
|
||||||
|
if success then
|
||||||
|
print("Success!")
|
||||||
|
else
|
||||||
|
print("Cancelled")
|
||||||
|
end
|
||||||
|
```
|
||||||
24
documentation/main_functions/scaleentity.md
Normal file
24
documentation/main_functions/scaleentity.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
### scaleEntity.lua
|
||||||
|
|
||||||
|
This utility provides a simple interface to scale an entity (ped, object, vehicle) in the world.
|
||||||
|
|
||||||
|
⚠️ **Important:** Unless the model's collision is removed or modified, the scale will reset when interacted with by other entities (e.g., walking into it, driving over it).
|
||||||
|
|
||||||
|
- **scaleEntity(entity, scale)**
|
||||||
|
|
||||||
|
- Scales the specified entity by the given factor.
|
||||||
|
- **Parameters:**
|
||||||
|
- `entity` (`number`): Entity handle (ped, object, vehicle).
|
||||||
|
- `scale` (`number`): Scale factor (e.g., `1.0` is normal size, `0.5` is half size).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
scaleEntity(PlayerPedId(), 0.8) -- Shrinks player slightly
|
||||||
|
```
|
||||||
|
|
||||||
|
- **resetScale(entity)**
|
||||||
|
|
||||||
|
- Resets the entity's scale back to its original default.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
resetScale(PlayerPedId()) -- Return to default size
|
||||||
|
```
|
||||||
63
documentation/main_functions/shops.md
Normal file
63
documentation/main_functions/shops.md
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
### shops.lua
|
||||||
|
|
||||||
|
This module provides functions to open, sell to, and register in-game shops and markets.
|
||||||
|
|
||||||
|
- **sellMenu(data)**
|
||||||
|
|
||||||
|
- Opens a UI menu for selling items to a vendor or market system.
|
||||||
|
- A simple system for the ability to sell all of an item in a players inventory
|
||||||
|
- Good for money making eg. pawn shops
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
sellMenu({
|
||||||
|
sellTable = {
|
||||||
|
Header = "Sell Items",
|
||||||
|
Items = {
|
||||||
|
["gold_ring"] = 100,
|
||||||
|
["diamond"] = 500,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
ped = pedEntity,
|
||||||
|
onBack = function() print("Returning to previous menu") end,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **sellAnim(data)**
|
||||||
|
|
||||||
|
- Plays an animation during the selling process for immersion.
|
||||||
|
- Used in sellMenu, but can be called externally if needed
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
sellAnim({
|
||||||
|
item = "gold_ring",
|
||||||
|
price = 100,
|
||||||
|
ped = pedEntity,
|
||||||
|
onBack = function() print("Sold Items") end,
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **openShop(data)**
|
||||||
|
|
||||||
|
- Opens a shop interface for purchasing items.
|
||||||
|
- Checks job/gang restrictions, then uses the active inventory system to open the shop.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
openShop({
|
||||||
|
shop = "weapon_shop",
|
||||||
|
items = weaponShopItems,
|
||||||
|
coords = vector3(100.0, 200.0, 300.0),
|
||||||
|
job = "police",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **registerShop(name, label, items, society)**
|
||||||
|
|
||||||
|
- Registers a named shop with associated items and an optional society for fund handling.
|
||||||
|
- Supports either OXInv or QBInv (with QBInvNew flag).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
registerShop("fishing_shop", "Bait & Tackle", {
|
||||||
|
{ item = "fishing_rod", price = 50 },
|
||||||
|
{ item = "bait", price = 5 }
|
||||||
|
}, "fishing_society")
|
||||||
|
```
|
||||||
16
documentation/main_functions/skillcheck.md
Normal file
16
documentation/main_functions/skillcheck.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
### skillcheck.lua
|
||||||
|
|
||||||
|
This module provides a UI-based skill check system, useful for crafting, hacking, or other interactive gameplay scenarios.
|
||||||
|
|
||||||
|
- **skillCheck()**
|
||||||
|
|
||||||
|
- Starts a skill check minigame sequence using the provided configuration.
|
||||||
|
- Configuration may define speed, difficulty, bar size, or success zones.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if skillCheck() then
|
||||||
|
print("Success!")
|
||||||
|
else
|
||||||
|
print("Failed :(")
|
||||||
|
end
|
||||||
|
```
|
||||||
28
documentation/main_functions/societybank.md
Normal file
28
documentation/main_functions/societybank.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
### societybank.lua
|
||||||
|
|
||||||
|
This module handles financial operations for society accounts, typically used for jobs or organizations.
|
||||||
|
|
||||||
|
- **getSocietyAccount(society)**
|
||||||
|
|
||||||
|
- Retrieves the current balance for the specified society.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local balance = getSocietyAccount("police")
|
||||||
|
print("Police account balance: $"..balance)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **chargeSociety(society, amount)**
|
||||||
|
|
||||||
|
- Deducts a specified amount from the society's account.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
chargeSociety("police", 500)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **fundSociety(society, amount)**
|
||||||
|
|
||||||
|
- Adds funds to a society’s account.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
fundSociety("ambulance", 1200)
|
||||||
|
```
|
||||||
44
documentation/main_functions/stashcontrol.md
Normal file
44
documentation/main_functions/stashcontrol.md
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
### stashcontrol.lua
|
||||||
|
|
||||||
|
This module handles logic for interacting with stashes—shared inventories for crafting, jobs, or storage systems.
|
||||||
|
|
||||||
|
- **checkStashItem(stashes, itemTable)**
|
||||||
|
|
||||||
|
- Retrieves (or updates) a local stash cache entry with a timeout.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local found, foundinStash = checkStashItem({"crafting_stash"}, { item = "steel", amount = 2 })
|
||||||
|
if found then print("Found item in "..foundInStash) end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **openStash(data)**
|
||||||
|
|
||||||
|
- Opens a stash using the active inventory system.
|
||||||
|
- Checks for job or gang restrictions before opening the stash.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
openStash({
|
||||||
|
stash = "playerStash",
|
||||||
|
label = "Player Stash",
|
||||||
|
coords = vector3(100, 200, 30)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getStash(stashName)**
|
||||||
|
|
||||||
|
- Retrieves the stash data by name (usually used for querying contents).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local items = getStash("playerStash")
|
||||||
|
for k, v in pairs(items) do
|
||||||
|
print(k)
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **stashRemoveItem(stashItems, stashName, items)**
|
||||||
|
|
||||||
|
- Removes specified items from a stash. Used during crafting or transfers.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
stashRemoveItem(currentItems, "playerStash", { iron = 2, wood = 5 })
|
||||||
|
```
|
||||||
108
documentation/main_functions/targets.md
Normal file
108
documentation/main_functions/targets.md
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
### targets.lua
|
||||||
|
|
||||||
|
⚠️ This module provides utility functions for adding and removing interaction targets with entities, models, zones, and coordinates. Supports common targeting frameworks like `ox_target`, `qb-target`, and more.
|
||||||
|
|
||||||
|
- **createEntityTarget(entity, opts, dist)**
|
||||||
|
|
||||||
|
- Adds interaction targets to a specific in-world entity.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createEntityTarget(entityId, {
|
||||||
|
{
|
||||||
|
action = function()
|
||||||
|
openStorage()
|
||||||
|
end,
|
||||||
|
icon = "fas fa-box",
|
||||||
|
job = "police",
|
||||||
|
label = "Open Storage",
|
||||||
|
},
|
||||||
|
}, 2.0)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **createBoxTarget(data, opts, dist)**
|
||||||
|
|
||||||
|
- Creates an interactable box zone with configurable options.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createBoxTarget(
|
||||||
|
{
|
||||||
|
'storageBox',
|
||||||
|
vector3(100.0, 200.0, 30.0),
|
||||||
|
2.0,
|
||||||
|
2.0,
|
||||||
|
{
|
||||||
|
name = 'storageBox',
|
||||||
|
heading = 100.0,
|
||||||
|
debugPoly = true,
|
||||||
|
minZ = 27.0,
|
||||||
|
maxZ = 32.0,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
{
|
||||||
|
action = function()
|
||||||
|
openStorage()
|
||||||
|
end,
|
||||||
|
icon = "fas fa-box",
|
||||||
|
job = "police",
|
||||||
|
label = "Open Storage",
|
||||||
|
},
|
||||||
|
}, 2.0)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **createCircleTarget(data, opts, dist)**
|
||||||
|
|
||||||
|
- Creates an interactable circular zone.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createCircleTarget({
|
||||||
|
name = 'centralPark',
|
||||||
|
coords = vector3(200.0, 300.0, 40.0),
|
||||||
|
radius = 50.0,
|
||||||
|
options = { debugPoly = false }
|
||||||
|
}, {
|
||||||
|
{ icon = "fas fa-tree", label = "Relax", action = relaxAction }
|
||||||
|
}, 2.0)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **createModelTarget(models, opts, dist)**
|
||||||
|
|
||||||
|
- Adds interactions to all matching models globally.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
createModelTarget({ model1, model2 },
|
||||||
|
{
|
||||||
|
{
|
||||||
|
action = function()
|
||||||
|
openStorage()
|
||||||
|
end,
|
||||||
|
icon = "fas fa-box",
|
||||||
|
job = "police",
|
||||||
|
label = "Open Storage",
|
||||||
|
},
|
||||||
|
}, 2.0)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **removeEntityTarget(entity)**
|
||||||
|
|
||||||
|
- Removes all targets linked to the specified entity.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
removeEntityTarget(vehicle)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **removeZoneTarget(target)**
|
||||||
|
|
||||||
|
- Removes a named zone-based target.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
removeZoneTarget("shop_box")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **removeModelTarget(model)**
|
||||||
|
|
||||||
|
- Removes interactions tied to a model globally.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
removeModelTarget("prop_vend_soda")
|
||||||
|
```
|
||||||
63
documentation/main_functions/vehicles.md
Normal file
63
documentation/main_functions/vehicles.md
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
### vehicles.lua
|
||||||
|
|
||||||
|
This module provides utilities for reading, modifying, and interacting with vehicle properties and positioning.
|
||||||
|
|
||||||
|
- **searchCar(vehicle)**
|
||||||
|
|
||||||
|
- Searches the 'Vehicles' table for a specific vehicle's details.
|
||||||
|
- If the vehicle differs from the last searched, it retrieves its model and updates the carInfo table.
|
||||||
|
- The table includes the vehicle's name, price, and class information.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local info = searchCar(vehicleEntity)
|
||||||
|
print(info.name, info.price, info.class.name, info.class.index)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getVehicleProperties(vehicle)**
|
||||||
|
|
||||||
|
- Retrieves the properties of a given vehicle using the active framework.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local props = getVehicleProperties(vehicle)
|
||||||
|
if props then
|
||||||
|
print(json.encode(props))
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **setVehicleProperties(vehicle, props)**
|
||||||
|
|
||||||
|
- Sets the properties of a given vehicle if changes are detected.
|
||||||
|
- It compares the current properties with the new ones and applies the update using the active framework.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
setVehicleProperties(vehicle, props)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **checkDifferences(vehicle, newProps)**
|
||||||
|
|
||||||
|
- Checks for differences between the current and new vehicle properties.
|
||||||
|
- Compares properties using JSON encoding for deep comparison and logs differences.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
if checkDifferences(vehicleEntity, newProperties) then
|
||||||
|
setVehicleProperties(vehicleEntity, newProperties)
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
- **pushVehicle(entity)**
|
||||||
|
|
||||||
|
- This function ensures that the vehicle is controlled by the current player and is set as a mission entity.
|
||||||
|
- It requests network control and sets the vehicle accordingly to synchronize changes across clients.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
pushVehicle(vehicle)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **getClosestVehicle(coords, src)**
|
||||||
|
|
||||||
|
- Finds the closest vehicle to the specified coordinates.
|
||||||
|
- The function uses different APIs based on whether a source is provided.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
local closestVeh, distance = getClosestVehicle({ x = 100, y = 200, z = 30 }, source)
|
||||||
|
```
|
||||||
37
documentation/main_functions/wrapperfunctions.md
Normal file
37
documentation/main_functions/wrapperfunctions.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
### wrapperfunctions.lua
|
||||||
|
|
||||||
|
Provides wrapper compatibility functions for command and inventory stash systems across different frameworks (OX, QB, ESX, QS, etc).
|
||||||
|
|
||||||
|
- **registerCommand(command, options)**
|
||||||
|
|
||||||
|
⚠️ Server Side Only
|
||||||
|
- Registers a command using the appropriate framework's API.
|
||||||
|
- **Parameters:**
|
||||||
|
- `command`: Command name (string)
|
||||||
|
- `options`: Table including help, params, callback, autocomplete, restrictedGroup
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
registerCommand("greet", {
|
||||||
|
"Greets the player",
|
||||||
|
{ name = "name", help = "Name of the player to greet" },
|
||||||
|
function(source, args) print("Hello, "..args[1].."!") end,
|
||||||
|
nil,
|
||||||
|
"admin"
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- **registerStash(name, label, slots?, weight?, owner?, coords?)**
|
||||||
|
|
||||||
|
⚠️ Server Side Only
|
||||||
|
- Registers a stash using OX, QS, or Origen inventory systems.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
registerStash(
|
||||||
|
"playerStash",
|
||||||
|
"Player Stash",
|
||||||
|
100,
|
||||||
|
8000000,
|
||||||
|
"player123",
|
||||||
|
{ x = 100.0, y = 200.0, z = 30.0 }
|
||||||
|
)
|
||||||
|
```
|
||||||
129
documentation/scaleforms.md
Normal file
129
documentation/scaleforms.md
Normal file
@@ -0,0 +1,129 @@
|
|||||||
|
## Scaleforms
|
||||||
|
### debugScaleform.lua
|
||||||
|
This module renders debug text in-game when `debugMode` is enabled. Useful for live diagnostics or UI placement feedback.
|
||||||
|
|
||||||
|
- **debugScaleForm(textTable, loc)**
|
||||||
|
- Displays an overlay of lines of text at the specified screen location.
|
||||||
|
- **Note:** This only works if `debugMode` is set to `true`.
|
||||||
|
- **Parameters:**
|
||||||
|
- `textTable` (`table`): A list of strings to display.
|
||||||
|
- `loc` (`vector2`, optional): Top-left anchor point on screen (default: `vec2(0.05, 0.65)`).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
CreateThread(function()
|
||||||
|
while true do
|
||||||
|
debugScaleForm({
|
||||||
|
"Line 1: Debug info",
|
||||||
|
"Line 2: More info"
|
||||||
|
})
|
||||||
|
Wait(0)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
### instructionalButtons.lua
|
||||||
|
This module renders instructional button prompts using native scaleforms in GTA V and RedM.
|
||||||
|
|
||||||
|
⚠️ **Note:** Because it uses native scaleforms, it must be run inside a `while` loop to remain visible.
|
||||||
|
|
||||||
|
- **makeInstructionalButtons(info)**
|
||||||
|
- Draws instructional buttons using the GTA scaleform `instructional_buttons`.
|
||||||
|
- **Parameters:**
|
||||||
|
- `info` (`table`): An array of tables, where each entry contains:
|
||||||
|
- `keys` (`table`): Control key codes (e.g., `{38, 29}`).
|
||||||
|
- `text` (`string`): The label for the button.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
CreateThread(function()
|
||||||
|
while true do
|
||||||
|
makeInstructionalButtons({
|
||||||
|
{ keys = {38, 29}, text = "Open Menu" },
|
||||||
|
{ keys = {45}, text = "Close Menu" }
|
||||||
|
})
|
||||||
|
Wait(0)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **makeRedInstructionalButtons(info, title)**
|
||||||
|
- Experimental: Displays prompts using RedM-style `PromptSetGroup` API.
|
||||||
|
- **Note:** Still must be run in a loop for visibility.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
CreateThread(function()
|
||||||
|
while true do
|
||||||
|
makeRedInstructionalButtons({
|
||||||
|
{ keys = {0x760A9C6F}, text = "Mount Horse" },
|
||||||
|
{ keys = {0x4CC0E2FE}, text = "Dismount" }
|
||||||
|
}, "Horse Controls")
|
||||||
|
Wait(0)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
### scaleform_basic.lua
|
||||||
|
This module includes helper functions for 3D text rendering and UI overlays using basic native scaleform techniques.
|
||||||
|
|
||||||
|
- **DrawText3D(coord, text, highlight)**
|
||||||
|
|
||||||
|
- Draws 3D text in the world at the given coordinates, with optional highlight.
|
||||||
|
- Includes a semi-transparent black background box for visibility.
|
||||||
|
- **Parameters:**
|
||||||
|
- `coord` (`vector3`): World position to draw text.
|
||||||
|
- `text` (`string`): Text content.
|
||||||
|
- `highlight` (`boolean`, optional): Highlights `~w~` sections with yellow.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
CreateThread(function()
|
||||||
|
while true do
|
||||||
|
DrawText3D(vector3(100, 200, 300), "Hello World", true)
|
||||||
|
Wait(0)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **DisplayHelpMsg(text)**
|
||||||
|
- Shows a help message in the top-left corner of the screen.
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
DisplayHelpMsg("Press E to interact")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **displaySpinner(text)**
|
||||||
|
- Shows a busy spinner with a message (e.g., "Saving...").
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
displaySpinner("Saving data...")
|
||||||
|
```
|
||||||
|
|
||||||
|
- **stopSpinner()**
|
||||||
|
- Hides any active busy spinner (client-only).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
stopSpinner()
|
||||||
|
```
|
||||||
|
|
||||||
|
### timerBars.lua
|
||||||
|
This module provides a native scaleform-based timer bar HUD. Ideal for displaying tasks, loading indicators, or time-sensitive objectives.
|
||||||
|
|
||||||
|
- **createTimerHud(title, data, alpha)**
|
||||||
|
|
||||||
|
⚠️ This was an attempt to recreate the gta native shooting ranges )fairly specific use case)
|
||||||
|
- Draws a timer bar with custom label and right-aligned values using the native GTA HUD system.
|
||||||
|
- **Parameters:**
|
||||||
|
- `title` (`string`): Title/header displayed on the bar.
|
||||||
|
- `data` (`table`): List of `label = value` entries to display (max 4 rows).
|
||||||
|
- `alpha` (`number`, optional): Opacity of the bar (0-255).
|
||||||
|
- **Example:**
|
||||||
|
```lua
|
||||||
|
CreateThread(function()
|
||||||
|
while true do
|
||||||
|
createTimerHud("Timer Bar", {
|
||||||
|
{ stat = "Health", value = "85%" },
|
||||||
|
{ stat = "Armor", value = "50%", multi = 2 },
|
||||||
|
{ stat = "Stamina", value = "100%" },
|
||||||
|
}, 180)
|
||||||
|
Wait(0)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
```
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
name "Jim_Bridge"
|
name "Jim_Bridge"
|
||||||
author "Jimathy"
|
author "Jimathy"
|
||||||
version "2.0.09"
|
version "2.0.14"
|
||||||
description "Framework Bridge By Jimathy"
|
description "Framework Bridge By Jimathy"
|
||||||
fx_version "cerulean"
|
fx_version "cerulean"
|
||||||
rdr3_warning 'I acknowledge that this is a prerelease build of RedM, and I am aware my resources *will* become incompatible once RedM ships.'
|
rdr3_warning 'I acknowledge that this is a prerelease build of RedM, and I am aware my resources *will* become incompatible once RedM ships.'
|
||||||
|
|||||||
@@ -50,7 +50,13 @@ function onPlayerLoaded(func, onStart)
|
|||||||
AddEventHandler('QBCore:Client:OnPlayerLoaded', tempFunc)
|
AddEventHandler('QBCore:Client:OnPlayerLoaded', tempFunc)
|
||||||
elseif isStarted(ESXExport) then
|
elseif isStarted(ESXExport) then
|
||||||
onPlayerFramework = ESXExport
|
onPlayerFramework = ESXExport
|
||||||
AddEventHandler('esx:playerLoaded', tempFunc)
|
AddEventHandler('esx:playerLoaded', function()
|
||||||
|
if waitForSharedLoad() then
|
||||||
|
if isStarted(ESXExport) then Wait(11000) end
|
||||||
|
tempFunc()
|
||||||
|
end
|
||||||
|
end
|
||||||
|
)
|
||||||
elseif isStarted(OXCoreExport) then
|
elseif isStarted(OXCoreExport) then
|
||||||
onPlayerFramework = OXCoreExport
|
onPlayerFramework = OXCoreExport
|
||||||
AddEventHandler('ox:playerLoaded', tempFunc)
|
AddEventHandler('ox:playerLoaded', tempFunc)
|
||||||
@@ -103,7 +109,11 @@ function onResourceStart(func, thisScript)
|
|||||||
debugPrint("^6Bridge^7: ^2Registering ^3onResourceStart^7()")
|
debugPrint("^6Bridge^7: ^2Registering ^3onResourceStart^7()")
|
||||||
AddEventHandler('onResourceStart', function(resourceName)
|
AddEventHandler('onResourceStart', function(resourceName)
|
||||||
if getScript() == resourceName and (thisScript or true) then
|
if getScript() == resourceName and (thisScript or true) then
|
||||||
func()
|
if waitForSharedLoad() then
|
||||||
|
debugPrint("^6Bridge^7: ^2Shared Load Detected^7.")
|
||||||
|
if isStarted(ESXExport) then Wait(10000) end
|
||||||
|
func()
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
@@ -175,3 +185,25 @@ function waitForLogin()
|
|||||||
return true
|
return true
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
function waitForSharedLoad()
|
||||||
|
local timeout = 100000 -- 10 seconds in milliseconds
|
||||||
|
local startTime = GetGameTimer()
|
||||||
|
local loaded = true
|
||||||
|
while ((not Jobs or not next(Jobs)) and (not Items or not next(Items)) and (not Vehicles or not next(Vehicles))) and (GetGameTimer() - startTime) < timeout do
|
||||||
|
print((GetGameTimer() - startTime) < timeout)
|
||||||
|
Wait(1000)
|
||||||
|
debugPrint("Waiting for Jobs, Items, and Vehicles to be loaded")
|
||||||
|
if Jobs and Items and Vehicles then
|
||||||
|
print("^6Bridge^7: ^2Jobs, Items, and Vehicles Loaded^7.")
|
||||||
|
loaded = true
|
||||||
|
break
|
||||||
|
end
|
||||||
|
end
|
||||||
|
if not loaded then
|
||||||
|
print("^4Error^7: ^2Timeout reached while waiting for shared load^7.")
|
||||||
|
return false
|
||||||
|
else
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -15,7 +15,7 @@ function compareVersions(current, newest)
|
|||||||
if c < n then return -1
|
if c < n then return -1
|
||||||
elseif c > n then return 1 end
|
elseif c > n then return 1 end
|
||||||
end
|
end
|
||||||
return 0 -- equal
|
return 0
|
||||||
end
|
end
|
||||||
|
|
||||||
function capitalize(str)
|
function capitalize(str)
|
||||||
@@ -33,51 +33,63 @@ function CheckVersion()
|
|||||||
if isServer() and GetResourceMetadata(getScript(), 'author', nil) == "Jimathy" then
|
if isServer() and GetResourceMetadata(getScript(), 'author', nil) == "Jimathy" then
|
||||||
CreateThread(function()
|
CreateThread(function()
|
||||||
Wait(4000)
|
Wait(4000)
|
||||||
|
|
||||||
local script = getScript()
|
local script = getScript()
|
||||||
local currentVersionRaw = GetResourceMetadata(script, 'version')
|
local currentVersionRaw = GetResourceMetadata(script, 'version')
|
||||||
|
|
||||||
PerformHttpRequest('https://raw.githubusercontent.com/jimathy/UpdateVersions/master/'..script..'.txt', function(err, newestVersionRaw, headers)
|
PerformHttpRequest('https://raw.githubusercontent.com/jimathy/UpdateVersions/master/'..script..'.txt', function(err, newestVersionRaw, headers)
|
||||||
if not newestVersionRaw then
|
if not newestVersionRaw then
|
||||||
|
-- fallback
|
||||||
PerformHttpRequest('https://raw.githubusercontent.com/jimathy/'..script..'/master/version.txt', function(err, fallbackVersionRaw, headers)
|
PerformHttpRequest('https://raw.githubusercontent.com/jimathy/'..script..'/master/version.txt', function(err, fallbackVersionRaw, headers)
|
||||||
if not fallbackVersionRaw then
|
if not fallbackVersionRaw then
|
||||||
print("^1Currently unable to run a version check for ^7'^3"..script.."^7' (^3"..currentVersionRaw.."^7)")
|
print("^1Currently unable to run a version check for ^7'^3"..script.."^7' (^3"..currentVersionRaw.."^7)")
|
||||||
return
|
return
|
||||||
end
|
end
|
||||||
|
|
||||||
fallbackVersionRaw = fallbackVersionRaw:match("[^\r\n]+"):gsub("v", "")
|
local lines = {}
|
||||||
|
for line in fallbackVersionRaw:gmatch("[^\r\n]+") do table.insert(lines, line) end
|
||||||
|
local fallbackVersion = (lines[1] or "0.0.0"):gsub("v", "")
|
||||||
|
local changelog = {}
|
||||||
|
for i = 2, #lines do table.insert(changelog, lines[i]) end
|
||||||
|
|
||||||
local compareResult = compareVersions(currentVersionRaw, fallbackVersionRaw)
|
local compareResult = compareVersions(currentVersionRaw, fallbackVersion)
|
||||||
if compareResult == 0 then
|
if compareResult == 0 then
|
||||||
print("^7'^3"..script.."^7' - ^2You are running the latest version^7. (^3"..currentVersionRaw.."^7)")
|
print("^7'^3"..script.."^7' - ^2You are running the latest version^7. (^3"..currentVersionRaw.."^7)")
|
||||||
elseif compareResult < 0 then
|
elseif compareResult < 0 then
|
||||||
print("^1----------------------------------------------------------------------^7")
|
print("^1----------------------------------------------------------------------^7")
|
||||||
print("^7'^3"..script.."^7' - ^1You are currently running an outdated version^7! (^3"..currentVersionRaw.."^7 → ^3"..fallbackVersionRaw.."^7)")
|
print("^7'^3"..script.."^7' - ^1You are currently running an outdated version^7! (^3"..currentVersionRaw.."^7 → ^3"..fallbackVersion.."^7)")
|
||||||
|
if #changelog > 0 then
|
||||||
|
for _, line in ipairs(changelog) do
|
||||||
|
print((line:find("http") and "^7" or "^5")..line)
|
||||||
|
end
|
||||||
|
end
|
||||||
print("^1----------------------------------------------------------------------^7")
|
print("^1----------------------------------------------------------------------^7")
|
||||||
SetTimeout(1200000, function()
|
SetTimeout(1200000, function() CheckVersion() end)
|
||||||
-- Do a naughty repeat message every 20 minutes until the the script is updated
|
|
||||||
CheckVersion()
|
|
||||||
end)
|
|
||||||
else
|
else
|
||||||
print("^7'^3"..script.."^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..fallbackVersionRaw.."^7)")
|
print("^7'^3"..script.."^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..fallbackVersion.."^7)")
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
else
|
else
|
||||||
newestVersionRaw = newestVersionRaw:match("[^\r\n]+"):gsub("v", "")
|
local lines = {}
|
||||||
|
for line in newestVersionRaw:gmatch("[^\r\n]+") do table.insert(lines, line) end
|
||||||
|
local newestVersion = (lines[1] or "0.0.0"):gsub("v", "")
|
||||||
|
local changelog = {}
|
||||||
|
for i = 2, #lines do table.insert(changelog, lines[i]) end
|
||||||
|
|
||||||
local compareResult = compareVersions(currentVersionRaw, newestVersionRaw)
|
local compareResult = compareVersions(currentVersionRaw, newestVersion)
|
||||||
if compareResult == 0 then
|
if compareResult == 0 then
|
||||||
print("^7'^3"..script.."^7' - ^2You are running the latest version^7. (^3"..currentVersionRaw.."^7)")
|
print("^7'^3"..script.."^7' - ^2You are running the latest version^7. (^3"..currentVersionRaw.."^7)")
|
||||||
elseif compareResult < 0 then
|
elseif compareResult < 0 then
|
||||||
print("^1----------------------------------------------------------------------^7")
|
print("^1----------------------------------------------------------------------^7")
|
||||||
print("^7'^3"..script.."^7' - ^1You are currently running an outdated version^7! (^3"..currentVersionRaw.."^7 → ^3"..newestVersionRaw.."^7)")
|
print("^7'^3"..script.."^7' - ^1You are currently running an outdated version^7! (^3"..currentVersionRaw.."^7 → ^3"..newestVersion.."^7)")
|
||||||
|
if #changelog > 0 then
|
||||||
|
for _, line in ipairs(changelog) do
|
||||||
|
print((line:find("http") and "^7" or "^5")..line)
|
||||||
|
end
|
||||||
|
end
|
||||||
print("^1----------------------------------------------------------------------^7")
|
print("^1----------------------------------------------------------------------^7")
|
||||||
SetTimeout(1200000, function()
|
SetTimeout(1200000, function() CheckVersion() end)
|
||||||
-- Do a naughty repeat message every 20 minutes until the the script is updated
|
|
||||||
CheckVersion()
|
|
||||||
end)
|
|
||||||
else
|
else
|
||||||
print("^7'^3"..script.."^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..newestVersionRaw.."^7)")
|
print("^7'^3"..script.."^7' - ^5You are running a newer version ^7(^3"..currentVersionRaw.."^7 ← ^3"..newestVersion.."^7)")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
|
|||||||
@@ -73,6 +73,29 @@ local itemResource, jobResource, vehResource = "", "", ""
|
|||||||
if isStarted(OXInv) then
|
if isStarted(OXInv) then
|
||||||
itemResource = OXInv
|
itemResource = OXInv
|
||||||
Items = exports[OXInv]:Items()
|
Items = exports[OXInv]:Items()
|
||||||
|
|
||||||
|
-- Add weapons to Items from QBXCore if available
|
||||||
|
if isStarted(QBXExport) then
|
||||||
|
local tempWeapons = exports[QBExport]:GetCoreObject().Shared.Weapons
|
||||||
|
for k, v in pairs(tempWeapons) do
|
||||||
|
local tempWeaponInfo = exports[OXInv]:Items(v.name)
|
||||||
|
local weight = 0
|
||||||
|
if tempWeaponInfo then
|
||||||
|
weight = tempWeaponInfo.weight
|
||||||
|
end
|
||||||
|
if not Items[v.name] then
|
||||||
|
Items[v.name] = {
|
||||||
|
name = v.name,
|
||||||
|
label = v.label,
|
||||||
|
type = "weapon",
|
||||||
|
ammotype = v.ammotype or "AMMO_PISTOL",
|
||||||
|
weight = weight,
|
||||||
|
image = v.image or (v.name..".png"),
|
||||||
|
description = v.label or "",
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
for k, v in pairs(Items) do
|
for k, v in pairs(Items) do
|
||||||
if v.client and v.client.image then
|
if v.client and v.client.image then
|
||||||
Items[k].image = (v.client.image):gsub("nui://"..OXInv.."/web/images/", "")
|
Items[k].image = (v.client.image):gsub("nui://"..OXInv.."/web/images/", "")
|
||||||
@@ -87,6 +110,12 @@ elseif isStarted(QBExport) then
|
|||||||
itemResource = QBExport
|
itemResource = QBExport
|
||||||
Core = Core or exports[QBExport]:GetCoreObject()
|
Core = Core or exports[QBExport]:GetCoreObject()
|
||||||
Items = Core and Core.Shared.Items or nil
|
Items = Core and Core.Shared.Items or nil
|
||||||
|
CreateThread(function()
|
||||||
|
while not Items or not next(Items) do
|
||||||
|
Items = exports[QBExport]:GetCoreObject().Shared.Items
|
||||||
|
Wait(1000)
|
||||||
|
end
|
||||||
|
end)
|
||||||
if isStarted(QBExport) and not isStarted(QBXExport) then
|
if isStarted(QBExport) and not isStarted(QBXExport) then
|
||||||
RegisterNetEvent('QBCore:Client:UpdateObject', function()
|
RegisterNetEvent('QBCore:Client:UpdateObject', function()
|
||||||
Core = Core or exports[QBExport]:GetCoreObject()
|
Core = Core or exports[QBExport]:GetCoreObject()
|
||||||
@@ -189,10 +218,8 @@ end
|
|||||||
if vehResource == nil then
|
if vehResource == nil then
|
||||||
print("^4ERROR^7: ^2No Vehicle info detected ^7- ^2Check ^3starter^1.^2lua^7")
|
print("^4ERROR^7: ^2No Vehicle info detected ^7- ^2Check ^3starter^1.^2lua^7")
|
||||||
else
|
else
|
||||||
CreateThread(function()
|
while not Vehicles do Wait(1000) end
|
||||||
while not Vehicles do Wait(1000) end
|
debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Vehicles).." ^3Vehicles^2 from ^7"..vehResource)
|
||||||
debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Vehicles).." ^3Vehicles^2 from ^7"..vehResource)
|
|
||||||
end)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
-------------------------------------------------------------
|
-------------------------------------------------------------
|
||||||
@@ -205,23 +232,36 @@ if isStarted(QBXExport) then
|
|||||||
Jobs, Gangs = exports[QBXExport]:GetJobs(), exports[QBXExport]:GetGangs()
|
Jobs, Gangs = exports[QBXExport]:GetJobs(), exports[QBXExport]:GetGangs()
|
||||||
|
|
||||||
elseif isStarted(OXCoreExport) then
|
elseif isStarted(OXCoreExport) then
|
||||||
jobResource = OXExport
|
jobResource = OXCoreExport
|
||||||
CreateThread(function()
|
CreateThread(function()
|
||||||
if isServer() then
|
if isServer() then
|
||||||
|
Jobs = {}
|
||||||
createCallback(getScript()..":getOxGroups", function(source)
|
createCallback(getScript()..":getOxGroups", function(source)
|
||||||
Jobs = MySQL.query.await('SELECT * FROM `ox_groups`')
|
|
||||||
return Jobs
|
return Jobs
|
||||||
end)
|
end)
|
||||||
else
|
local tempJobs = MySQL.query.await('SELECT * FROM `ox_groups`')
|
||||||
local TempJobs = triggerCallback(getScript()..":getOxGroups")
|
local tempGrades = MySQL.query.await('SELECT * FROM `ox_group_grades`')
|
||||||
Jobs = {}
|
-- Index all grades by group
|
||||||
for k, v in pairs(TempJobs) do
|
local gradeMap = {}
|
||||||
local grades = {}
|
for _, grade in pairs(tempGrades) do
|
||||||
--for i = 1, #v.grades do
|
gradeMap[grade.group] = gradeMap[grade.group] or {}
|
||||||
-- grades[i] = { name = v.grades[i], isboss = (i == #v.grades) }
|
gradeMap[grade.group][grade.grade] = {
|
||||||
--end
|
name = grade.label
|
||||||
Jobs[v.name] = { label = v.label, grades = grades }
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
-- Process jobs and attach grades
|
||||||
|
for _, job in pairs(tempJobs) do
|
||||||
|
Jobs[job.name] = {
|
||||||
|
label = job.label,
|
||||||
|
grades = gradeMap[job.name] or {}
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
-- Copy to Gangs
|
||||||
|
Gangs = Jobs
|
||||||
|
else
|
||||||
|
Jobs = triggerCallback(getScript()..":getOxGroups")
|
||||||
Gangs = Jobs
|
Gangs = Jobs
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
@@ -246,15 +286,37 @@ elseif isStarted(ESXExport) then
|
|||||||
end)
|
end)
|
||||||
-- Populate jobs table with ESX.GetJobs()
|
-- Populate jobs table with ESX.GetJobs()
|
||||||
Jobs = ESX.GetJobs()
|
Jobs = ESX.GetJobs()
|
||||||
|
--jsonPrint(Jobs)
|
||||||
--If retreived jobs is empty, wait for ESX to load
|
--If retreived jobs is empty, wait for ESX to load
|
||||||
while countTable(Jobs) == 0 do
|
while countTable(Jobs) == 0 do
|
||||||
Jobs = ESX.GetJobs()
|
Jobs = ESX.GetJobs()
|
||||||
Wait(100)
|
Wait(100)
|
||||||
end
|
end
|
||||||
-- Organise into a table the script can use
|
-- Organise into a table the script can use
|
||||||
for k, v in pairs(Jobs) do
|
for Role, Grades in pairs(Jobs) do
|
||||||
local count = countTable(Jobs[k].grades) - 1
|
|
||||||
Jobs[k].grades[tostring(count)].isBoss = true
|
-- Check for "Boss" in name of grades
|
||||||
|
for grade, info in pairs(Grades.grades) do
|
||||||
|
--print(grade)
|
||||||
|
--jsonPrint(info)
|
||||||
|
|
||||||
|
if info.label then
|
||||||
|
--print(info)
|
||||||
|
if info.label:find("boss") or info.label:find("Boss") then
|
||||||
|
--print("Found Boss label for:", Grades.label)
|
||||||
|
Jobs[Role].grades[grade].isBoss = true
|
||||||
|
goto continue
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
-- If no roles with "boss" in the name, revert to max grade
|
||||||
|
|
||||||
|
-- Count grades
|
||||||
|
local count = countTable(Grades.grades)
|
||||||
|
Jobs[Role].grades[tostring(count-1)].isBoss = true
|
||||||
|
--print(Grades.label.." Grade: "..count.." is Boss")
|
||||||
|
::continue::
|
||||||
end
|
end
|
||||||
-- ESX Default doesn't have gangs, so copy jobs to gangs
|
-- ESX Default doesn't have gangs, so copy jobs to gangs
|
||||||
Gangs = Jobs
|
Gangs = Jobs
|
||||||
@@ -276,7 +338,7 @@ elseif isStarted(RSGExport) then
|
|||||||
end
|
end
|
||||||
|
|
||||||
if jobResource == nil then
|
if jobResource == nil then
|
||||||
print("^4ERROR^7: ^2No Vehicle info detected ^7- ^2Check ^3starter^1.^2lua^7")
|
print("^4ERROR^7: ^2No Job info detected ^7- ^2Check ^3starter^1.^2lua^7")
|
||||||
else
|
else
|
||||||
while not Jobs do Wait(1000) end
|
while not Jobs do Wait(1000) end
|
||||||
debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Jobs).." ^3Jobs^2 from ^7"..jobResource)
|
debugPrint("^6Bridge^7: ^2Loading ^6"..countTable(Jobs).." ^3Jobs^2 from ^7"..jobResource)
|
||||||
|
|||||||
@@ -353,8 +353,8 @@ function makeItem(data)
|
|||||||
Wait(200)
|
Wait(200)
|
||||||
end
|
end
|
||||||
if isInventoryOpen() then
|
if isInventoryOpen() then
|
||||||
print("^1Error^7: ^2Inventory is open, you tried to break things")
|
--print("^1Error^7: ^2Inventory is open, you tried to break things")
|
||||||
crafted, crafting = false, false
|
crafted, crafting, CraftLock = false, false, false
|
||||||
return
|
return
|
||||||
end
|
end
|
||||||
if crafted then
|
if crafted then
|
||||||
@@ -368,8 +368,9 @@ function makeItem(data)
|
|||||||
PlaySoundFromEntity(s.soundId, s.audioName, PlayerPedId(), s.audioRef, true, 0)
|
PlaySoundFromEntity(s.soundId, s.audioName, PlayerPedId(), s.audioRef, true, 0)
|
||||||
end
|
end
|
||||||
if isInventoryOpen() then
|
if isInventoryOpen() then
|
||||||
print("^1Error^7: ^2Inventory is open, you tried to break things")
|
--print("^1Error^7: ^2Inventory is open, you tried to break things")
|
||||||
crafted, crafting = false, false
|
crafted, crafting = false, false
|
||||||
|
crafted, crafting, CraftLock = false, false, false
|
||||||
return
|
return
|
||||||
end
|
end
|
||||||
if crafting and progressBar({
|
if crafting and progressBar({
|
||||||
|
|||||||
@@ -262,7 +262,7 @@ end
|
|||||||
--- ```
|
--- ```
|
||||||
function countTable(tbl)
|
function countTable(tbl)
|
||||||
local i = 0
|
local i = 0
|
||||||
for _ in pairs(tbl) do i = i + 1 end
|
for _ in pairs(tbl) do i += 1 end
|
||||||
return i
|
return i
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -550,6 +550,24 @@ end
|
|||||||
|
|
||||||
RegisterNetEvent(getScript()..":server:sendlog", sendServerLog)
|
RegisterNetEvent(getScript()..":server:sendlog", sendServerLog)
|
||||||
|
|
||||||
|
|
||||||
|
-- This function was created to help create random numbers
|
||||||
|
-- When you create a table of items with a random hunger value for example
|
||||||
|
-- `hunger = math.random(10, 20)` this will be set at script start and never change
|
||||||
|
-- using `hunger = {10, 20}` and then calling this function will make it generate a random number every time
|
||||||
|
-- It also fallsback if it simply recieved a number instead of a table
|
||||||
|
-- For example:
|
||||||
|
-- local hunger = {10, 20}
|
||||||
|
-- local hungerAmount = GetRandomTiming(hunger)
|
||||||
|
-- print(hungerAmount) -- number between 10, 20
|
||||||
|
function GetRandomTiming(tbl)
|
||||||
|
if type(tbl) == "table" then
|
||||||
|
return math.random(tbl[1], tbl[2])
|
||||||
|
else
|
||||||
|
return tbl
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
-------------------------------------------------------------
|
-------------------------------------------------------------
|
||||||
-- Material and Prop Functions
|
-- Material and Prop Functions
|
||||||
-------------------------------------------------------------
|
-------------------------------------------------------------
|
||||||
|
|||||||
@@ -50,8 +50,9 @@ function hasItem(items, amount, src)
|
|||||||
|
|
||||||
local count = 0
|
local count = 0
|
||||||
for _, itemData in pairs(grabInv) do
|
for _, itemData in pairs(grabInv) do
|
||||||
|
jsonPrint(itemData)
|
||||||
if itemData and itemData.name == item then
|
if itemData and itemData.name == item then
|
||||||
count += (itemData.count or itemData.amount or 1)
|
count += (itemData.amount or itemData.count or 1)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
foundInv = foundInv:gsub("%-", "^7-^6"):gsub("%_", "^7_^6")
|
foundInv = foundInv:gsub("%-", "^7-^6"):gsub("%_", "^7_^6")
|
||||||
@@ -67,6 +68,9 @@ function hasItem(items, amount, src)
|
|||||||
end
|
end
|
||||||
return true, hasTable
|
return true, hasTable
|
||||||
end
|
end
|
||||||
|
-- if can't find inventory, return false
|
||||||
|
print("^1Error^7: ^1Can't find players inventory for some reason")
|
||||||
|
return false, {}
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Retrieves a player's inventory based on the active inventory system.
|
--- Retrieves a player's inventory based on the active inventory system.
|
||||||
@@ -171,7 +175,6 @@ function getPlayerInv(src)
|
|||||||
return grabInv, foundInv
|
return grabInv, foundInv
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
function isInventoryOpen()
|
function isInventoryOpen()
|
||||||
if isStarted(OXInv) then
|
if isStarted(OXInv) then
|
||||||
return LocalPlayer.state.invBusy
|
return LocalPlayer.state.invBusy
|
||||||
|
|||||||
@@ -252,6 +252,7 @@ RegisterNetEvent(getScript()..":server:toggleItem", function(give, item, amount,
|
|||||||
else
|
else
|
||||||
local amountToAdd = amount or 1
|
local amountToAdd = amount or 1
|
||||||
if isStarted(OXInv) then invName = OXInv
|
if isStarted(OXInv) then invName = OXInv
|
||||||
|
jsonPrint(info)
|
||||||
exports[OXInv]:AddItem(src, item, amountToAdd, info, slot)
|
exports[OXInv]:AddItem(src, item, amountToAdd, info, slot)
|
||||||
|
|
||||||
elseif isStarted(QSInv) then invName = QSInv
|
elseif isStarted(QSInv) then invName = QSInv
|
||||||
@@ -639,7 +640,7 @@ function canCarry(itemTable, src)
|
|||||||
end
|
end
|
||||||
for k, v in pairs(itemTable) do
|
for k, v in pairs(itemTable) do
|
||||||
local itemInfo = Items[k]
|
local itemInfo = Items[k]
|
||||||
if not itemInfo and not Player.Offline then
|
if not itemInfo then
|
||||||
resultTable[k] = true
|
resultTable[k] = true
|
||||||
else
|
else
|
||||||
resultTable[k] = (totalWeight + (itemInfo.weight * v)) <= InventoryWeight
|
resultTable[k] = (totalWeight + (itemInfo.weight * v)) <= InventoryWeight
|
||||||
@@ -656,7 +657,7 @@ function canCarry(itemTable, src)
|
|||||||
end
|
end
|
||||||
for k, v in pairs(itemTable) do
|
for k, v in pairs(itemTable) do
|
||||||
local itemInfo = Items[k]
|
local itemInfo = Items[k]
|
||||||
if not itemInfo and not Player.Offline then
|
if not itemInfo then
|
||||||
resultTable[k] = true
|
resultTable[k] = true
|
||||||
else
|
else
|
||||||
resultTable[k] = (totalWeight + (itemInfo.weight * v)) <= InventoryWeight
|
resultTable[k] = (totalWeight + (itemInfo.weight * v)) <= InventoryWeight
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ function makeBossRoles(role)
|
|||||||
local data = (Jobs and Jobs[role]) or (Gangs and Gangs[role])
|
local data = (Jobs and Jobs[role]) or (Gangs and Gangs[role])
|
||||||
if data then
|
if data then
|
||||||
for grade, info in pairs(data.grades) do
|
for grade, info in pairs(data.grades) do
|
||||||
if info.isboss or info.bankAuth then
|
if info.isboss or info.bankAuth or info.isBoss then
|
||||||
boss[role] = boss[role] and math.min(boss[role], tonumber(grade)) or tonumber(grade)
|
boss[role] = boss[role] and math.min(boss[role], tonumber(grade)) or tonumber(grade)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ function makeBlip(data)
|
|||||||
AddTextComponentString(tostring(data.name))
|
AddTextComponentString(tostring(data.name))
|
||||||
EndTextCommandSetBlipName(blip)
|
EndTextCommandSetBlipName(blip)
|
||||||
-- Handle preview image if certain resources are running
|
-- Handle preview image if certain resources are running
|
||||||
if isStarted("fs_smallresources") or isStarted("blip_info") or isStarted("blipinfo") then
|
if isStarted("jim-blipcontroller") then
|
||||||
if data.preview then
|
if data.preview then
|
||||||
local txname = string.gsub(tostring(data.name..'preview'..string.gsub(data.coords.z, "%.", "")), "[ ()~]", "")
|
local txname = string.gsub(tostring(data.name..'preview'..string.gsub(data.coords.z, "%.", "")), "[ ()~]", "")
|
||||||
if data.preview:find("http") or data.preview:find("nui") then
|
if data.preview:find("http") or data.preview:find("nui") then
|
||||||
@@ -62,8 +62,11 @@ function makeBlip(data)
|
|||||||
else
|
else
|
||||||
CreateRuntimeTextureFromImage(scriptTxd, txname, data.preview)
|
CreateRuntimeTextureFromImage(scriptTxd, txname, data.preview)
|
||||||
end
|
end
|
||||||
exports["fs_smallresources"]:SetBlipInfoImage(blip, getScript()..'scriptTxd', txname)
|
exports["jim-blipcontroller"]:ShowBlipInfo(blip, {
|
||||||
exports["fs_smallresources"]:SetBlipInfoTitle(blip, data.name, false)
|
title = data.name,
|
||||||
|
dict = getScript()..'scriptTxd',
|
||||||
|
tex = txname,
|
||||||
|
})
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -539,6 +539,7 @@ function getPlayer(source)
|
|||||||
local src = tonumber(source)
|
local src = tonumber(source)
|
||||||
if isStarted(ESXExport) then
|
if isStarted(ESXExport) then
|
||||||
local info = ESX.GetPlayerFromId(src)
|
local info = ESX.GetPlayerFromId(src)
|
||||||
|
if not info then return {} end
|
||||||
Player = {
|
Player = {
|
||||||
name = info.getName(),
|
name = info.getName(),
|
||||||
cash = info.getMoney(),
|
cash = info.getMoney(),
|
||||||
@@ -563,9 +564,10 @@ function getPlayer(source)
|
|||||||
local chunk = assert(load(import, ('@@ox_core/%s'):format(file)))
|
local chunk = assert(load(import, ('@@ox_core/%s'):format(file)))
|
||||||
chunk()
|
chunk()
|
||||||
local player = Ox.GetPlayer(src)
|
local player = Ox.GetPlayer(src)
|
||||||
|
if not player then return {} end
|
||||||
Player = {
|
Player = {
|
||||||
firstname = player.firstName,
|
firstname = player.firstName,
|
||||||
lastname = player.lastName ,
|
lastname = player.lastName,
|
||||||
name = ('%s %s'):format(player.firstName, player.lastName),
|
name = ('%s %s'):format(player.firstName, player.lastName),
|
||||||
cash = exports[OXInv]:Search(src, 'count', "money"),
|
cash = exports[OXInv]:Search(src, 'count', "money"),
|
||||||
bank = 0,
|
bank = 0,
|
||||||
@@ -577,10 +579,11 @@ function getPlayer(source)
|
|||||||
--onDuty = info.job.onduty,
|
--onDuty = info.job.onduty,
|
||||||
--account = info.charinfo.account,
|
--account = info.charinfo.account,
|
||||||
citizenId = player.stateId,
|
citizenId = player.stateId,
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
elseif isStarted(QBXExport) then
|
elseif isStarted(QBXExport) then
|
||||||
local info = exports[QBXExport]:GetPlayer(src)
|
local info = exports[QBXExport]:GetPlayer(src)
|
||||||
|
if not info then return {} end
|
||||||
Player = {
|
Player = {
|
||||||
firstname = info.PlayerData.charinfo.firstname,
|
firstname = info.PlayerData.charinfo.firstname,
|
||||||
lastname = info.PlayerData.charinfo.lastname,
|
lastname = info.PlayerData.charinfo.lastname,
|
||||||
@@ -601,9 +604,11 @@ function getPlayer(source)
|
|||||||
isDown = info.PlayerData.metadata["inlaststand"],
|
isDown = info.PlayerData.metadata["inlaststand"],
|
||||||
charInfo = info.charinfo,
|
charInfo = info.charinfo,
|
||||||
}
|
}
|
||||||
|
|
||||||
elseif isStarted(QBExport) and not isStarted(QBXExport) then
|
elseif isStarted(QBExport) and not isStarted(QBXExport) then
|
||||||
if Core.Functions.GetPlayer then
|
if Core.Functions.GetPlayer(src) then
|
||||||
local info = Core.Functions.GetPlayer(src).PlayerData
|
local info = Core.Functions.GetPlayer(src).PlayerData
|
||||||
|
if not info then return {} end
|
||||||
Player = {
|
Player = {
|
||||||
firstname = info.charinfo.firstname,
|
firstname = info.charinfo.firstname,
|
||||||
lastname = info.charinfo.lastname,
|
lastname = info.charinfo.lastname,
|
||||||
@@ -625,9 +630,11 @@ function getPlayer(source)
|
|||||||
charInfo = info.charinfo,
|
charInfo = info.charinfo,
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
elseif isStarted(RSGExport) then
|
elseif isStarted(RSGExport) then
|
||||||
if Core.Functions.GetPlayer then
|
if Core.Functions.GetPlayer(src) then
|
||||||
local info = Core.Functions.GetPlayer(src).PlayerData
|
local info = Core.Functions.GetPlayer(src).PlayerData
|
||||||
|
if not info then return {} end
|
||||||
Player = {
|
Player = {
|
||||||
firstname = info.charinfo.firstname,
|
firstname = info.charinfo.firstname,
|
||||||
lastname = info.charinfo.lastname,
|
lastname = info.charinfo.lastname,
|
||||||
@@ -648,6 +655,7 @@ function getPlayer(source)
|
|||||||
isDown = info.metadata["inlaststand"],
|
isDown = info.metadata["inlaststand"],
|
||||||
charInfo = info.charinfo,
|
charInfo = info.charinfo,
|
||||||
}
|
}
|
||||||
|
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
print("^4ERROR^7: ^2No Core detected for getPlayer() - Check starter.lua")
|
print("^4ERROR^7: ^2No Core detected for getPlayer() - Check starter.lua")
|
||||||
@@ -656,6 +664,8 @@ function getPlayer(source)
|
|||||||
-- Client-side: Get current player info.
|
-- Client-side: Get current player info.
|
||||||
if isStarted(ESXExport) and ESX ~= nil then
|
if isStarted(ESXExport) and ESX ~= nil then
|
||||||
local info = ESX.GetPlayerData()
|
local info = ESX.GetPlayerData()
|
||||||
|
if not info.firstName then return {} end
|
||||||
|
|
||||||
local cash, bank = 0, 0
|
local cash, bank = 0, 0
|
||||||
for k, v in pairs(info.accounts) do
|
for k, v in pairs(info.accounts) do
|
||||||
if v.name == "money" then cash = v.money end
|
if v.name == "money" then cash = v.money end
|
||||||
@@ -678,7 +688,9 @@ function getPlayer(source)
|
|||||||
isDead = IsEntityDead(PlayerPedId()),
|
isDead = IsEntityDead(PlayerPedId()),
|
||||||
isDown = IsPedDeadOrDying(PlayerPedId(), true)
|
isDown = IsPedDeadOrDying(PlayerPedId(), true)
|
||||||
}
|
}
|
||||||
|
|
||||||
elseif isStarted(OXCoreExport) then
|
elseif isStarted(OXCoreExport) then
|
||||||
|
if not OxPlayer.userId then return {} end
|
||||||
Player = {
|
Player = {
|
||||||
firstname = OxPlayer.get("firstName"),
|
firstname = OxPlayer.get("firstName"),
|
||||||
lastname = OxPlayer.get("lastName"),
|
lastname = OxPlayer.get("lastName"),
|
||||||
@@ -696,8 +708,10 @@ function getPlayer(source)
|
|||||||
isDead = IsEntityDead(PlayerPedId()),
|
isDead = IsEntityDead(PlayerPedId()),
|
||||||
isDown = IsPedDeadOrDying(PlayerPedId(), true)
|
isDown = IsPedDeadOrDying(PlayerPedId(), true)
|
||||||
}
|
}
|
||||||
|
|
||||||
elseif isStarted(QBXExport) then
|
elseif isStarted(QBXExport) then
|
||||||
local info = exports[QBXExport]:GetPlayerData()
|
local info = exports[QBXExport]:GetPlayerData()
|
||||||
|
if not info.charinfo then return {} end
|
||||||
Player = {
|
Player = {
|
||||||
firstname = info.charinfo.firstname,
|
firstname = info.charinfo.firstname,
|
||||||
lastname = info.charinfo.lastname,
|
lastname = info.charinfo.lastname,
|
||||||
@@ -718,9 +732,12 @@ function getPlayer(source)
|
|||||||
isDown = info.metadata["inlaststand"],
|
isDown = info.metadata["inlaststand"],
|
||||||
charInfo = info.charinfo,
|
charInfo = info.charinfo,
|
||||||
}
|
}
|
||||||
|
|
||||||
elseif isStarted(QBExport) and not isStarted(QBXExport) then
|
elseif isStarted(QBExport) and not isStarted(QBXExport) then
|
||||||
local info = nil
|
local info = nil
|
||||||
Core.Functions.GetPlayerData(function(PlayerData) info = PlayerData end)
|
Core.Functions.GetPlayerData(function(PlayerData) info = PlayerData end)
|
||||||
|
if not info.charinfo then return {} end
|
||||||
|
|
||||||
Player = {
|
Player = {
|
||||||
firstname = info.charinfo.firstname,
|
firstname = info.charinfo.firstname,
|
||||||
lastname = info.charinfo.lastname,
|
lastname = info.charinfo.lastname,
|
||||||
@@ -741,9 +758,12 @@ function getPlayer(source)
|
|||||||
isDown = info.metadata["inlaststand"],
|
isDown = info.metadata["inlaststand"],
|
||||||
charInfo = info.charinfo,
|
charInfo = info.charinfo,
|
||||||
}
|
}
|
||||||
|
|
||||||
elseif isStarted(RSGExport) then
|
elseif isStarted(RSGExport) then
|
||||||
local info = nil
|
local info = nil
|
||||||
Core.Functions.GetPlayerData(function(PlayerData) info = PlayerData end)
|
Core.Functions.GetPlayerData(function(PlayerData) info = PlayerData end)
|
||||||
|
if not info.charinfo then return {} end
|
||||||
|
|
||||||
Player = {
|
Player = {
|
||||||
firstname = info.charinfo.firstname,
|
firstname = info.charinfo.firstname,
|
||||||
lastname = info.charinfo.lastname,
|
lastname = info.charinfo.lastname,
|
||||||
@@ -764,6 +784,7 @@ function getPlayer(source)
|
|||||||
isDown = info.metadata["inlaststand"],
|
isDown = info.metadata["inlaststand"],
|
||||||
charInfo = info.charinfo,
|
charInfo = info.charinfo,
|
||||||
}
|
}
|
||||||
|
|
||||||
else
|
else
|
||||||
print("^4ERROR^7: ^2No Core detected for hasJob ^7- ^2Check ^3starter^1.^2lua^7")
|
print("^4ERROR^7: ^2No Core detected for hasJob ^7- ^2Check ^3starter^1.^2lua^7")
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -30,15 +30,18 @@ function sellMenu(data)
|
|||||||
for k, v in pairs(data.sellTable.Items) do itemList[k] = 1 end
|
for k, v in pairs(data.sellTable.Items) do itemList[k] = 1 end
|
||||||
local _, hasTable = hasItem(itemList)
|
local _, hasTable = hasItem(itemList)
|
||||||
for k, v in pairsByKeys(data.sellTable.Items) do
|
for k, v in pairsByKeys(data.sellTable.Items) do
|
||||||
Menu[#Menu + 1] = {
|
if Items[k] then
|
||||||
isMenuHeader = not hasTable[k].hasItem,
|
Menu[#Menu + 1] = {
|
||||||
icon = invImg(k),
|
isMenuHeader = not hasTable[k].hasItem,
|
||||||
header = Items[k].label..(hasTable[k].hasItem and "💰 (x"..hasTable[k].count..")" or ""),
|
icon = invImg(k),
|
||||||
txt = Loc[Config.Lan].info["sell_all"]..v.." "..Loc[Config.Lan].info["sell_each"],
|
header = Items[k].label..(hasTable[k].hasItem and "💰 (x"..hasTable[k].count..")" or ""),
|
||||||
onSelect = function()
|
txt = (Loc and Loc[Config.Lan]) and Loc[Config.Lan].info["sell_all"]..v.." "..Loc[Config.Lan].info["sell_each"]
|
||||||
sellAnim({ item = k, price = v, ped = data.ped, onBack = function() sellMenu(data) end })
|
or "Sell ALL at $"..v.." each",
|
||||||
end,
|
onSelect = function()
|
||||||
}
|
sellAnim({ item = k, price = v, ped = data.ped, onBack = function() sellMenu(data) end })
|
||||||
|
end,
|
||||||
|
}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
else
|
else
|
||||||
for k, v in pairsByKeys(data.sellTable) do
|
for k, v in pairsByKeys(data.sellTable) do
|
||||||
@@ -48,7 +51,9 @@ function sellMenu(data)
|
|||||||
header = k,
|
header = k,
|
||||||
txt = "Amount of items: "..countTable(v.Items),
|
txt = "Amount of items: "..countTable(v.Items),
|
||||||
onSelect = function()
|
onSelect = function()
|
||||||
v.onBack = function() sellMenu(origData) end
|
v.onBack = function()
|
||||||
|
sellMenu(origData)
|
||||||
|
end
|
||||||
v.sellTable = data.sellTable[k]
|
v.sellTable = data.sellTable[k]
|
||||||
sellMenu(v)
|
sellMenu(v)
|
||||||
end,
|
end,
|
||||||
@@ -57,8 +62,8 @@ function sellMenu(data)
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
openMenu(Menu, {
|
openMenu(Menu, {
|
||||||
header = data.sellTable.Header or "Amount of items: "..countTable(data.sellTable.Items),
|
header = data.sellTable.Header or "Amount of items: "..countTable(data.sellTable.Items or data.sellTable),
|
||||||
headertxt = data.sellTable.Header and "Amount of items: "..countTable(data.sellTable.Items) or "",
|
headertxt = data.sellTable.Header and "Amount of items: "..countTable(data.sellTable.Items or data.sellTable),
|
||||||
canClose = true,
|
canClose = true,
|
||||||
onBack = data.onBack,
|
onBack = data.onBack,
|
||||||
})
|
})
|
||||||
@@ -105,12 +110,14 @@ function sellAnim(data)
|
|||||||
TriggerServerEvent(getScript().."Sellitems", data)
|
TriggerServerEvent(getScript().."Sellitems", data)
|
||||||
lookEnt(data.ped)
|
lookEnt(data.ped)
|
||||||
local dict = "mp_common"
|
local dict = "mp_common"
|
||||||
playAnim(dict, "givetake2_a", 0.3, 2)
|
playAnim(dict, "givetake2_a", 0.3, 48)
|
||||||
playAnim(dict, "givetake2_b", 0.3, 2, data.ped)
|
playAnim(dict, "givetake2_b", 0.3, 48, data.ped)
|
||||||
Wait(2000)
|
Wait(2000)
|
||||||
StopAnimTask(PlayerPedId(), dict, "givetake2_a", 0.5)
|
StopAnimTask(PlayerPedId(), dict, "givetake2_a", 0.5)
|
||||||
StopAnimTask(data.ped, dict, "givetake2_b", 0.5)
|
StopAnimTask(data.ped, dict, "givetake2_b", 0.5)
|
||||||
if data.onBack then data.onBack() end
|
if data.onBack then
|
||||||
|
data.onBack()
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
--- Server event handler for processing item sales.
|
--- Server event handler for processing item sales.
|
||||||
|
|||||||
@@ -8,6 +8,7 @@
|
|||||||
• Renewed-Banking
|
• Renewed-Banking
|
||||||
• fd_banking
|
• fd_banking
|
||||||
• okokBanking
|
• okokBanking
|
||||||
|
• Tgiann-bank
|
||||||
]]
|
]]
|
||||||
|
|
||||||
--- Retrieves the current balance of a society's bank account.
|
--- Retrieves the current balance of a society's bank account.
|
||||||
@@ -54,6 +55,14 @@ function getSocietyAccount(society)
|
|||||||
elseif isStarted("okokBanking") then
|
elseif isStarted("okokBanking") then
|
||||||
bankScript = "okokBanking"
|
bankScript = "okokBanking"
|
||||||
amount = exports['okokBanking']:GetAccount(society)
|
amount = exports['okokBanking']:GetAccount(society)
|
||||||
|
|
||||||
|
elseif isStarted("tgiann-bank") then
|
||||||
|
bankScript = "tgiann-bank"
|
||||||
|
if Jobs[society] then
|
||||||
|
amount = exports["tgiann-bank"]:GetJobAccountBalance(society)
|
||||||
|
else
|
||||||
|
amount = exports["tgiann-bank"]:GetGangAccountBalance(society)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
if bankScript == "" then
|
if bankScript == "" then
|
||||||
@@ -104,6 +113,13 @@ function chargeSociety(society, amount)
|
|||||||
bankScript = "okokBanking"
|
bankScript = "okokBanking"
|
||||||
exports['okokBanking']:RemoveMoney(society, amount)
|
exports['okokBanking']:RemoveMoney(society, amount)
|
||||||
|
|
||||||
|
elseif isStarted("tgiann-bank") then
|
||||||
|
bankScript = "tgiann-bank"
|
||||||
|
if Jobs[society] then
|
||||||
|
exports["tgiann-bank"]:RemoveJobMoney(society, amount)
|
||||||
|
else
|
||||||
|
exports["tgiann-bank"]:RemoveGangMoney(society, amount)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
if bankScript == "" then
|
if bankScript == "" then
|
||||||
@@ -122,7 +138,7 @@ end
|
|||||||
--- fundSociety("police", 500)
|
--- fundSociety("police", 500)
|
||||||
--- ```
|
--- ```
|
||||||
function fundSociety(society, amount)
|
function fundSociety(society, amount)
|
||||||
local bankScript, newAmount = "", 0
|
local bankScript, newAmount, success = "", 0, false
|
||||||
|
|
||||||
|
|
||||||
if isStarted("qb-banking") then
|
if isStarted("qb-banking") then
|
||||||
@@ -159,6 +175,13 @@ function fundSociety(society, amount)
|
|||||||
bankScript = "okokBanking"
|
bankScript = "okokBanking"
|
||||||
exports['okokBanking']:AddMoney(society, amount)
|
exports['okokBanking']:AddMoney(society, amount)
|
||||||
|
|
||||||
|
elseif isStarted("tgiann-bank") then
|
||||||
|
bankScript = "tgiann-bank"
|
||||||
|
if Jobs[society] then
|
||||||
|
exports["tgiann-bank"]:AddJobMoney(society, amount)
|
||||||
|
else
|
||||||
|
exports["tgiann-bank"]:AddGangMoney(society, amount)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
if bankScript == "" then
|
if bankScript == "" then
|
||||||
|
|||||||
@@ -161,7 +161,10 @@ function openStash(data)
|
|||||||
})
|
})
|
||||||
else
|
else
|
||||||
TriggerEvent("inventory:client:SetCurrentStash", data.stash)
|
TriggerEvent("inventory:client:SetCurrentStash", data.stash)
|
||||||
TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, data.stashOptions)
|
TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, {
|
||||||
|
slots = data.slots or 50,
|
||||||
|
maxWeight = data.maxWeight or 600000
|
||||||
|
})
|
||||||
end
|
end
|
||||||
|
|
||||||
elseif isStarted(PSInv) then
|
elseif isStarted(PSInv) then
|
||||||
@@ -174,7 +177,10 @@ function openStash(data)
|
|||||||
})
|
})
|
||||||
else
|
else
|
||||||
TriggerEvent("inventory:client:SetCurrentStash", data.stash)
|
TriggerEvent("inventory:client:SetCurrentStash", data.stash)
|
||||||
TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, data.stashOptions)
|
TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, {
|
||||||
|
slots = data.slots or 50,
|
||||||
|
maxWeight = data.maxWeight or 600000
|
||||||
|
})
|
||||||
end
|
end
|
||||||
|
|
||||||
elseif isStarted(RSGInv) then
|
elseif isStarted(RSGInv) then
|
||||||
@@ -188,7 +194,10 @@ function openStash(data)
|
|||||||
else
|
else
|
||||||
--Fallback to these commands
|
--Fallback to these commands
|
||||||
TriggerEvent("inventory:client:SetCurrentStash", data.stash)
|
TriggerEvent("inventory:client:SetCurrentStash", data.stash)
|
||||||
TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, data.stashOptions)
|
TriggerServerEvent("inventory:server:OpenInventory", "stash", data.stash, {
|
||||||
|
slots = data.slots or 50,
|
||||||
|
maxWeight = data.maxWeight or 600000
|
||||||
|
})
|
||||||
end
|
end
|
||||||
|
|
||||||
lookEnt(data.coords)
|
lookEnt(data.coords)
|
||||||
@@ -520,9 +529,9 @@ function registerStash(name, label, slots, weight, owner, coords)
|
|||||||
debugPrint("^6Bridge^7: ^2Registering ^3OX ^2Stash^7:", name, label, owner or nil)
|
debugPrint("^6Bridge^7: ^2Registering ^3OX ^2Stash^7:", name, label, owner or nil)
|
||||||
exports[OXInv]:RegisterStash(name, label, slots or 50, weight or 4000000, owner or nil)
|
exports[OXInv]:RegisterStash(name, label, slots or 50, weight or 4000000, owner or nil)
|
||||||
|
|
||||||
elseif isStarted(QSInv) then
|
--elseif isStarted(QSInv) then
|
||||||
debugPrint("^6Bridge^7: ^2Registering ^3QS ^2Stash^7:", name, label)
|
-- debugPrint("^6Bridge^7: ^2Registering ^3QS ^2Stash^7:", name, label)
|
||||||
exports[QSInv]:RegisterStash(name, label, slots or 50, weight or 4000000)
|
-- exports[QSInv]:RegisterStash(name, label, slots or 50, weight or 4000000)
|
||||||
|
|
||||||
--elseif isStarted(CoreInv) then
|
--elseif isStarted(CoreInv) then
|
||||||
-- debugPrint("^6Bridge^7: ^2Registering ^3CoreInv ^2Stash^7:", name, label)
|
-- debugPrint("^6Bridge^7: ^2Registering ^3CoreInv ^2Stash^7:", name, label)
|
||||||
@@ -565,3 +574,18 @@ if isServer() then
|
|||||||
registerStash(name, label, slots, weight, owner, coords)
|
registerStash(name, label, slots, weight, owner, coords)
|
||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
RegisterNetEvent(getScript()..":openGrabBox", function(data)
|
||||||
|
if isStarted(OXInv) then
|
||||||
|
return
|
||||||
|
end
|
||||||
|
local id = ""
|
||||||
|
if data.metadata then
|
||||||
|
id = data.metadata.id
|
||||||
|
elseif data.info then
|
||||||
|
id = data.info.id
|
||||||
|
end
|
||||||
|
openStash({
|
||||||
|
stash = id,
|
||||||
|
})
|
||||||
|
end)
|
||||||
13
starter.lua
13
starter.lua
@@ -81,16 +81,23 @@ for Type, ScriptTable in pairs(filesToLoad) do
|
|||||||
local state = GetResourceState(scriptName)
|
local state = GetResourceState(scriptName)
|
||||||
-- if the resource is started, load the file
|
-- if the resource is started, load the file
|
||||||
if state == "started" then
|
if state == "started" then
|
||||||
|
if scriptName == Exports.OXLibExport and GetResourceState(Exports.OXCoreExport):find("start") then
|
||||||
|
if debugMode then print("OX_Core found, skipping OX_Lib loading") end
|
||||||
|
goto skip
|
||||||
|
end
|
||||||
-- Force items into a table if they are not
|
-- Force items into a table if they are not
|
||||||
if type(files) == "string" then
|
if type(files) == "string" then
|
||||||
files = { files }
|
files = { files }
|
||||||
end
|
end
|
||||||
for _, file in pairs(files) do
|
for _, file in pairs(files) do
|
||||||
--print("^5CoreLoader^7: '"..k.."/"..file.."' ^2into ^7'"..GetCurrentResourceName().."' ...")
|
--print("^5CoreLoader^7: '"..scriptName.."/"..file.."' ^2into ^7'"..GetCurrentResourceName().."' ...")
|
||||||
local fileLoader = assert(load(LoadResourceFile(scriptName, (file)), ('@@'..scriptName..'/'..file)))
|
local fileLoader = assert(load(LoadResourceFile(scriptName, (file)), ('@@'..scriptName..'/'..file)))
|
||||||
fileLoader()
|
fileLoader()
|
||||||
print("^5CoreLoader^7: ^2loaded ^1Core ^2file^7: ^3"..scriptName.."^7/^3"..(file):gsub("/", "^7/^3"):gsub("%.lua", "^7.lua").." ^2into ^7'"..GetCurrentResourceName().."'")
|
if debugMode then
|
||||||
|
print("^5CoreLoader^7: ^2loaded ^1Core ^2file^7: ^3"..scriptName.."^7/^3"..(file):gsub("/", "^7/^3"):gsub("%.lua", "^7.lua").." ^2into ^7'"..GetCurrentResourceName().."'")
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
::skip::
|
||||||
end
|
end
|
||||||
|
|
||||||
-- if script is in server, but not started warn the user
|
-- if script is in server, but not started warn the user
|
||||||
@@ -118,7 +125,7 @@ for _, v in pairs({ -- This is a specific load order
|
|||||||
|
|
||||||
'_eventDebug.lua',
|
'_eventDebug.lua',
|
||||||
'callback.lua',
|
'callback.lua',
|
||||||
'coreloader.lua', -- needs to be second to load all core related stuff before everything else
|
'coreloader.lua',
|
||||||
|
|
||||||
'duifunctions.lua',
|
'duifunctions.lua',
|
||||||
|
|
||||||
|
|||||||
13
version.txt
13
version.txt
@@ -1 +1,12 @@
|
|||||||
2.0.09
|
2.0.14
|
||||||
|
|
||||||
|
- Add getPlayer() fallbacks for if player isn't loaded
|
||||||
|
- Add fallback for sellMenu missing locales
|
||||||
|
- Change blip preview export to "jim-blipcontroller"
|
||||||
|
- Support for tgiann-bank
|
||||||
|
- Fixes for OX_Core COX version
|
||||||
|
- Fix QBOX weapons not being added to "Items" cache
|
||||||
|
- Remove Player.Offline from canCarry() as it was erroring
|
||||||
|
- Possible fix for QS_Inv stashes wiping on script start
|
||||||
|
|
||||||
|
https://github.com/jimathy/jim_bridge
|
||||||
Reference in New Issue
Block a user