WDL 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
• UI.SimpleTextInput
• ScriptHook.ShowNotification

Game Functions

Player

• ScriptHook.Teleport
• ScriptHook.SetLocalPlayerNoclip
• ScriptHook.HasLocalPlayerNoclip
• ScriptHook.SetNoclipSpeeds

Entity

• ScriptHook.GetAllEntities
• ScriptHook.GetEntitiesInRange
• ScriptHook.GetEntitiesWithComponent
• ScriptHook.GetEntityComponents
• ScriptHook.EntityHasComponent
• ScriptHook.GetEntityClassName

• SetEntityIsStatic
• SetEntityIsPersistent
• SetEntityPoolClearOnUnused
• SetEntityIsPoolable
• SetEntityPhysicsEnabled
• SetEntityIsVisible

Vehicle

• ScriptHook.RepairLocalPlayerVehicle

Game

• ScriptHook.SetWorldSpawnerEnabled
• ScriptHook.IsWorldSpawnerEnabled
• ScriptHook.SetWorldImpostorEnabled
• ScriptHook.IsWorldImpostorEnabled

Camera

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

Utility

timer

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