RemoveCommandHandler - Revision history

Ccw at 01:59, 9 July 2011

2011-07-09T01:59:48Z

← Older revision		Revision as of 01:59, 9 July 2011
Line 12:		Line 12:

	===Optional Arguments===		===Optional Arguments===
	*'''handler:''' the specific handler function to remove. If not specified, all handler functions for the command (from the calling resource) will be removed. ''This argument is only available in ~~1.0 and above~~.''		*'''handler:''' the specific handler function to remove. If not specified, all handler functions for the command (from the calling resource) will be removed. ''This argument is only available in the server.''

	===Returns===		===Returns===

Sebassje at 15:37, 4 April 2009

2009-04-04T15:37:17Z

← Older revision		Revision as of 15:37, 4 April 2009
Line 12:		Line 12:

	===Optional Arguments===		===Optional Arguments===
	*'''handler:''' the specific handler function to remove. If not specified, all handler functions for the command (from the calling resource) will be removed. ''This argument is only available in ~~DP3~~ and above.''		*'''handler:''' the specific handler function to remove. If not specified, all handler functions for the command (from the calling resource) will be removed. ''This argument is only available in 1.0 and above.''

	===Returns===		===Returns===
Line 36:		Line 36:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	<section name="Client" class="client" show="~~false~~">		<section name="Client" class="client" show="true">
	This example adds a command handler that briefly shows the position of 'huntedPlayer', and removes the command handler when 'huntedPlayer' dies:		This example adds a command handler that briefly shows the position of 'huntedPlayer', and removes the command handler when 'huntedPlayer' dies:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Arc at 14:17, 30 August 2008

2008-08-30T14:17:34Z

← Older revision		Revision as of 14:17, 30 August 2008
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool removeCommandHandler ( string commandName )		bool removeCommandHandler ( string commandName [, function handler] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''commandName:''' ~~The string~~ of the command you wish to remove.		*'''commandName:''' the name of the command you wish to remove.

			===Optional Arguments===
			*'''handler:''' the specific handler function to remove. If not specified, all handler functions for the command (from the calling resource) will be removed. ''This argument is only available in DP3 and above.''

	===Returns===		===Returns===

Talidan at 15:39, 30 August 2007

2007-08-30T15:39:32Z

← Older revision		Revision as of 15:39, 30 August 2007
Line 15:		Line 15:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This example adds a command handler that briefly shows the position of 'huntedPlayer', and removes the command handler when 'huntedPlayer' dies:		This example adds a command handler that briefly shows the position of 'huntedPlayer', and removes the command handler when 'huntedPlayer' dies:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- add a command that allows players to see the position of the 'huntedPlayer' for 5 seconds:		-- add a command that allows players to see the position of the 'huntedPlayer' for 5 seconds:
	function consoleShowHuntedBlip ( thePlayer, commandName )		function consoleShowHuntedBlip ( thePlayer, commandName )
	~~if ( thePlayer ) then~~		local x, y, z = getElementPosition ( huntedPlayer )
	local x, y, z = getElementPosition ( huntedPlayer )		local huntedblip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, thePlayer )
	local huntedblip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, thePlayer )		setTimer ( "destroyElement", 5000, 1, huntedblip )
	setTimer ( "destroyElement", 5000, 1, huntedblip )
	~~end~~
	end		end
	addCommandHandler ( "showhuntedblip", consoleShowHuntedBlip )		addCommandHandler ( "showhuntedblip", consoleShowHuntedBlip )
Line 33:		Line 32:
	addEventHandler ( "onPlayerWasted", huntedPlayer, onHuntedPlayerWasted )		addEventHandler ( "onPlayerWasted", huntedPlayer, onHuntedPlayerWasted )
	</syntaxhighlight>		</syntaxhighlight>
			</section>
			<section name="Client" class="client" show="false">
			This example adds a command handler that briefly shows the position of 'huntedPlayer', and removes the command handler when 'huntedPlayer' dies:
			<syntaxhighlight lang="lua">
			-- add a command that allows players to see the position of the 'huntedPlayer' for 5 seconds:
			function consoleShowHuntedBlip ( commandName )
			local x, y, z = getElementPosition ( huntedPlayer )
			local huntedblip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, thePlayer )
			setTimer ( "destroyElement", 5000, 1, huntedblip )
			end
			addCommandHandler ( "showhuntedblip", consoleShowHuntedBlip )

			-- remove the command once the hunter player dies:
			function onHuntedPlayerWasted ( killer, killerweapon, bodypart )
			removeCommandHandler ( "showhuntedblip" )
			end
			addEventHandler ( "onClientPlayerWasted", huntedPlayer, onHuntedPlayerWasted )
			</syntaxhighlight>
			</section>
	==See Also==		==See Also==
	{{Server_functions}}		{{Server_functions}}

Jbeta: VM -> resource

2007-08-23T15:15:52Z

VM -> resource

← Older revision		Revision as of 15:15, 23 August 2007
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__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 resource that it is called in.

	==Syntax==		==Syntax==

Arc at 17:58, 16 August 2007

2007-08-16T17:58:41Z

← Older revision		Revision as of 17:58, 16 August 2007
Line 21:		Line 21:
	if ( thePlayer ) then		if ( thePlayer ) then
	local x, y, z = getElementPosition ( huntedPlayer )		local x, y, z = getElementPosition ( huntedPlayer )
	local ~~blip~~ = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, thePlayer )		local huntedblip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, thePlayer )
	setTimer ( "destroyElement", 5000, 1, ~~blip~~ )		setTimer ( "destroyElement", 5000, 1, huntedblip )
	end		end
	end		end

Arc at 17:58, 16 August 2007

2007-08-16T17:58:10Z

← Older revision		Revision as of 17:58, 16 August 2007
Line 18:		Line 18:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- add a command that allows players to see the position of the 'huntedPlayer' for 5 seconds:		-- add a command that allows players to see the position of the 'huntedPlayer' for 5 seconds:
	function consoleShowHuntedBlip ( ~~player~~, commandName )		function consoleShowHuntedBlip ( thePlayer, commandName )
	if ( ~~player~~ ) then		if ( thePlayer ) then
	local x, y, z = getElementPosition ( huntedPlayer )		local x, y, z = getElementPosition ( huntedPlayer )
	local blip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, ~~player~~ )		local blip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, thePlayer )
	setTimer ( "destroyElement", 5000, 1, blip )		setTimer ( "destroyElement", 5000, 1, blip )
	end		end

Arc at 16:58, 16 August 2007

2007-08-16T16:58:41Z

← Older revision		Revision as of 16:58, 16 August 2007
Line 1:		Line 1:
			{{Server client function}}
	__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.

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

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

	==See Also==		==See Also==
	{{Server_functions}}		{{Server_functions}}

Erorr404 at 20:41, 8 October 2006

2006-10-08T20:41:36Z

← Older revision		Revision as of 20:41, 8 October 2006
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.

Erorr404 at 20:40, 8 October 2006

2006-10-08T20:40:55Z

← Older revision		Revision as of 20:40, 8 October 2006
Line 11:		Line 11:

	===Required Arguments===		===Required Arguments===
	*'''commandName:''' The string of the command you wish to remove		*'''commandName:''' The string of the command you wish to remove.

	===Returns===		===Returns===
	Returns ''true'' if the ~~operation~~ was ~~successful~~, ''false'' ~~otherwise~~.		Returns ''true'' if the command handler was removed successfully, ''false'' if the command doesn't exist.

	==Example==		==Example==
	This example ~~prevents using~~ a '~~nitro~~' ~~command if you are in a caddy~~, ~~otherwise it adds~~ the command ~~to allow you to use the nitro command.~~		This example adds a command handler that briefly shows the position of 'huntedPlayer', and removes the command handler when 'huntedPlayer' dies:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler~~ ( "~~onPlayerEnterVehicle~~"~~, root~~, "~~onPlayerEnterVehicle~~" )		-- add a command that allows players to see the position of the 'huntedPlayer' for 5 seconds:
	function ~~onPlayerEnterVehicle~~ ( ~~vehicle~~, ~~seat, jacked~~ )		addCommandHandler ( "showhuntedblip", "consoleShowHuntedBlip" )
	if ~~vehicle~~ == ~~457 then~~		function consoleShowHuntedBlip ( player, commandName )
	~~removeCommandHandler~~ ( "~~nitro~~" )		if ( player ) then
	~~else~~		local x, y, z = getElementPosition ( huntedPlayer )
	~~addCommandHandler~~ ( "~~nitro~~", "~~givenitro~~" )		local blip = createBlip ( x, y, z, 0, 2, 255, 0, 0, 255, player )
	~~end~~		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		end
	</syntaxhighlight>		</syntaxhighlight>