RemoveCommandHandler: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Needs_Checking|Problems in example. [[User:Erorr404|Erorr404]]}}
{{Needs_Checking|Well, I fixed the syntax issues, but its a bad example (why remove the command for everyone?). Can't think of another one though... [[User:EAi|eAi]]}}
__NOTOC__
__NOTOC__
This function removes a command handler, that is one that has been added using addCommandHandler. This function can only remove command handlers that were added by the [[virtual machine]] that it is called in.
This function removes a command handler, that is one that has been added using addCommandHandler. This function can only remove command handlers that were added by the [[virtual machine]] that it is called in.

Revision as of 20:41, 8 October 2006

This function removes a command handler, that is one that has been added using addCommandHandler. This function can only remove command handlers that were added by the virtual machine that it is called in.

Syntax

bool removeCommandHandler ( string commandName )              

Required Arguments

  • commandName: The string of the command you wish to remove.

Returns

Returns true if the command handler was removed successfully, false if the command doesn't exist.

Example

This example adds a command handler that briefly shows the position of 'huntedPlayer', and removes the command handler when 'huntedPlayer' dies:

-- add a command that allows players to see the position of the 'huntedPlayer' for 5 seconds:
addCommandHandler ( "showhuntedblip", "consoleShowHuntedBlip" )
function consoleShowHuntedBlip ( player, commandName )
   if ( player ) then
      local x, y, z = getElementPosition ( huntedPlayer )
      local blip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, player )
      setTimer ( "destroyElement", 5000, 1, blip )
   end 
end

-- remove the command once the hunter player dies:
addEventHandler ( "onPlayerWasted", huntedPlayer, "onHuntedPlayerWasted" )
function onHuntedPlayerWasted ( ammo, killer, killerweapon, bodypart )
   removeCommandHandler ( "showhuntedblip" )
end

See Also