Difference between revisions of "ScriptHook: Script"

From Nomad DB
m (Administrator moved page WD2 ScriptHook: Script to ScriptHook: Script: MDE+WD2)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
A Script is a collection of Lua scripts that are loaded by [[WD2 ScriptHook]]. Scripts are loaded upon starting the game with ScriptHook installed.
+
A Script is a collection of Lua scripts that are loaded by ScriptHook. Scripts are loaded upon starting the game with ScriptHook installed. This guide will give you an overview of the structure behind those Scripts.
  
'''This guide will give you an overview of the structure behind those Scripts.'''
+
If you have used WD2 or MDE ScriptHook, check out the list of '''[[WDL Scripting Changes|notable ScriptHook changes for Legion]]'''.
  
 
==Guides==
 
==Guides==
  
*[[WD2 ScriptHook: Key Binds]]
+
*[[ScriptHook: Key Binds]]
*[[WD2 ScriptHook: Console Commands]]
+
*[[ScriptHook: Console Commands]]
*[[WD2 ScriptHook: Script Table]]
+
*[[ScriptHook: Script Table]]
*[[WD2 ScriptHook: UI]]
+
*[[ScriptHook: UI]]
*[[WD2 ScriptHook: Rendering]]
+
*[[ScriptHook: Rendering]]
*[[WD2 ScriptHook: Events]]
+
*[[ScriptHook: Events]]
  
 
==Directory Structure==
 
==Directory Structure==
Line 38: Line 38:
 
==Concepts==
 
==Concepts==
 
===Script Table===
 
===Script Table===
{{:WD2 ScriptHook: Script Table}}
+
or more information, check out
 
+
* [[WDL ScriptHook: Script Table|WDL Script Table]]
'''For more information, check out [[WD2 ScriptHook: Script Table]].'''
+
* [[WD2 ScriptHook: Script Table|WD2 Script Table]]
 +
* [[MDE ScriptHook: Script Table|MDE Script Table]]
  
 
===Key Bindings===
 
===Key Bindings===
 
You can bind Keys to Lua functions. Key Bindings are configured within the ''manifest.json'' section.
 
You can bind Keys to Lua functions. Key Bindings are configured within the ''manifest.json'' section.
  
'''Check out [[WD2 ScriptHook: Key Binds]].'''
+
'''Check out [[ScriptHook: Key Binds]].'''
  
 
===Console Commands===
 
===Console Commands===
 
Scripts can register custom Console Commands. These commands are registered directly within Lua.
 
Scripts can register custom Console Commands. These commands are registered directly within Lua.
  
'''Read more about [[WD2 ScriptHook: Console Commands]].'''
+
'''Read more about [[ScriptHook: Console Commands]].'''
  
 
===ScriptHook Lua Functions===
 
===ScriptHook Lua Functions===
In addition to the [[WD2 Lua Functions|built-in Lua functions]], ScriptHook registers custom Lua functions that you can use. Those functions are used for Menus, Console Commands, and some alter the Game's world.
+
In addition to the built-in Lua functions, ScriptHook registers custom Lua functions that you can use. Those functions are used for Menus, Console Commands, and some alter the Game's world.
 
 
'''You can find a [[WD2 ScriptHook: Lua Functions|list of ScriptHook Lua functions here]]'''.
 
  
 +
[[Category:ScriptHook]]
 
[[Category:WD2 ScriptHook]]
 
[[Category:WD2 ScriptHook]]
 +
[[Category:MDE ScriptHook]]

Latest revision as of 08:44, 5 May 2021

A Script is a collection of Lua scripts that are loaded by ScriptHook. Scripts are loaded upon starting the game with ScriptHook installed. This guide will give you an overview of the structure behind those Scripts.

If you have used WD2 or MDE ScriptHook, check out the list of notable ScriptHook changes for Legion.

Guides

Directory Structure

data/scripts
data/scripts/[name]
data/scripts/[name]/manifest.json
data/scripts/[name]/[...].lua

manifest.json

The manifest holds information about a Script. Name, Author & Version can be specified here. The "entrypoint" is the Lua script that is loaded. The example below shows the manifest.json for the ScriptHook Trainer.

{
	"name": "Simple Trainer",
	"author": "Nomad Group",
	"version": "1.0",
	
	"entrypoint": "main.lua",
	"keyBinds": {
		"menu": "F4"
	}
}

Concepts

Script Table

or more information, check out

Key Bindings

You can bind Keys to Lua functions. Key Bindings are configured within the manifest.json section.

Check out ScriptHook: Key Binds.

Console Commands

Scripts can register custom Console Commands. These commands are registered directly within Lua.

Read more about ScriptHook: Console Commands.

ScriptHook Lua Functions

In addition to the built-in Lua functions, ScriptHook registers custom Lua functions that you can use. Those functions are used for Menus, Console Commands, and some alter the Game's world.