concommand/Add

From Garry's Mod
(Difference between revisions)
Jump to: navigation, search
m (Add "view source" link)
m (Bug)
Line 1: Line 1:
 
{{Func
 
{{Func
 
|Description=Creates a console command that runs a function in lua with optional autocompletion function and help text.
 
|Description=Creates a console command that runs a function in lua with optional autocompletion function and help text.
 +
 +
{{Bug|Issue=1183|This will fail if the concommand was previously removed with {{LibraryFunction|concommand|Remove}}.}}
 
|Realm=Shared and Menu
 
|Realm=Shared and Menu
 
|IsClass=No
 
|IsClass=No

Revision as of 16:03, 2 August 2018

 concommand.Add( )

Contents

Description

Creates a console command that runs a function in lua with optional autocompletion function and help text.

BUG

This will fail if the concommand was previously removed with concommand.Remove.

Issue Tracker: #1183

Arguments

string name

The command name to be used in console.

This cannot be a name of existing console command or console variable. It will silently fail if it is.

Arguments

function callback

The function to run when the concommand is executed. Arguments passed are:

  • Player ply - The player the ran the concommand. NULL entity if command was entered with the dedicated server console.
  • string cmd - The concommand string (if one callback is used for several concommands).
  • table args - A table of all string arguments.
  • string argStr - The arguments as a string.

Arguments

function autoComplete=nil

The function to call which should return a table of options for autocompletion. (Autocompletion Tutorial)

This only properly works on the client since it is not networked. Arguments passed are:

  • string cmd - The concommand this autocompletion is for.
  • string args - The arguments typed so far.

Arguments

string helpText=nil

The text to display should a user run 'help cmdName'.

Arguments

number flags=0

Concommand modifier flags. See FCVAR_ Enums.

Examples

Example

Adds a concommand killyourself which will kill the user.

concommand.Add("killyourself",function( ply, cmd, args )
    ply:Kill()
    print("You killed yourself!")
end)


Examples

Example

A concommand that prints the SteamID and nickname of every player on the server.

concommand.Add( "retrieveplayers", function()  
	for _, ply in ipairs( player.GetAll() ) do
		print( ply:Nick() .. ", " .. ply:SteamID() .. "\n" )
	end
end)


Personal tools
Navigation