CSTMGames
/
FiveM_Snippets
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Updating for new snipets

This commit is contained in:
Chase Eller 2026-03-25 18:58:21 -04:00
parent 224b610aac
commit bdfdfe1cb4
No known key found for this signature in database
GPG Key ID: 9233D42F495E657C
7 changed files with 129 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -30,3 +30,7 @@ I will use this area to keep up with what i did last.
## [Release 1.1.4] ## [Release 1.1.4]
- Updated logging functions on all scripts and snippets to allow for the new on the fly log change. - Updated logging functions on all scripts and snippets to allow for the new on the fly log change.
## [Release 1.1.5]
- The Christina update
- Added in cleaner snippets for SLF and updated templates to match when creating a new resource.

2
package.json
View File

@ -2,7 +2,7 @@
"name": "cstmgames-fivem-snippets", "name": "cstmgames-fivem-snippets",
"displayName": "CSTMGames FiveM Dev Tools", "displayName": "CSTMGames FiveM Dev Tools",
"description": "Development tools for FiveM", "description": "Development tools for FiveM",
"version": "1.1.4", "version": "1.1.5",
"author": { "author": {
"name": "Chase Eller", "name": "Chase Eller",
"email": "chase@cstmgames.com", "email": "chase@cstmgames.com",

70
snippets/cstmcommonfunctions.code-snippets
View File

@ -5,10 +5,25 @@
"description": "Sets up basic Log function for use with SLF" "description": "Sets up basic Log function for use with SLF"
}, },
"Log to Discord": { "Log to Discord": {
"prefix": "DisLog", "prefix": "DisLogCall",
"body": "DisLog(\"${1:Your Error Text Here}\")$0", "body": "DisLog(\"${1:Your Error Text Here}\")$0",
"description": "SLF Function to log error to Discord." "description": "SLF Function to log error to Discord."
}, },
"DISLOG FUNCTION": {
"prefix": "DISLOG",
"body": [
"local function DisLog(message)",
" local line = debug.getinfo(2, \"l\").currentline",
" local name = debug.getinfo(2, \"n\").name",
" if name == \"fn\" then",
" name = \"Thread\"",
" end",
" local value = \"{\"..CLASS..\".\"..name..\"(\"..line..\")} \"..message",
" exports.SLF:LogServerToDiscord(RESOURCE_CODE, message)",
"end"
],
"description": "DISLOG FUNCTION"
},
"Sets up a basic Citizen Thread for CFX": { "Sets up a basic Citizen Thread for CFX": {
"prefix": "thread", "prefix": "thread",
"body": [ "body": [
@ -42,13 +57,11 @@
"SLF Functions and Vars for server.": { "SLF Functions and Vars for server.": {
"prefix": "SLFSERVER", "prefix": "SLFSERVER",
"body": [ "body": [
"--GLOBAL CONSTANTS", "--SLF CONSTANTS",
"local CLASS = \"CHANGEME\"--This is the name that the logging framework will use to display your logs in the correct manner", "local CLASS = \"CHANGEME\"--This is the name that the logging framework will use to display your logs in the correct manner",
"local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), \"log_level\", 0)", "local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), \"log_level\", 0)",
"local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), \"resource_code\", 0)", "local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), \"resource_code\", 0)",
"------------------------------------------------------------------------------------------------", "------------------------------------------------------------------------------------------------",
"--SLF Server Logging Function DO NOT TOUCH unless you know what you are doing.",
"",
"---Used to send logs to the server console", "---Used to send logs to the server console",
"---@param message any Preformatted message or VARIABLES to be sent to log", "---@param message any Preformatted message or VARIABLES to be sent to log",
"---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug", "---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug",
@ -69,31 +82,22 @@
" end", " end",
"end", "end",
"", "",
"local function DisLog(message)",
" local line = debug.getinfo(2, \"l\").currentline",
" local name = debug.getinfo(2, \"n\").name",
" if name == \"fn\" then",
" name = \"Thread\"",
" end",
" local value = \"{\"..CLASS..\".\"..name..\"(\"..line..\")} \"..message",
" exports.SLF:LogServerToDiscord(RESOURCE_CODE, message)",
"end",
"RegisterNetEvent(RESOURCE_CODE..\":UpdateLogLevel\")", "RegisterNetEvent(RESOURCE_CODE..\":UpdateLogLevel\")",
"AddEventHandler(RESOURCE_CODE..\":UpdateLogLevel\", function(num)", "AddEventHandler(RESOURCE_CODE..\":UpdateLogLevel\", function(num)",
" LOG_LEVEL = num", " LOG_LEVEL = num",
"end)" "end)",
"-----------------------------------------------------------------------------------------------"
], ],
"description": "SLF Functions and Vars for server." "description": "SLF Functions and Vars for server."
}, },
"SLF Functions and Vars for client.": { "SLF Functions and Vars for client.": {
"prefix": "SLFCLIENT", "prefix": "SLFCLIENT",
"body": [ "body": [
"--GLOBAL CONSTANTS", "--SLF CONSTANTS",
"local CLASS = \"CHANGEME\"--This is the name that the logging framework will use to display your logs in the correct manner", "local CLASS = \"CHANGEME\"--This is the name that the logging framework will use to display your logs in the correct manner",
"local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), \"log_level\", 0)", "local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), \"log_level\", 0)",
"local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), \"resource_code\", 0)", "local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), \"resource_code\", 0)",
"-----------------------------------------------------------------------------------------------", "-----------------------------------------------------------------------------------------------",
"--SLF Server Logging Function DO NOT TOUCH unless you know what you are doing",
"---Used to send logs to the client console", "---Used to send logs to the client console",
"---@param message any Preformatted message or VARIABLES to be sent to log", "---@param message any Preformatted message or VARIABLES to be sent to log",
"---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug", "---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug",
@ -113,10 +117,12 @@
" Log(\"Warning line was logged without a level value... Logged it as debug as that is the safest route.\", 1)", " Log(\"Warning line was logged without a level value... Logged it as debug as that is the safest route.\", 1)",
" end", " end",
"end", "end",
"",
"RegisterNetEvent(RESOURCE_CODE..\":UpdateLogLevel\")", "RegisterNetEvent(RESOURCE_CODE..\":UpdateLogLevel\")",
"AddEventHandler(RESOURCE_CODE..\":UpdateLogLevel\", function(num)", "AddEventHandler(RESOURCE_CODE..\":UpdateLogLevel\", function(num)",
" LOG_LEVEL = num", " LOG_LEVEL = num",
"end)" "end)",
"-----------------------------------------------------------------------------------------------"
], ],
"description": "SLF Functions and Vars for client." "description": "SLF Functions and Vars for client."
}, },
@ -212,5 +218,35 @@
"end)" "end)"
], ],
"description": "Thread Net Register" "description": "Thread Net Register"
},
"Coding Regions": {
"prefix": "regions",
"body": [
"--CONSTANTS--",
"",
"",
"",
"--VARIABLES--",
"",
"",
"",
"--FUNCTIONS--",
"",
"",
"",
"--THREADS--",
"",
"",
"",
"--NET EVENTS--",
"",
"",
"",
"--COMMANDS--",
"",
"",
""
],
"description": "Coding Regions"
} }
} }

25
template/base/client/client.lua
View File

@ -1,9 +1,8 @@
--GLOBAL CONSTANTS --SLF CONSTANTS
local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner
local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0) local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0)
local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0) local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0)
----------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------
--SLF Server Logging Function DO NOT TOUCH unless you know what you are doing
---Used to send logs to the client console ---Used to send logs to the client console
---@param message any Preformatted message or VARIABLES to be sent to log ---@param message any Preformatted message or VARIABLES to be sent to log
---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug ---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug
@ -23,24 +22,32 @@ local function Log(message, logLevel)
Log("Warning line was logged without a level value... Logged it as debug as that is the safest route.", 1) Log("Warning line was logged without a level value... Logged it as debug as that is the safest route.", 1)
end end
end end
RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel") RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel")
AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num) AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
LOG_LEVEL = num LOG_LEVEL = num
end) end)
--LOCAL VARIABLES
--END CONFIG
----------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------
--CONSTANTS--
------------------- --VARIABLES--
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
--FUNCTIONS--
--THREADS--
--NET EVENTS--
--COMMANDS--

43
template/base/server/server.lua
View File

@ -1,10 +1,8 @@
--GLOBAL CONSTANTS --SLF CONSTANTS
local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner
local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0) local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0)
local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0) local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0)
------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------
--SLF Server Logging Function DO NOT TOUCH unless you know what you are doing.
---Used to send logs to the server console ---Used to send logs to the server console
---@param message any Preformatted message or VARIABLES to be sent to log ---@param message any Preformatted message or VARIABLES to be sent to log
---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug ---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug
@ -25,34 +23,31 @@ local function Log(message, logLevel)
end end
end end
local function DisLog(message)
local line = debug.getinfo(2, "l").currentline
local name = debug.getinfo(2, "n").name
if name == "fn" then
name = "Thread"
end
local value = "{"..CLASS.."."..name.."("..line..")} "..message
exports.SLF:LogServerToDiscord(RESOURCE_CODE, message)
end
RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel") RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel")
AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num) AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
LOG_LEVEL = num LOG_LEVEL = num
end) end)
--Global Variables ------------------------------------------------------------------------------------------------
--CONSTANTS--
--LOCAL VARIABLES
--END CONFIG
-----------------------------------------------------------------------------------------------
------------------- --VARIABLES--
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
--FUNCTIONS--
--THREADS--
--NET EVENTS--
--COMMANDS--

26
template/withFeature/client/client.lua
View File

@ -1,9 +1,8 @@
--GLOBAL CONSTANTS --SLF CONSTANTS
local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner
local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0) local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0)
local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0) local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0)
----------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------
--SLF Server Logging Function DO NOT TOUCH unless you know what you are doing
---Used to send logs to the client console ---Used to send logs to the client console
---@param message any Preformatted message or VARIABLES to be sent to log ---@param message any Preformatted message or VARIABLES to be sent to log
---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug ---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug
@ -23,25 +22,32 @@ local function Log(message, logLevel)
Log("Warning line was logged without a level value... Logged it as debug as that is the safest route.", 1) Log("Warning line was logged without a level value... Logged it as debug as that is the safest route.", 1)
end end
end end
RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel") RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel")
AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num) AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
LOG_LEVEL = num LOG_LEVEL = num
end) end)
--LOCAL VARIABLES
--END CONFIG
----------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------
--CONSTANTS--
------------------- --VARIABLES--
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
--FUNCTIONS--
--THREADS--
--NET EVENTS--
--COMMANDS--

42
template/withFeature/server/server.lua
View File

@ -1,10 +1,8 @@
--GLOBAL CONSTANTS --SLF CONSTANTS
local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner local CLASS = "CHANGEME"--This is the name that the logging framework will use to display your logs in the correct manner
local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0) local LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 0)
local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0) local RESOURCE_CODE = GetResourceMetadata(GetCurrentResourceName(), "resource_code", 0)
------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------
--SLF Server Logging Function DO NOT TOUCH unless you know what you are doing.
---Used to send logs to the server console ---Used to send logs to the server console
---@param message any Preformatted message or VARIABLES to be sent to log ---@param message any Preformatted message or VARIABLES to be sent to log
---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug ---@param logLevel integer Level of log, 1-Error, 2-Warn, 3-Info, 4-Debug
@ -25,33 +23,31 @@ local function Log(message, logLevel)
end end
end end
local function DisLog(message)
local line = debug.getinfo(2, "l").currentline
local name = debug.getinfo(2, "n").name
if name == "fn" then
name = "Thread"
end
local value = "{"..CLASS.."."..name.."("..line..")} "..message
exports.SLF:LogServerToDiscord(RESOURCE_CODE, message)
end
RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel") RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel")
AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num) AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
LOG_LEVEL = num LOG_LEVEL = num
end) end)
--Global Variables ------------------------------------------------------------------------------------------------
--CONSTANTS--
--LOCAL VARIABLES
--END CONFIG
-----------------------------------------------------------------------------------------------
------------------- --VARIABLES--
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
--FUNCTIONS--
--THREADS--
--NET EVENTS--
--COMMANDS--