Difference between revisions of "AddCommandHandler"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m (Undo revision 55800 by CrosRoad95 (talk))
 
(3 intermediate revisions by 3 users not shown)
Line 73: Line 73:
 
-- Define our function that will handle this command
 
-- Define our function that will handle this command
 
function consoleCreateMarker ( playerSource, commandName )
 
function consoleCreateMarker ( playerSource, commandName )
  -- If a player triggered it (rather than the admin) then
+
-- If a player triggered it (rather than the admin) then
  if ( playerSource ) then
+
if ( playerSource ) then
    -- Get that player's position
+
-- Get that player's position
    local x, y, z = getElementPosition ( playerSource )
+
local x, y, z = getElementPosition ( playerSource )
    -- Create a size 2, red checkpoint marker at their position
+
-- Create a size 2, red checkpoint marker at their position
    createMarker ( x, y, z, "checkpoint", 2, 255, 0, 0, 255 )
+
createMarker ( x, y, z, "checkpoint", 2, 255, 0, 0, 255 )
    -- Output it in his chat box
+
-- Output it in his chat box
    outputChatBox ( "You got a red marker", playerSource )
+
outputChatBox ( "You got a red marker", playerSource )
  end
+
end
 
end
 
end
 
-- Attach the 'consoleCreateMarker' function to the "createmarker" command
 
-- Attach the 'consoleCreateMarker' function to the "createmarker" command
Line 117: Line 117:
 
-- make the function
 
-- make the function
 
function moneyCmd(player, commandName, amount)
 
function moneyCmd(player, commandName, amount)
  if getElementData(player, "canUseMoneyFunctions") then -- the shared logic
+
    if getElementData(player, "canUseMoneyFunctions") then -- the shared logic
    if commandName == "givemoney" then
+
        if commandName == "givemoney" then
      amount  = tonumber(amount)
+
            amount  = tonumber(amount)
      if amount then
+
            if amount then
        givePlayerMoney(player, amount)
+
                givePlayerMoney(player, amount)
      else
+
            else
         outputChatBox("[usage] /givemoney [amount]", player)
+
                outputChatBox("[usage] /givemoney [amount]", player)
      end
+
            end
 +
         else if commandName == "takemoney" then
 +
            amount = tonumber(amount)
 +
            if amount then
 +
                takePlayerMoney(player, amount)
 +
            else
 +
                outputChatBox("[usage] /takemoney [amount]", player)
 +
            end
 +
        end
 
     else
 
     else
    if commandName == "takemoney" then
+
         outputChatBox("You aren't able to use this command", player)
      amount = tonumber(amount)
 
      if amount then
 
        takePlayerMoney(player, amount)
 
      else
 
         outputChatBox("[usage] /takemoney [amount]", player)
 
      end
 
 
     end
 
     end
  else
 
    outputChatBox("You aren't able to use this command", player)
 
  end
 
 
end
 
end
 
   
 
   
Line 157: Line 156:
 
==See Also==
 
==See Also==
 
{{Server functions}}
 
{{Server functions}}
 +
 +
[[hu:addCommandHandler]]

Latest revision as of 13:23, 11 August 2018

Note: It is strongly advised that you do not use the same name for your handler function as the command name, as this can lead to confusion if multiple handler functions are used. Use a name that describes your handler's purpose more specifically.

This function will attach a scripting function (handler) to a console command, so that whenever a player or administrator uses the command the function is called. Note: You cannot use "check", "list" or "test" as a command name.

Multiple command handlers can be attached to a single command, and they will be called in the order that the handlers were attached. Equally, multiple commands can be handled by a single function, and the commandName parameter used to decide the course of action.

For users, a command is in the format:

commandName argument1 argument2

This can be triggered from the player's console or directly from the chat box by prefixing the message with a forward slash (/). For server side handlers, the server admin is also able to trigger these directly from the server's console in the same way as they are triggered from a player's console.

Syntax

Click to collapse [-]
Server
bool addCommandHandler ( string commandName, function handlerFunction [, bool restricted = false, bool caseSensitive = true ] )

Required Arguments

  • commandName: This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
  • handlerFunction: This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take two parameters, playerSource and commandName, followed by as many parameters as you expect after your command (see below). These are all optional.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • restricted: Specify whether or not this command should be restricted by default. Use this on commands that should be inaccessible to everyone as default except special users specified in the ACL (Access Control List). This is to make sure admin commands such as ie. 'punish' won't be available to everyone if a server administrator forgets masking it in ACL. Make sure to add the command to your ACL under the proper group for it to be usefull (i.e <right name="command.killEveryone" access="true"></right>). This argument defaults to false if nothing is specified.
  • caseSensitive: Specifies if the command handler will ignore the case for this command name.


Click to collapse [-]
Client
bool addCommandHandler ( string commandName, function handlerFunction [, bool caseSensitive = true ] )

Required Arguments

  • commandName: This is the name of the command you wish to attach a handler to. This is what must be typed into the console to trigger the function.
  • handlerFunction: This is the function that you want the command to trigger, which has to be defined before you add the handler. This function can take commandName parameter, followed by as many parameters as you expect after your command (see below). These are all optional.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • caseSensitive: Specifies if the command handler will ignore the case for this command name.

Handler function parameters

These are the parameters for the handler function that is called when the command is used.

Click to collapse [-]
Server
player playerSource, string commandName [, string arg1, string arg2, ... ] 
  • playerSource: The player who triggered the command or the server console. If not triggered by a player (e.g. by admin) or server console, this will be false.
  • commandName: The name of the command triggered. This is useful if multiple commands go through one function.
  • arg1, arg2, ...: Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain nil. You can deal with a variable number of arguments using the vararg expression, as shown in Server Example 2 below.
Click to collapse [-]
Client
string commandName [, string arg1, string arg2, ... ] 
  • commandName: The name of the command triggered. This is useful if multiple commands go through one function.
  • arg1, arg2, ...: Each word after command name in the original command is passed here in a seperate variable. If there is no value for an argument, its variable will contain nil. You can deal with a variable number of arguments using the vararg expression, as shown in Server Example 2 below.

Returns

Returns true if the command handler was added successfully, false otherwise.

Examples

Click to collapse [-]
Server

Example 1: This example defines a command handler for the command createmarker. This will create a red marker at the position of the player player who uses it.

-- Define our function that will handle this command
function consoleCreateMarker ( playerSource, commandName )
	-- If a player triggered it (rather than the admin) then
	if ( playerSource ) then
		-- Get that player's position
		local x, y, z = getElementPosition ( playerSource )
		-- Create a size 2, red checkpoint marker at their position
		createMarker ( x, y, z, "checkpoint", 2, 255, 0, 0, 255 )
		-- Output it in his chat box
		outputChatBox ( "You got a red marker", playerSource )
	end
end
-- Attach the 'consoleCreateMarker' function to the "createmarker" command
addCommandHandler ( "createmarker", consoleCreateMarker )
Click to expand [+]
Server
Click to expand [+]
Server
Click to expand [+]
Client

See Also