Difference between revisions of "WD2 ScriptHook: Lua Functions"
From Nomad DB
SpeckBomber (talk | contribs) |
|||
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Page_WD2}} | ||
[[WD2 ScriptHook|ScriptHook]] registers custom [[Lua]] functions to the game's scripting system. These functions extend the [[WD2 Lua Functions|built-in Lua functions]] and [[WD2 Lua Classes|Game classes]] and provide additional functionality. | [[WD2 ScriptHook|ScriptHook]] registers custom [[Lua]] functions to the game's scripting system. These functions extend the [[WD2 Lua Functions|built-in Lua functions]] and [[WD2 Lua Classes|Game classes]] and provide additional functionality. | ||
| Line 14: | Line 15: | ||
*[[UI.SimpleMenu]] | *[[UI.SimpleMenu]] | ||
| + | *[[UI.SimpleTextInput]] | ||
*[[ScriptHook.ShowNotification]] | *[[ScriptHook.ShowNotification]] | ||
| + | *[[ScriptHook.IsIngameUIEnabled]] | ||
==Game Functions== | ==Game Functions== | ||
| Line 31: | Line 34: | ||
*[[ScriptHook.GetGraphicKitModelByEntityId]] | *[[ScriptHook.GetGraphicKitModelByEntityId]] | ||
*[[ScriptHook.SetEntityGraphicKitModel]] | *[[ScriptHook.SetEntityGraphicKitModel]] | ||
| + | *[[ScriptHook.GetAllEntities]] | ||
| + | *[[ScriptHook.GetEntitiesInRange]] | ||
| + | *[[ScriptHook.GetEntitiesWithComponent]] | ||
| + | *[[ScriptHook.GetEntityComponents]] | ||
| + | *[[ScriptHook.EntityHasComponent]] | ||
| + | *[[ScriptHook.GetEntityClassName]] | ||
===Vehicle=== | ===Vehicle=== | ||
| Line 45: | Line 54: | ||
*[[ScriptHook.SetProgression]] | *[[ScriptHook.SetProgression]] | ||
| + | *[[ScriptHook.ToggleWorldSpawner]] | ||
| + | *[[ScriptHook.IsWorldSpawnerEnabled]] | ||
| + | *[[ScriptHook.ToggleWorldImpostor]] | ||
| + | *[[ScriptHook.IsWorldImpostorEnabled]] | ||
| − | === Camera === | + | ===Camera=== |
| − | * [[ScriptHook.CameraSetCustom]] | + | *[[ScriptHook.CameraSetCustom]] |
| − | * [[ScriptHook.CameraReset]] | + | *[[ScriptHook.CameraReset]] |
| − | * [[ScriptHook.SetLocalPlayerFreeCamera]] | + | *[[ScriptHook.SetLocalPlayerFreeCamera]] |
*[[ScriptHook.HasLocalPlayerFreeCamera]] | *[[ScriptHook.HasLocalPlayerFreeCamera]] | ||
Latest revision as of 20:34, 27 October 2020
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.
Contents
Generic
Script
UI
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
Felony
Game
- ScriptHook.SetProgression
- ScriptHook.ToggleWorldSpawner
- ScriptHook.IsWorldSpawnerEnabled
- ScriptHook.ToggleWorldImpostor
- ScriptHook.IsWorldImpostorEnabled
Camera
- ScriptHook.CameraSetCustom
- ScriptHook.CameraReset
- ScriptHook.SetLocalPlayerFreeCamera
- ScriptHook.HasLocalPlayerFreeCamera
