Cyber Engine Tweaks

https://wiki.redmodding.org/cyber-engine-tweaks
Admin
Cyber Engine Tweaks is a framework that allows modders to interact with the game's internal...
Tokens:60,853
Snippets:739
Trust Score:7.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Install Directory Paths

Source: https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/installing/troubleshooting.md

Illustrates the relationship between the game's install directory, the Cyber Engine Tweaks plugin path, and the final target folder.

```text
Your install directory	C:\GOG Games\Cyberpunk 2077\
Path from the guide	bin\x64\plugins\cyber_engine_tweaks
Folder you go to 	C:\GOG Games\Cyberpunk 2077\bin\x64\plugins\cyber_engine_tweaks
```

--------------------------------

### Update Usage Example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/tweakdb.md

Example showing how to update the 'player.staminaCosts.jump' TweakDB record.

```lua
success = TweakDB:Update("player.staminaCosts.jump")
```

--------------------------------

### ObserveBefore Example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/observe.md

Example demonstrating how to use ObserveBefore to hook into a method. The callback is executed just before the target method is called.

```lua
--
-- ObserveBefore()
--
-- @param  string    className  The parent class name
-- @param  string    method     The method name to target
-- @param  function  callback   The callback function
--
ObserveBefore('className', 'method', function(self [, arg1, arg2, ...])    -- method() has just been calledend)
```

--------------------------------

### Install vcrun2022 with Protontricks

Source: https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/installing/linux-proton.md

Install the vcrun2022 Windows component using Protontricks. This is a troubleshooting step if the mod is not working correctly. Be aware that this step has been reported to sometimes break game installs.

```bash
protontricks 1091500 --gui
# Then select 'Select the default wineprefix', then 'Install a Windows DLL or component'.
# Tick vcrun2022 and press Ok.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/cyber-engine-tweaks/resources/vs-code.md

To get information not explicitly on the page, make an HTTP GET request to the page URL with `ask` and optional `goal` query parameters.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/resources/vs-code.md?ask=<question>&goal=<endgoal>

```

--------------------------------

### Example Config File Structure

Source: https://wiki.redmodding.org/cyber-engine-tweaks/console/settings/config-file.md

Illustrates the nested JSON structure of the config file, showing how keys like `font.base_size` are represented.

```json5
// other lines
    "font": {
        "base_size": 16.0,
        "language": "Default",
        "oversample_horizontal": 3,
        "oversample_vertical": 1,
        "path": ""
    },
    // other lines
```

--------------------------------

### Get and Use Singleton Handle

Source: https://wiki.redmodding.org/cyber-engine-tweaks/scripting-api.md

Illustrates how to obtain a singleton handle for the gameTimeSystem and use its functions to get and set game time.

```lua
gameTime = GetSingleton("gameTimeSystem")
print(gameTime:GetGameTime())
gameTime:SetGameTimeByHMS(12,0,0) -- 12h0m0s
```

--------------------------------

### Console output example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/debug-functions.md

Demonstrates the expected output format when using the print() function with multiple arguments in the CET Console.

```text
> Hey there 1 2 true
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/files.md

Perform an HTTP GET request to query the documentation. Use the 'ask' parameter for specific questions and the optional 'goal' parameter for broader context.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/files.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Dump() output example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/debug-functions.md

Example output from the Dump() function, showing the structure of a PlayerPuppet object including its functions.

```json
{
    name: PlayerPuppet,
    functions: {
        IsPlayer() => (Bool),
        IsReplacer() => (Bool),
        IsVRReplacer() => (Bool),
        IsJohnnyReplacer() => (Bool),
        IsReplicable() => (Bool),
        GetReplicatedStateClass() => (CName),
        IsCoverModifierAdded() => (Bool),
        IsWorkspotDamageReductionAdded() => (Bool),
        IsWorkspotVisibilityReductionActive() => (Bool),
        GetOverlappedSecurityZones() => (array:gamePersistentID),
        ...
}
```

--------------------------------

### ObserveAfter Example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/observe.md

Example demonstrating how to use ObserveAfter to hook into a method. The callback is executed after the target method has fully executed.

```lua
--
-- ObserveAfter()
--
-- @param  string    className  The parent class name
-- @param  string    method     The method name to target
-- @param  function  callback   The callback function
--
ObserveAfter('className', 'method', function(self [, arg1, arg2, ...])    -- method() has been called and fully executedend)
```

--------------------------------

### GameDump() output example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/debug-functions.md

Example console output from the GameDump() function, displaying properties and values of a PlayerPuppet object.

```text
> PlayerPuppet[ customCameraTarget:ECCTV_OnlyOnscreen, renderSceneLayerMask:<Default;Cyberspace>, persistentState:, playerSocket:gamePlayerSocket[ ], ...]
```

--------------------------------

### DumpAllTypeNames() Example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/debug-functions.md

Call DumpAllTypeNames() to log all available type names to a file and get a count in the console. This is useful for discovering available types.

```lua
DumpAllTypeNames()
```

```lua
> Dumped 26811 types
```

```log
[operator ()] [4416] handle:gamedataUICharacterCreationAttribute_Record
[operator ()] [4416] DamageTypeIndicator
[operator ()] [4416] worldAIDirectorSpawnNode
[operator ()] [4416] UI_DEV_ScriptableSystemUseNewTooltips
[operator ()] [4416] array:SDocumentThumbnailWidgetPackage
[operator ()] [4416] gameIPersistencySystem
[operator ()] [4416] DelayedComDeviceClose
[operator ()] [4416] inkSettingsSelectorController
[operator ()] [4416] array:handle:AICombatSquadScriptInterface
[operator ()] [4416] animAnimNode_LocomotionAdjusterOnEvent
[operator ()] [4416] whandle:gamedataLightPreset_Record
[operator ()] [4416] handle:C4ControllerPS
...
```

--------------------------------

### SetFlatNoUpdate Usage Example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/tweakdb.md

Example demonstrating how to use TweakDB:SetFlatNoUpdate to change the player's jump stamina cost.

```lua
success = TweakDB:SetFlatNoUpdate("player.staminaCosts.jump", 7.5)
```

--------------------------------

### DumpType() Example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/debug-functions.md

Use DumpType() to get detailed information about a specific type. Set the detailed parameter to false for a less verbose output.

```lua
print(DumpType('PlayerPuppet', false))
```

```lua
{
    name: PlayerPuppet,
    functions: {
        IsPlayer() => (Bool),
        IsReplacer() => (Bool),
        IsVRReplacer() => (Bool),
        IsJohnnyReplacer() => (Bool),
        IsReplicable() => (Bool),
        GetReplicatedStateClass() => (CName),
        IsCoverModifierAdded() => (Bool),
        IsWorkspotDamageReductionAdded() => (Bool),
        IsWorkspotVisibilityReductionActive() => (Bool),
        GetOverlappedSecurityZones() => (array:gamePersistentID),
        ...
    }
}
```

--------------------------------

### Query Documentation with `ask` and `goal` Parameters

Source: https://wiki.redmodding.org/cyber-engine-tweaks/first-steps/mod-structure.md

Use this HTTP GET request to query the documentation dynamically. The `ask` parameter specifies the question, and `goal` provides optional context for tailoring the answer.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/first-steps/mod-structure.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/events/ontweak.md

Use this mechanism to ask questions about the documentation dynamically. The 'ask' parameter specifies the question, and the optional 'goal' parameter provides broader context for the desired outcome.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/events/ontweak.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### RPGManager.CreateStatModifier Example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/upgrade-guide.md

This line demonstrates code that is valid in both Lua and redscript, highlighting the API's similarity.

```lua
RPGManager.CreateStatModifier(gamedataStatType.BaseDamage, gameStatModifierType.Additive, 50)
```

--------------------------------

### Query Documentation with GET Request

Source: https://wiki.redmodding.org/cyber-engine-tweaks/base-status-effects.md

Use this endpoint to dynamically query the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter to tailor the response.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/base-status-effects.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Example Mod Log Output

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/debug.md

This is an example of how a Lua table would be represented in the mod log file after being logged with debug.log. It shows the structure and values of the table.

```log
[13:49:03] myTable: {
    ["var"] = true,
    ["enabled"] = false,
    ["subTable"] = {
        ["player"] = PlayerPuppet[ customCameraTarget:ECCTV_OnlyOnscreen, ...]
        ["stats"] = gameStatsSystem[ ],
    },
}
```

--------------------------------

### Give Money with a Hotkey

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/hotkeys/registerhotkey.md

Example of registering a hotkey to give the player 1000 in-game currency when pressed. Ensure this is placed in your `init.lua` file.

```lua
registerHotkey('give_money', 'Give Money', function()
    
    Game.AddToInventory('Items.money', 1000)
    
end)
```

--------------------------------

### Individual mod log output example

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/debug-functions.md

Shows the format of log entries written by spdlog.info() to the individual mod log file, including a timestamp.

```text
> [02:31:08] Cutom log
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/ui-examples.md

Use this endpoint to dynamically query the documentation. Include your specific question in the 'ask' parameter and optionally describe your end goal in the 'goal' parameter for tailored responses.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/ui-examples.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc.md

Demonstrates how to query the documentation dynamically using an HTTP GET request. This is useful for retrieving specific information or related documentation sections not explicitly present on the current page.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Configure Chinese Language Support

Source: https://wiki.redmodding.org/cyber-engine-tweaks/console/settings/config-file/change-font-and-font-size.md

This example demonstrates setting the `language` to `ChineseFull` and providing a path to a font file (simhei.ttf) that supports Chinese characters. This configuration is necessary for displaying traditional or simplified Chinese and Japanese.

```json
{
    // other lines
    "font": {
        "base_size": 16.0,
        "language": "ChineseFull",
        "oversample_horizontal": 3,
        "oversample_vertical": 1,
        "path": "C:/Windows/Fonts/simhei.ttf"
    },
    // other lines
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://wiki.redmodding.org/cyber-engine-tweaks/console/usage.md

Use this mechanism to query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/console/usage.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Predefined Table Data

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/tables.md

Example table structure used for demonstrating `tFlat` utility functions. Includes both associative and sequential table types.

```lua
local myTable = {
    ready = true,
    config = {
        items = {
            item1 = true,
            item2 = false
        },
        elements = {
           'element1',
           'element2'
        }
    }
}
```

--------------------------------

### Implementing Lua Callback Function

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/newproxy.md

Provides an example of a Lua callback function that receives and processes arguments, including strings, integers, and game objects.

```lua
callback = function(arg1, arg2, arg3)
  -- print("arg1: " .. arg1)
  -- print("arg2: " .. tostring(arg2))
  -- print("arg3: " .. NameToString(arg3:GetClassName()))
end
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/movement-camera.md

Use this mechanism to query the documentation dynamically when information is not explicitly present on the page. Provide a specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/movement-camera.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Continuously give money

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/hotkeys/registerinput.md

Advanced example showing how to continuously give money to the player as long as an input key is pressed, utilizing the onUpdate event.

```APIDOC
## Continuously Give Money

### Description
This example registers an input that, when held down, continuously adds money to the player's inventory. It uses a boolean flag controlled by the input's press/release state and the `onUpdate` event to check the flag.

### Method
`registerInput` and `registerForEvent` (`onUpdate`)

### Endpoint
N/A (Lua functions)

### Parameters
- **registerInput**: 
  - **slug**: 'give_continuous_money'
  - **label**: 'Give Continuous Money'
  - **callback**: A function that sets a global `keep_giving` flag based on `keypress` state.
- **onUpdate Event**: 
  - **callback**: A function that checks the `keep_giving` flag and adds money if `true`.

### Request Example
```lua
-- set initial switch state
keep_giving = false

-- register input
registerInput('give_continuous_money', 'Give Continuous Money', function(keypress)

    -- input pressed
    if keypress then
        keep_giving = true -- switch on

    -- input released
    else
        keep_giving = false -- switch off
    end

end)

-- onUpdate
-- this event is triggered continuously
registerForEvent('onUpdate', function()
    
    -- check switch state
    if keep_giving then
        Game.AddToInventory('Items.money', 20)
    end

end)
```

### Response
N/A (modifies game state)
```

--------------------------------

### Teleport to Specific Coordinates

Source: https://wiki.redmodding.org/cyber-engine-tweaks/teleportation-locations.md

This example demonstrates how to use the Teleport function with real coordinates. Ensure you have the correct Vector4 and EulerAngles parameters for successful teleportation.

```lua
// example showing necessary parameters as <?>
Game.GetTeleportationFacility():Teleport(GetPlayer(), ToVector4{x=<?>, y=<?>, z=<?>, w=1}, ToEulerAngles{roll=0, pitch=0, yaw=45})
```

```lua
// example usage with real coords
Game.GetTeleportationFacility():Teleport(GetPlayer(), ToVector4{x=-1442.981689, y=139.817459, z=141.996506, w=1}, ToEulerAngles{roll=0, pitch=0, yaw=45})
```

--------------------------------

### Registering an Override Callback

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/override.md

Example of how to register a callback function to override a specific method within a class. The callback receives the object instance, arguments, and the original method.

```lua
--
-- Override()
--
-- @param  string    className  The parent class name
-- @param  string    method     The method name to target
-- @param  function  callback   The callback function
--
Override('className', 'method', function(self [, arg1, arg2, ...], wrappedMethod)
    
    -- rewrite method()
    
end)
```

--------------------------------

### Logging a Lua Table to Mod Log

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/debug.md

This example demonstrates how to log a complex Lua table to the mod log file using the debug.log function. The output will be formatted for readability in the log.

```lua
local myTable = {
    var = true,
    enabled = false,
    subTable = {
        player = Game.GetPlayer(),
        stats = Game.GetStatsSystem()
    }
}

debug.log('myTable:', myTable)
```

--------------------------------

### Bad Example: Inline Callback Definition

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/async-waiting.md

Defines the callback function inline within the Cron.Every call, which can negatively impact performance due to repeated definition. Avoid this pattern.

```lua
Cron.Every(0.1, function()
    -- do a little dance, make a little love
end)
```

--------------------------------

### Create a Basic ImGui Window

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/ui-examples.md

Demonstrates how to set window position and size, and add basic text content. Ensure ImGui code runs within the onDraw callback.

```lua
ImGui.SetNextWindowPos(100, 500, ImGuiCond.FirstUseEver) -- set window position x, y
ImGui.SetNextWindowSize(300, 600, ImGuiCond.Appearing) -- set window size w, h

if ImGui.Begin("Unique Window Name") then
    ImGui.Text("Hello World")
    -- more window contents here
end
ImGui.End()
```

--------------------------------

### Run Protontricks GUI

Source: https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/installing/linux-proton.md

Use this command to launch the Protontricks graphical interface for managing your game's Wine prefix. This is the initial step for configuring mods.

```bash
protontricks 1091500 --gui
```

--------------------------------

### Launch Protontricks GUI

Source: https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/installing/linux-proton.md

Once you have the game's APPID, use this command to launch the Protontricks graphical interface for managing the game's Wine prefix.

```bash
$ protontricks "APPID" --gui
```

--------------------------------

### Query Documentation System

Source: https://wiki.redmodding.org/cyber-engine-tweaks/console/settings/config-file.md

Use this mechanism to ask questions about the documentation when information is not explicitly present. The `ask` parameter is for the immediate question, and the optional `goal` parameter helps tailor the answer to a broader objective.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/console/settings/config-file.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Listen for Session/Ready Event with NewProxy

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/newproxy.md

This snippet shows how to set up a listener for the 'Session/Ready' event using NewProxy. It defines a callback function that executes when the event is triggered, distinguishing between pre-game and in-game states. The listener is registered on initialization and unregistered on shutdown.

```lua
local mod = {
  listener = nil
}

-- Define our function to callback
function OnReady(event)
  local isMenu = event:IsPreGame()
  
  print("Event \"Session/Ready\" triggered!")
  if isMenu then
    print("Player is in the pre-game menu")
  else
    print("Player is in the game")
  end
end

registerForEvent('onInit', function()
  -- Create our proxy
  mod.listener = NewProxy({
    OnSessionReady = {
      -- Type is defined in the wiki of Codeware
      args = {"handle:GameSessionEvent"},
      callback = function(event) OnReady(event) end
    }
  })

  -- Register our callback to listen for event "Session/Ready".
  local callbackSystem = Game.GetCallbackSystem()
  local target = mod.listener:Target()
  local fn = mod.listener:Function("OnSessionReady")

  callbackSystem:RegisterCallback("Session/Ready", target, fn)
end)

registerForEvent('onShutdown', function()
  -- Unregister our callback before our mod is "removed".
  local target = mod.listener:Target()
  local fn = mod.listener:Function("OnSessionReady")

  callbackSystem:UnregisterCallback("Session/Ready", target, fn)
end)
```

--------------------------------

### Render ImGui Window with Overlay State

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/events/onoverlayclose.md

This advanced example demonstrates managing overlay visibility using onOverlayOpen and onOverlayClose events, and conditionally rendering an ImGui window during the onDraw event. It ensures the ImGui window only appears when the CET overlay is active.

```lua
-- set initial var
local isOverlayVisible = false

-- onOverlayOpen
registerForEvent('onOverlayOpen', function()
    isOverlayVisible = true
end)

-- onOverlayClose
registerForEvent('onOverlayClose', function()
    isOverlayVisible = false
end)

-- onDraw
-- this event is triggered continuously
registerForEvent('onDraw', function()
    
    -- bail early if overlay is not open
    if not isOverlayVisible then
        return
    end
    
    -- draw ImGui window
    if ImGui.Begin('Window Title', ImGuiWindowFlags.AlwaysAutoResize) then
        ImGui.Text('Hello World!')
    end
    
    ImGui.End()
    
end)
```

--------------------------------

### Example Lua Error Callstack

Source: https://wiki.redmodding.org/cyber-engine-tweaks/patch-notes.md

This is an example of the full callstack that will be printed to the log when a Lua error occurs from an RTTI call, as demonstrated in the previous snippet. It helps in debugging by showing the sequence of function calls leading to the error.

```log
[error] ...x64\plugins\cyber_engine_tweaks\mods\test-error\init.lua:4: Function 'FloorF' parameter 1 must be Float.
stack traceback:
    [C]: in function 'FloorF'
    ...x64\plugins\cyber_engine_tweaks\mods\test-error\init.lua:4: in function <...x64\plugins\cyber_engine_tweaks\mods\test-error\init.lua:2>
    [C]: in function 'SetTimeDilation'
    ...x64\plugins\cyber_engine_tweaks\mods\test-error\init.lua:10: in function <...x64\plugins\cyber_engine_tweaks\mods\test-error\init.lua:9>
```

--------------------------------

### Create a Modal/Popup ImGui Window

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/ui-examples.md

Shows how to open and manage a modal popup window with a button to close it. Requires the onDraw callback.

```lua
if ImGui.Button("Pop Button", 120, 0) then
      ImGui.OpenPopup("Delete?")
end

if ImGui.BeginPopupModal("Delete?", true, ImGuiWindowFlags.AlwaysAutoResize) then
    ImGui.Text("This is a popup")
    
    if ImGui.Button("Close") then ImGui.CloseCurrentPopup() end
    ImGui.EndPopup()
end
```

--------------------------------

### Registering the onInit Event

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/events/oninit.md

Use this event to register a callback function that executes once when CET has fully loaded all mods. This guarantees access to the Scripting API for your mod's initialization.

```lua
registerForEvent('onInit', function()

    print('Game is loaded')
    
end)
```

--------------------------------

### Get Folders Recursively

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/files.md

Recursively retrieves a list of all subdirectories within a given directory, up to a specified maximum depth.

```APIDOC
## Get Folders Recursively

### Description
Recursively retrieves a list of all subdirectories within a given directory, up to a specified maximum depth.

### Definition
```swift
getFoldersRecursive(path: string, maxDepth: int) -> table
```

### Parameters
#### Path Parameters
- **path** (string) - Optional - The starting path. Defaults to '.' (mod's root folder).
- **maxDepth** (integer) - Optional - The maximum depth allowed. Defaults to -1 (unlimited).

### Usage Example
```lua
local folders = getFoldersRecursive('.', 2)
```

### Response Example
```lua
folders = {
    "./includes",
    "./includes/sub-folder",
}
```
```

--------------------------------

### Get Files Recursively

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/files.md

Recursively retrieves a list of all Lua files within a directory, up to a specified maximum depth.

```APIDOC
## Get Files Recursively

### Description
Recursively retrieves a list of all Lua files within a directory, up to a specified maximum depth.

### Definition
```swift
getFilesRecursive(path: string, maxDepth: integer) -> table
```

### Parameters
#### Path Parameters
- **path** (string) - Optional - The starting path. Defaults to '.' (mod's root folder).
- **maxDepth** (integer) - Optional - The maximum depth allowed. Defaults to -1 (unlimited).

### Usage Example
```lua
local files = getFilesRecursive('.', 2)
```

### Response Example
```lua
files = {
    "./includes/module-1.lua",
    "./includes/module-2.lua",
    "./includes/sub-folder/sub-module-1.lua",
    "./init.lua",
}
```
```

--------------------------------

### Dump Type Information

Source: https://wiki.redmodding.org/cyber-engine-tweaks/scripting-api.md

Shows how to use the DumpType helper function to get information about a static type without an instance.

```lua
type = DumpType("gameItemID", false)
print(type)
```

--------------------------------

### Get Player Coordinates

Source: https://wiki.redmodding.org/cyber-engine-tweaks/console/console/how-do-i.md

Prints the player's current world coordinates to the console. Useful for debugging or noting down locations.

```lua
print(Game.GetPlayer():GetWorldPosition())
```

--------------------------------

### DumpType()

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/debug-functions.md

Dumps detailed information about a specific game type. Use DumpAllTypeNames() to get a list of available type names.

```APIDOC
## DumpType(typeName: string, detailed: boolean) -> string

### Description
Dumps detailed information about a specific game type.

### Parameters
#### Path Parameters
- **typeName** (string) - Required - The name of the type to dump.
- **detailed** (boolean) - Required - Whether to dump detailed information.

### Usage Example
```lua
print(DumpType('PlayerPuppet', false))
```

### Response Example
```json
{
    "name": "PlayerPuppet",
    "functions": {
        "IsPlayer()": "(Bool)",
        "IsReplacer()": "(Bool)",
        "IsVRReplacer()": "(Bool)",
        "IsJohnnyReplacer()": "(Bool)",
        "IsReplicable()": "(Bool)",
        "GetReplicatedStateClass()": "(CName)",
        "IsCoverModifierAdded()": "(Bool)",
        "IsWorkspotDamageReductionAdded()": "(Bool)",
        "IsWorkspotVisibilityReductionActive()": "(Bool)",
        "GetOverlappedSecurityZones()": "(array:gamePersistentID)",
        "...": "..."
    }
}
```
```

--------------------------------

### Get Mod Information

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/getters-functions.md

Retrieves the return value of a specific mod by its name. Returns nil if the mod does not return a value.

```lua
mod = GetMod('MyMod')
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/observe.md

Use this method to ask specific questions about the documentation when the answer is not explicitly present on the page. The `ask` parameter takes your question, and the optional `goal` parameter helps tailor the response to your broader objective.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/observe.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get TweakDB Record by ID

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/tweakdb.md

Retrieves a specific TweakDB record using its TweakDBID. Use this when you already have the ID of the record you need.

```swift
TweakDB:GetRecord(recordID: TweakDBID) -> TweakDBRecord
```

--------------------------------

### Get CET Version

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/getters-functions.md

Retrieves the commit hash of the current Cyber Engine Tweaks build. Useful for version checking or compatibility.

```lua
version = GetVersion()

print(version)
```

--------------------------------

### Querying Documentation with GET Request

Source: https://wiki.redmodding.org/cyber-engine-tweaks/console

Use this mechanism to ask questions about the documentation when the answer is not explicitly present on the current page. The `ask` parameter is for the immediate question, and the optional `goal` parameter describes the broader end goal.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/console.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get Singleton Instance

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/getters-functions.md

Retrieves a singleton object by its type name. Allows interaction with global systems like game time.

```lua
gameTime = GetSingleton("gameTimeSystem")

-- get time
gameTime:GetGameTime()

-- set time
gameTime:SetGameTimeByHMS(12, 0, 0) -- 12h0m0s
```

--------------------------------

### Add Item to Player Inventory

Source: https://wiki.redmodding.org/cyber-engine-tweaks/scripting-api.md

Provides an example of using the TransactionSystem to give a specific item and quantity to the player, with error checking.

```lua
player = Game.GetPlayer()
ts = Game.GetTransactionSystem()

tid = TweakDBID.new("Items.money")
itemid = ItemID.new(tid)

result = ts:GiveItem(player, itemid, 100000)
if result then
    print("We added " .. tostring(itemid) .. " to the inventory!")
else
    print("Failed to add " .. tostring(itemid))
end
```

--------------------------------

### Initializing EntityID with Constructor

Source: https://wiki.redmodding.org/cyber-engine-tweaks/upgrade-guide.md

Shows how to create and initialize an EntityID object using the new constructor with properties, simplifying the old API.

```lua
function getStash()
    local stashId = NewObject("entEntityID")
    stashId.hash = 16570246047455160070ULL

    return Game.FindEntityByID(stashId)
end
```

```lua
function getStash()
    return Game.FindEntityByID(EntityID.new({ hash = 16570246047455160070ULL }))
end
```

--------------------------------

### TweakDB Binding Functions

Source: https://wiki.redmodding.org/cyber-engine-tweaks/patch-notes.md

Provides functions for interacting with TweakDB, including getting and setting flat data, retrieving records, querying, and updating.

```lua
TweakDB:GetFlat(...)
TweakDB:SetFlat(...)
TweakDB:GetRecord(...)
TweakDB:Query(...)
TweakDB:Update(...)
```

--------------------------------

### Working with Game Enums

Source: https://wiki.redmodding.org/cyber-engine-tweaks/upgrade-guide.md

Illustrates the transition from the old Enum.new() syntax to the new direct access for game enums.

```lua
print(Enum.new('gameGameVersion', 'Current') == Enum.new('gameGameVersion', 'CP77_GoldMaster'))
print(Enum.new('gameGameVersion', 'Current') == Enum.new('gameGameVersion', 'CP77_Patch_1_2_Hotfix2'))
```

```lua
print(gameGameVersion.Current == gameGameVersion.CP77_GoldMaster)
print(gameGameVersion.Current == gameGameVersion.CP77_Patch_1_2_Hotfix2)
```

--------------------------------

### Get Value from Table

Source: https://wiki.redmodding.org/cyber-engine-tweaks/snippets-examples/utilities/tables.md

Demonstrates retrieving values from nested tables using dot notation. Handles both associative keys and sequential indices.

```lua
local item2 = tFlat.get(myTable, 'config.items.item2')
-- false

local element2 = tFlat.get(myTable, 'config.elements.2')
-- element2
```

--------------------------------

### Query Documentation with GET Request

Source: https://wiki.redmodding.org/cyber-engine-tweaks/scripting-api.md

Use this method to ask specific questions or define broader goals when information is not explicitly present on the current page. The 'ask' parameter is mandatory for the question, and 'goal' is optional for defining the end objective.

```http
GET https://wiki.redmodding.org/cyber-engine-tweaks/scripting-api.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get TweakDB Flat Value by ID

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/tweakdb.md

Retrieves a flat TweakDB value using its TweakDBID. Use this when you have the ID for the specific flat value.

```swift
TweakDB:GetFlat(flatID: TweakDBID) -> object
```

--------------------------------

### Get Display Resolution

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/misc/getters-functions.md

Retrieves the current game window's width and height in pixels. Useful for UI scaling or resolution-dependent logic.

```lua
width, height = GetDisplayResolution()
print(width, height)
```

--------------------------------

### Add Quickhack Components to Inventory

Source: https://wiki.redmodding.org/cyber-engine-tweaks/console/console/how-do-i.md

Use Game.AddToInventory with quickhack material IDs to add components to your inventory.

```lua
Game.AddToInventory("Items.QuickHackUncommonMaterial1", 1000)
Game.AddToInventory("Items.QuickHackRareMaterial1", 1000)
Game.AddToInventory("Items.QuickHackEpicMaterial1", 1000)
Game.AddToInventory("Items.QuickHackLegendaryMaterial1", 1000)
```

--------------------------------

### Check if a mod archive is installed

Source: https://wiki.redmodding.org/cyber-engine-tweaks/patch-notes.md

Use the `ModArchiveExists()` function to check if a specific mod archive is present. This is useful for ensuring dependencies are met.

```lua
if not ModArchiveExists("my_mod.archive") then
    print("This mod requires my_mod.archive to be installed")
end
```

--------------------------------

### Continuously Give Money with Input and onUpdate

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/hotkeys/registerinput.md

This advanced example uses registerInput in conjunction with the onUpdate event to continuously grant money to the player as long as a specific key is held down. It utilizes a boolean flag to manage the state.

```lua
-- set initial switch state
keep_giving = false

-- register input
registerInput('give_continuous_money', 'Give Continuous Money', function(keypress)

    -- input pressed
    if keypress then
        keep_giving = true -- switch on

    -- input released
    else
        keep_giving = false -- switch off
    end

end)

-- onUpdate
-- this event is triggered continuously
registerForEvent('onUpdate', function()
    
    -- check switch state
    if keep_giving then
        Game.AddToInventory('Items.money', 20)
    end

end)
```

--------------------------------

### Get TweakDB Record by Name

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/tweakdb.md

Retrieves a specific TweakDB record using its string name. This is useful for accessing predefined game data entries.

```swift
TweakDB:GetRecord(recordName: string) -> TweakDBRecord
```

```lua
sticky_frag = TweakDB:GetRecord("Items.GrenadeFragSticky")
```

--------------------------------

### Queuing a Task with Optional Data in Lua

Source: https://wiki.redmodding.org/cyber-engine-tweaks/patch-notes.md

Demonstrates how to queue a task using the delay system, omitting optional task data by passing nil. This is useful for tasks that do not require specific initial parameters.

```lua
-- Omit optional task data
Game.GetDelaySystem():QueueTask(this, nil, "ResolveGameplayStateTask", gameScriptTaskExecutionStage.PostPhysics)
```

--------------------------------

### Shorthand Static Method Calls

Source: https://wiki.redmodding.org/cyber-engine-tweaks/upgrade-guide.md

Demonstrates the new API for calling static methods, including shorthand for instance-based calls.

```lua
Observe("PlayerPuppet", "OnAction", function(action)
    -- Option 1 --
    print(GetSingleton("gameinputScriptListenerAction"):GetName(action))
    -- Option 2 --
    print(action:GetName(action))   
end)
```

```lua
Observe("PlayerPuppet", "OnAction", function(action)
    -- Option 1 --
    print(ListenerAction.GetName(action))
    -- Option 2 --
    print(action:GetName())   
end)
```

--------------------------------

### Create a New Proxy Listener

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/observers/newproxy.md

Define a proxy listener with specific arguments and a callback function. The 'args' should match the expected types of the game script function, and the 'callback' is the function to execute when the event is triggered.

```lua
listener = NewProxy({
  OnHit = {
    args = {"handle:GameObject", "Uint32"},
    callback = function(shooter, damage)
      print("Hit by " .. NameToString(shooter:GetClassName()) .. "!")
      print("You lost " .. tostring(damage) .. " HP.")
    end
  }
})
```

--------------------------------

### Activate slow motion effect

Source: https://wiki.redmodding.org/cyber-engine-tweaks/cet-functions/hotkeys/registerinput.md

Example demonstrating how to use registerInput to activate a slow motion effect while a key is held down, and deactivate it when the key is released.

```APIDOC
## Activate Slow Motion Effect

### Description
This example registers an input that, when pressed, applies a slow motion effect to the game. When the input is released, the effect is removed.

### Method
`registerInput`

### Endpoint
N/A (Lua function)

### Parameters
- **slug**: 'slow_motion'
- **label**: 'Slow Motion'
- **callback**: A function that takes a `keypress` boolean.

### Request Example
```lua
-- register input
registerInput('slow_motion', 'Slow Motion', function(keypress)    
    -- get time system
    local timeSystem = Game.GetTimeSystem()
    
    -- bail early if time system doesn't exists
    if not timeSystem then
        return
    end
    
    -- key is pressed
    if keypress then
        timeSystem:SetTimeDilation('MySlowMo', 0.3)
        
    -- key is released
    else
        timeSystem:UnsetTimeDilation('MySlowMo')
    end
end)
```

### Response
N/A (modifies game state)
```

--------------------------------

### Cyberpunk 2077 Directory Structure

Source: https://wiki.redmodding.org/cyber-engine-tweaks/getting-started/installing.md

This illustrates the expected file structure within the Cyberpunk 2077 game directory after Cyber Engine Tweaks has been successfully installed.

```text
Cyberpunk 2077/
├─ bin/
│  ├─ x64/
│  │  ├─ global.ini
│  │  ├─ LICENSE
│  │  ├─ version.dll
│  │  ├─ plugins/
│  │  │  ├─ cyber_engine_tweaks.asi
│  │  │  ├─ cyber_engine_tweaks/
│  │  │  │  ├─ fonts/
│  │  │  │  ├─ scripts/
│  │  │  │  ├─ tweakdb/
│  │  │  │  ├─ ThirdParty_LICENSES

```
Tokens:
Raw