Difference between revisions of "ScriptHook: Console Commands"

From Nomad DB
 
Line 11: Line 11:
 
local my_cmd = ScriptHook.RegisterCommand("my_cmd", my_callback)
 
local my_cmd = ScriptHook.RegisterCommand("my_cmd", my_callback)
 
my_cmd:AddArgument("arg1", true, CommandArgumentType.Any)
 
my_cmd:AddArgument("arg1", true, CommandArgumentType.Any)
 +
my_cmd:SetDescription("This is my_cmd help text.")
 +
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Latest revision as of 22:04, 6 October 2020

The ScriptHook Console can be extended by custom commands from Scripts. A full example for a custom command can be found here.

Short Example

The following snippet will register the console command my_cmd <arg1>.

local function my_callback(arg1)
	print("Hello from my_cmd")
	print("arg1: ", arg1)
end

local my_cmd = ScriptHook.RegisterCommand("my_cmd", my_callback)
my_cmd:AddArgument("arg1", true, CommandArgumentType.Any)
my_cmd:SetDescription("This is my_cmd help text.")

Related Pages