AddCommand: Difference between revisions

From Onset Developer Wiki
28days (talk | contribs)
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Client & Server|1.0}}


{{FuncDescription|Adds a command that can be executed with the prefix '''/'''.}}
{{FuncDescription|Adds a command that can be executed with the prefix '''/'''.}}
Line 6: Line 6:


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|CommandName|The specified command name.}}
{{FuncParam|CommandName|The specified command name. Command names are always lower case.}}
{{FuncParam|LuaFunction|The function name.}}
{{FuncParam|LuaFunction|The function name.}}


{{FuncReturnValue|None.}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
Line 22: Line 22:


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[AddPlayerChat]]

Latest revision as of 21:29, 6 October 2020

AddCommand

Type: Function
Context: Client & Server
Introduced: v1.0

Description

Adds a command that can be executed with the prefix /.

Syntax

AddCommand(CommandName, LuaFunction)

Parameters

  • CommandName
    The specified command name. Command names are always lower case.
  • LuaFunction
    The function name.

Return Value

  • Returns true on success.

Example

function cmd_commands(playerid)
	AddPlayerChat(playerid, "You just executed a command!")
	return
end
AddCommand("commands", cmd_commands)
AddCommand("cmds", cmd_commands)

See also