WD2 ScriptHook: Lua Functions

ScriptHook registers custom Lua functions to the game's scripting system. These functions extend the built-in Lua functions and Game classes and provide additional functionality.

Generic

• include

Script

• Script()
• ScriptHook.RegisterKeyHandler
• ScriptHook.RegisterCommand

UI

• UI.SimpleMenu
• ScriptHook.ShowNotification
• ScriptHook.IsIngameUIEnabled

Game Functions

Player

• ScriptHook.AddInventoryItem
• ScriptHook.Teleport
• ScriptHook.SetGraphicKitModel
• ScriptHook.SetLocalPlayerNoclip
• ScriptHook.HasLocalPlayerNoclip

Entity

• ScriptHook.SpawnEntityFromArchetypeHash
• ScriptHook.GetArchetypeHashByEntityId
• ScriptHook.GetGraphicKitModelByEntityId
• ScriptHook.SetEntityGraphicKitModel
• ScriptHook.GetAllEntities
• ScriptHook.GetEntitiesInRange
• ScriptHook.GetEntitiesWithComponent
• ScriptHook.GetEntityComponents
• ScriptHook.EntityHasComponent
• ScriptHook.GetEntityClassName

Vehicle

• ScriptHook.RepairLocalPlayerVehicle

Felony

• ScriptHook.ToggleFelonySystem
• ScriptHook.SetHeatLevel
• ScriptHook.ClearHeatLevel

Game

• ScriptHook.SetProgression
• ScriptHook.ToggleWorldSpawner
• ScriptHook.IsWorldSpawnerEnabled
• ScriptHook.ToggleWorldImpostor
• ScriptHook.IsWorldImpostorEnabled

Camera

• ScriptHook.CameraSetCustom
• ScriptHook.CameraReset
• ScriptHook.SetLocalPlayerFreeCamera
• ScriptHook.HasLocalPlayerFreeCamera

Utility

timer

• timer.Create
• timer.Simple
• timer.Get
• timer.Remove
• timer.RemoveIfExists