1 of 3

Miscellaneous

Miscellaneous functions useful for debugging and getting special objects and info.

Debug functions

print()

Prints one or more objects to the CET Console and CET Console Logs file. Multiple objects will be printed separated by a space.

Definition

print(obj: object, [obj2: object, [...]]) -> nil

Usage example

init.lua

print('Hey', 'there', 1, 2, true)

> Hey there 1 2 true

spdlog

Write a string in the Individual Mod Logs file, eg, <>/mods/my_mod/my_mod.log.

There are several spdlog methods, all are identical and have the same output:

spdlog.debug()
spdlog.trace()
spdlog.info()
spdlog.warning()
spdlog.error()
spdlog.critical()

Definition

spdlog.info(string: string) -> nil

Usage example

init.lua

spdlog.info('Custom log')

my_mod.log

> [02:31:08] Cutom log

Usage tips

It is recommended to use spdlog.info(tostring(my_var)) to make sure the variable is compatible, as boolean, interger and other types will throw an error.

Dump()

Returns a JSON-ish string with details about the members of obj:

Type name
Instance functions
Static functions
Properties

The listed functions include their signatures.

If detailed is true, function descriptions will include the function's full name hash, short name, and short name hash.

obj must be an instance of a wrapped game type, such as PlayerPuppet which is returned by Game.GetPlayer(). DumpAllTypeNames() will dump the names of all such types.

Definition

Dump(obj: GameDataType, detailed: bool) -> string

Usage example

init.lua

print(Dump(Game.GetPlayer(), false))

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

GameDump()

Returns the game's internal debug string for the given object. This string displays the object's properties and their values.

Beware that this string probably won't have any line breaks, so it's more advisable to open <>/scripting.log in a text editor with line wrapping to view the output of this function.

Definition

GameDump(obj: GameDataType) -> string

Usage example

init.lua

print(GameDump(Game.GetPlayer()))

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

DumpType()

Like Dump(), but takes a type name rather than an object instance. Use DumpAllTypeNames() to get a list of all types.

Definition

DumpType(typeName: string, detailed: boolean) -> string

Usage example

init.lua

print(DumpType('PlayerPuppet', false))

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

DumpAllTypeNames()

Dump all type names to <>/cyber_engine_tweaks.log and prints to the CET Console the number of types dumped.

Definition

DumpAllTypeNames() -> nil

Usage example

init.lua

DumpAllTypeNames()

> Dumped 26811 types

<cyber_engine_tweaks.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
...

Getters functions

GetDisplayResolution()

Returns the width and height (respectively) of the game window in pixels.

Definition

GetDisplayResolution() -> float, float

Usage example

init.lua

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

> 1920 1080

GetMod()

Returns the return value of the mod with the given name.

If you don't return anything in your init.lua file, this function will return nil. This will often look like return MyMod:new() at the end of your file. See the Lua documentation for info about how classes can be implemented in Lua.

Definition

GetMod(modName: string) -> object

Usage example

init.lua

mod = GetMod('MyMod')

returns

-- any data returned by the mod

GetSingleton()

Returns the singleton for the given type name if it exists, otherwisenil.

A singleton is the sole instance of a type, often used for global operations.

Definition

GetSingleton(singletonTypeName: string) -> SingletonReference | nil

Usage example

init.lua

gameTime = GetSingleton("gameTimeSystem")

-- get time
gameTime:GetGameTime()

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

returns

GameTime[ seconds:734466 ]

GetVersion()

Returns the current CET build's commit hash.

Definition

GetVersion() -> string

Usage example

init.lua

version = GetVersion()

print(version)

> v1.27.1

ModArchiveExists()

Returns whether the specified .archive file is present in the archive/pc/mod folder

Definition

ModArchiveExists(archiveName: string) -> bool

Usage example

init.lua

print(ModArchiveExists('myModFiles.archive'))

> true

Detect a Redscript mod

This technique can be used to detect whether your Redscript mod is present, from CET side. It can be useful if you are writing a mod with both languages for some reason.

You can declare a static method without a body. It will do nothing:

// Redscript side
public static func IsDetected_NameOfYourMod() -> Void {}

You can now test whether this method is defined from CET side using this:

-- CET side
function IsRedscriptDetected()
  return Game["IsDetected_NameOfYourMod"] ~= nil
end

You can call IsRedscriptDetected() and it will return true when your Redscript method is detected (meaning your Redscript mod is loaded) or false otherwise.

Don't forget to change NameOfYourMod in both cases.

Getters functions

GetDisplayResolution()

Returns the width and height (respectively) of the game window in pixels.

Definition

GetDisplayResolution() -> float, float

Usage example

init.lua

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

> 1920 1080

GetMod()

Returns the return value of the mod with the given name.

Definition

GetMod(modName: string) -> object

Usage example

init.lua

mod = GetMod('MyMod')

returns

-- any data returned by the mod

GetSingleton()

Returns the singleton for the given type name if it exists, otherwisenil.

A singleton is the sole instance of a type, often used for global operations.

Definition

GetSingleton(singletonTypeName: string) -> SingletonReference | nil

Usage example

init.lua

gameTime = GetSingleton("gameTimeSystem")

-- get time
gameTime:GetGameTime()

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

returns

GameTime[ seconds:734466 ]

GetVersion()

Returns the current CET build's commit hash.

Definition

GetVersion() -> string

Usage example

init.lua

version = GetVersion()

print(version)

> v1.27.1

ModArchiveExists()

Returns whether the specified .archive file is present in the archive/pc/mod folder

Definition

ModArchiveExists(archiveName: string) -> bool

Usage example

init.lua

print(ModArchiveExists('myModFiles.archive'))

> true

Detect a Redscript mod

This technique can be used to detect whether your Redscript mod is present, from CET side. It can be useful if you are writing a mod with both languages for some reason.

You can declare a static method without a body. It will do nothing:

// Redscript side
public static func IsDetected_NameOfYourMod() -> Void {}

You can now test whether this method is defined from CET side using this:

-- CET side
function IsRedscriptDetected()
  return Game["IsDetected_NameOfYourMod"] ~= nil
end

You can call IsRedscriptDetected() and it will return true when your Redscript method is detected (meaning your Redscript mod is loaded) or false otherwise.

Don't forget to change NameOfYourMod in both cases.

Debug functions

print()

Prints one or more objects to the CET Console and CET Console Logs file. Multiple objects will be printed separated by a space.

Definition

print(obj: object, [obj2: object, [...]]) -> nil

Usage example

init.lua

print('Hey', 'there', 1, 2, true)

> Hey there 1 2 true

spdlog

Write a string in the Individual Mod Logs file, eg, <>/mods/my_mod/my_mod.log.

There are several spdlog methods, all are identical and have the same output:

spdlog.debug()
spdlog.trace()
spdlog.info()
spdlog.warning()
spdlog.error()
spdlog.critical()

Definition

spdlog.info(string: string) -> nil

Usage example

init.lua

spdlog.info('Custom log')

my_mod.log

> [02:31:08] Cutom log

Usage tips

It is recommended to use spdlog.info(tostring(my_var)) to make sure the variable is compatible, as boolean, interger and other types will throw an error.

Dump()

Returns a JSON-ish string with details about the members of obj:

Type name
Instance functions
Static functions
Properties

The listed functions include their signatures.

If detailed is true, function descriptions will include the function's full name hash, short name, and short name hash.

obj must be an instance of a wrapped game type, such as PlayerPuppet which is returned by Game.GetPlayer(). DumpAllTypeNames() will dump the names of all such types.

Definition

Dump(obj: GameDataType, detailed: bool) -> string

Usage example

init.lua

print(Dump(Game.GetPlayer(), false))

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

GameDump()

Returns the game's internal debug string for the given object. This string displays the object's properties and their values.

Beware that this string probably won't have any line breaks, so it's more advisable to open <>/scripting.log in a text editor with line wrapping to view the output of this function.

Definition

GameDump(obj: GameDataType) -> string

Usage example

init.lua

print(GameDump(Game.GetPlayer()))

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

DumpType()

Like Dump(), but takes a type name rather than an object instance. Use DumpAllTypeNames() to get a list of all types.

Definition

DumpType(typeName: string, detailed: boolean) -> string

Usage example

init.lua

print(DumpType('PlayerPuppet', false))

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

DumpAllTypeNames()

Dump all type names to <>/cyber_engine_tweaks.log and prints to the CET Console the number of types dumped.

Definition

DumpAllTypeNames() -> nil

Usage example

init.lua

DumpAllTypeNames()

> Dumped 26811 types

<cyber_engine_tweaks.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
...