1 of 3

Hotkeys

Introduction

Cyber Engine Tweaks allow mods to register hotkeys that can be assigned by the player in the CET Binding screen, and execute custom code once pressed. There are two kinds of hotkeys:

Hotkeys are triggered on key release
Inputs are triggered on key press and release

Hotkeys and Inputs, while having similar functionalities, are displayed in two separated groups.

General Notes

Hotkeys are not triggered while the player stay pressed on a game's keybind.

For example, if the player move forward with "W" and press a Hotkey at the same time, it won't be triggered.

For this reason, it is recommended to use Inputs instead, as they are always triggered.

Remember to register Hotkeys/Inputs at root level, outside of any event.

Hotkeys & Inputs are displayed in the CET Bindings screen sorted in the order they were registered in the code. If you want to sort hotkeys by label in ascending order for example, you'll have to change the registration code order accordingly.

Hotkeys & Inputs can be triggered by the user from anywhere, at anytime, as soon as CET loaded your mod (even earlier than onInit event).

Which means the user might press your hotkey in the Main Game Menu or in Settings Menu. You have to keep that in mind when working with hotkeys, and make sure your script is executed where it is supposed to.

Hotkeys & Inputs are triggered on top of the game's keybinds. Which means it's possible that player set a hotkey on "R".

In-game, when the player use "R" to trigger your script, it will also trigger the game's Reload function.

Available Functions

RegisterHotkey

Hotkeys are buttons events triggered on key release. They must be registered using registerHotkey() at root level, outside of any event, in the init.lua file.

Hotkeys are not triggered while the player stay pressed on a game's keybind.

For example, if the player move forward with "W" and press a Hotkey at the same time, it won't be triggered.

For this reason, it is recommended to use Inputs instead, as they are always triggered.

Definition

registerHotkey(slug, label, callback)

--
-- registerHotkey()
--
-- @param  string    slug      The internal slug (must be unique in your mod scope)
-- @param  string    label     The label displayed in CET Bindings
-- @param  function  callback  The callback function
--
registerHotkey('slug', 'label', function()
    
    -- hotkey is released
    
end)

Usage Example

Give money with a hotkey:

init.lua

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

RegisterInput

Inputs are buttons events that handle both key press and release states. They must be registered using registerInput() at root level, outside of any event, in the init.lua file.

The button state (press/release) is defined in the first argument passed to the callback.

Definition

registerInput(slug, label, callback)

--
-- registerInput()
--
-- @param  string    slug      The internal slug (must be unique in your mod scope)
-- @param  string    label     The label displayed in CET Bindings
-- @param  function  callback  The callback function
--
registerInput('slug', 'label', function(keypress)
    
    if keypress then
        -- key is pressed
    else
        -- key is released
    end
    
end)

Alternative Usage

You can register an Input and make it behave like a Hotkey. This method is more reactive as it triggers on key press, when a Hotkey is triggered on release.

registerInput('slug', 'label', function(keypress)
    
    -- bail early on key release
    if not keypress then
        return
    end
    
    -- key is pressed
    
end)

Usage Note

It is important to check the keypress argument inside the callback. Otherwise the code will be executed twice:

One time when the key is pressed
A second time when released

registerInput('slug', 'label', function(keypress)
    
    -- this will be called 2 times!
    
end)

Usage Example

Activate slow motion effect as long as the input key is pressed:

init.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)

Advanced Example

Continuously give money as long as the input key is pressed:

This example use the onUpdate event, which is triggered continuously. Make sure to check the documentation before any modification.

init.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)

Hotkeys

Introduction

Cyber Engine Tweaks allow mods to register hotkeys that can be assigned by the player in the CET Binding screen, and execute custom code once pressed. There are two kinds of hotkeys:

Hotkeys are triggered on key release
Inputs are triggered on key press and release

Hotkeys and Inputs, while having similar functionalities, are displayed in two separated groups.

General Notes

Hotkeys are not triggered while the player stay pressed on a game's keybind.

For example, if the player move forward with "W" and press a Hotkey at the same time, it won't be triggered.

For this reason, it is recommended to use Inputs instead, as they are always triggered.

Remember to register Hotkeys/Inputs at root level, outside of any event.

Hotkeys & Inputs can be triggered by the user from anywhere, at anytime, as soon as CET loaded your mod (even earlier than onInit event).

Hotkeys & Inputs are triggered on top of the game's keybinds. Which means it's possible that player set a hotkey on "R".

In-game, when the player use "R" to trigger your script, it will also trigger the game's Reload function.

Available Functions

RegisterHotkey

RegisterInput

RegisterHotkey

Hotkeys are buttons events triggered on key release. They must be registered using registerHotkey() at root level, outside of any event, in the init.lua file.

Hotkeys are not triggered while the player stay pressed on a game's keybind.

For example, if the player move forward with "W" and press a Hotkey at the same time, it won't be triggered.

For this reason, it is recommended to use Inputs instead, as they are always triggered.

Definition

registerHotkey(slug, label, callback)

--
-- registerHotkey()
--
-- @param  string    slug      The internal slug (must be unique in your mod scope)
-- @param  string    label     The label displayed in CET Bindings
-- @param  function  callback  The callback function
--
registerHotkey('slug', 'label', function()
    
    -- hotkey is released
    
end)

Usage Example

Give money with a hotkey:

init.lua

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

RegisterInput

Inputs are buttons events that handle both key press and release states. They must be registered using registerInput() at root level, outside of any event, in the init.lua file.

The button state (press/release) is defined in the first argument passed to the callback.

Definition

registerInput(slug, label, callback)

--
-- registerInput()
--
-- @param  string    slug      The internal slug (must be unique in your mod scope)
-- @param  string    label     The label displayed in CET Bindings
-- @param  function  callback  The callback function
--
registerInput('slug', 'label', function(keypress)
    
    if keypress then
        -- key is pressed
    else
        -- key is released
    end
    
end)

Alternative Usage

You can register an Input and make it behave like a Hotkey. This method is more reactive as it triggers on key press, when a Hotkey is triggered on release.

registerInput('slug', 'label', function(keypress)
    
    -- bail early on key release
    if not keypress then
        return
    end
    
    -- key is pressed
    
end)

Usage Note

It is important to check the keypress argument inside the callback. Otherwise the code will be executed twice:

One time when the key is pressed
A second time when released

registerInput('slug', 'label', function(keypress)
    
    -- this will be called 2 times!
    
end)

Usage Example

Activate slow motion effect as long as the input key is pressed:

init.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)

Advanced Example

Continuously give money as long as the input key is pressed:

This example use the onUpdate event, which is triggered continuously. Make sure to check the documentation before any modification.

init.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)