Updating for new snipets

2026-03-25 18:58:21 -04:00 · 2026-03-25 18:58:21 -04:00 · bdfdfe1cb4
parent 224b610aac
commit bdfdfe1cb4
7 changed files with 129 additions and 85 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -29,4 +29,8 @@ I will use this area to keep up with what i did last.

 ## [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.
--- a/package.json
+++ b/package.json
@ -2,7 +2,7 @@
  "name": "cstmgames-fivem-snippets",
  "displayName": "CSTMGames FiveM Dev Tools",
  "description": "Development tools for FiveM",
-  "version": "1.1.4",
+  "version": "1.1.5",
  "author": {
    "name": "Chase Eller",
    "email": "chase@cstmgames.com",
--- a/snippets/cstmcommonfunctions.code-snippets
+++ b/snippets/cstmcommonfunctions.code-snippets
@ -5,10 +5,25 @@
    "description": "Sets up basic Log function for use with SLF"
  },
  "Log to Discord": {
-    "prefix": "DisLog",
+    "prefix": "DisLogCall",
    "body": "DisLog(\"${1:Your Error Text Here}\")$0",
    "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": {
    "prefix": "thread",
    "body": [
@ -42,13 +57,11 @@
  "SLF Functions and Vars for server.": {
    "prefix": "SLFSERVER",
    "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 LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), \"log_level\", 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",
      "---@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",
@ -69,31 +82,22 @@
      "  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\")",
      "AddEventHandler(RESOURCE_CODE..\":UpdateLogLevel\", function(num)",
      "  LOG_LEVEL = num",
-      "end)"
+      "end)",
+      "-----------------------------------------------------------------------------------------------"
    ],
    "description": "SLF Functions and Vars for server."
  },
  "SLF Functions and Vars for client.": {
    "prefix": "SLFCLIENT",
    "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 LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), \"log_level\", 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",
      "---@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",
@ -113,10 +117,12 @@
      "    Log(\"Warning line was logged without a level value... Logged it as debug as that is the safest route.\", 1)",
      "  end",
      "end",
+      "",
      "RegisterNetEvent(RESOURCE_CODE..\":UpdateLogLevel\")",
      "AddEventHandler(RESOURCE_CODE..\":UpdateLogLevel\", function(num)",
      "  LOG_LEVEL = num",
-      "end)"
+      "end)",
+      "-----------------------------------------------------------------------------------------------"
    ],
    "description": "SLF Functions and Vars for client."
  },
@ -212,5 +218,35 @@
      "end)"
    ],
    "description": "Thread Net Register"
+  },
+  "Coding Regions": {
+    "prefix": "regions",
+    "body": [
+      "--CONSTANTS--",
+      "",
+      "",
+      "",
+      "--VARIABLES--",
+      "",
+      "",
+      "",
+      "--FUNCTIONS--",
+      "",
+      "",
+      "",
+      "--THREADS--",
+      "",
+      "",
+      "",
+      "--NET EVENTS--",
+      "",
+      "",
+      "",
+      "--COMMANDS--",
+      "",
+      "",
+      ""
+    ],
+    "description": "Coding Regions"
  }
 }
--- a/template/base/client/client.lua
+++ b/template/base/client/client.lua
@ -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 LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 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
 ---@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
@ -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)
  end
 end
+
 RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel")
 AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
  LOG_LEVEL = num
 end)
--LOCAL VARIABLES
-
--END CONFIG
 -----------------------------------------------------------------------------------------------
+--CONSTANTS--



-------------------
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
+--VARIABLES--



+--FUNCTIONS--



+--THREADS--
+
+
+
+--NET EVENTS--
+
+
+
+--COMMANDS--
+
+
--- a/template/base/server/server.lua
+++ b/template/base/server/server.lua
@ -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 LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 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
 ---@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
@ -25,34 +23,31 @@ local function Log(message, logLevel)
  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")
 AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
  LOG_LEVEL = num
 end)
--Global Variables
-
--LOCAL VARIABLES
-
-
--END CONFIG
-----------------------------------------------------------------------------------------------
+------------------------------------------------------------------------------------------------
+--CONSTANTS--



-------------------
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
+--VARIABLES--



+--FUNCTIONS--
+
+
+
+--THREADS--
+
+
+
+--NET EVENTS--
+
+
+
+--COMMANDS--
+
+
--- a/template/withFeature/client/client.lua
+++ b/template/withFeature/client/client.lua
@ -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 LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 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
 ---@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
@ -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)
  end
 end
+
 RegisterNetEvent(RESOURCE_CODE..":UpdateLogLevel")
 AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
  LOG_LEVEL = num
 end)
-
--LOCAL VARIABLES
-
--END CONFIG
 -----------------------------------------------------------------------------------------------
+--CONSTANTS--



-------------------
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
+--VARIABLES--



+--FUNCTIONS--



+--THREADS--
+
+
+
+--NET EVENTS--
+
+
+
+--COMMANDS--
+
+
--- a/template/withFeature/server/server.lua
+++ b/template/withFeature/server/server.lua
@ -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 LOG_LEVEL = GetResourceMetadata(GetCurrentResourceName(), "log_level", 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
 ---@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
@ -25,33 +23,31 @@ local function Log(message, logLevel)
  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")
 AddEventHandler(RESOURCE_CODE..":UpdateLogLevel", function(num)
  LOG_LEVEL = num
 end)
--Global Variables
-
--LOCAL VARIABLES
-
-
--END CONFIG
-----------------------------------------------------------------------------------------------
+------------------------------------------------------------------------------------------------
+--CONSTANTS--



-------------------
--YOUR CODE HERE---
--HAPPY CODING!----
-------------------
+--VARIABLES--



+--FUNCTIONS--
+
+
+
+--THREADS--
+
+
+
+--NET EVENTS--
+
+
+
+--COMMANDS--
+
+