GetCommandHandlers - Revision history

Myonlake at 09:53, 7 January 2019

2019-01-07T09:53:18Z

← Older revision		Revision as of 09:53, 7 January 2019
Line 1:		Line 1:
	{{~~Server~~ function}}		{{Shared function}}
	__NOTOC__		__NOTOC__
	{{New items\|3.0153\|1.5.3\|		{{New items\|3.0153\|1.5.3\|
	This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).		This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).
	}}		}}
			{{New feature/item\|3.0157\|1.5.6\|16256\|Function also added client-side.}}

	==Syntax==		==Syntax==

Myonlake: /* Example */

2018-08-07T17:40:47Z

Example

← Older revision		Revision as of 17:40, 7 August 2018
Line 18:		Line 18:

	==Example==		==Example==
	~~<section class="server" name="Server" show="true">~~
	This example add a command to output list of all commands in the chat.		This example add a command to output list of all commands in the chat.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 50:		Line 49:
	)		)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	~~<section class="server" name="Server" show="true">~~
	This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]		This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 67:		Line 64:
	)		)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==
	{{Server functions}}		{{Server functions}}

Walid at 20:12, 9 October 2016

2016-10-09T20:12:13Z

← Older revision		Revision as of 20:12, 9 October 2016
Line 6:		Line 6:

	==Syntax==		==Syntax==
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getCommandHandlers ( [ resource theResource ] )		table getCommandHandlers ( [ resource theResource ] )
	</syntaxhighlight>		</syntaxhighlight>

	==Optional Arguments==		===Optional Arguments===
			{{OptionalArg}}
	*'''theResource:''' The resource from which you wish to retrieve all command handlers. Or leave it empty to retrieve command handlers of all resources.		*'''theResource:''' The resource from which you wish to retrieve all command handlers. Or leave it empty to retrieve command handlers of all resources.
	~~</section>~~

	===Returns===		===Returns===
Line 23:		Line 22:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler( "commands",		addCommandHandler( "commands",
	function(player)		function(player)
	local commandsList = {} --table to store commands		local commandsList = {} --table to store commands

	--store/sort commands in the table where key is resource and value is table with commands		--store/sort commands in the table where key is resource and value is table with commands
	for _, subtable in pairs( getCommandHandlers() ) do		for _, subtable in pairs( getCommandHandlers() ) do
	local commandName = subtable[1]		local commandName = subtable[1]
	local theResource = subtable[2]		local theResource = subtable[2]

	if not commandsList[theResource] then		if not commandsList[theResource] then
	commandsList[theResource] = {}		commandsList[theResource] = {}
	end		end

	table.insert( commandsList[theResource], commandName )		table.insert( commandsList[theResource], commandName )
	end		end

	--output sorted information in the chat		--output sorted information in the chat
	for theResource, commands in pairs( commandsList ) do		for theResource, commands in pairs( commandsList ) do
	local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name		local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name
	outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )		outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )

	--output list of commands		--output list of commands
	for _, command in pairs( commands ) do		for _, command in pairs( commands ) do
	outputChatBox( "/"..command, player, 255, 255, 255 )		outputChatBox( "/"..command, player, 255, 255, 255 )
	end		end
	end		end
	end		end
	)		)
	</syntaxhighlight>		</syntaxhighlight>
Line 56:		Line 55:
	This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]		This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler( "commands",		addCommandHandler("commands",
	function( player, _, resourceName )		function( player, _, resourceName)
	~~if not resourceName then~~		local theResource = (resourceName and getResourceFromName(resourceName)) or resource
	~~resourceName = ""~~		outputChatBox( "* Commands from "..getResourceName(theResource).." resource", player, 0, 255, 0 )
	~~end~~

	local theResource = getResourceFromName( resourceName )

	~~if not theResource then~~
	~~outputChatBox( "Can't find~~ resource ~~with name \"" .. resourceName .. "\".", player, 255, 0, 0 )~~
	~~return false~~
	~~end~~

	outputChatBox( "== Commands from \""..~~resourceName~~.. "\" resource ==", player, 0, 255, 0 )

	local commands = getCommandHandlers( theResource )		local commands = getCommandHandlers( theResource )
	for _, command in pairs( commands ) do		for _, command in pairs( commands ) do
	outputChatBox( "/"..command, player, 255, 255, 255 )		outputChatBox( "/"..command, player, 255, 255, 255 )
	end		end
	end		end
	)		)
	</syntaxhighlight>		</syntaxhighlight>

AleksCore at 16:56, 9 October 2016

2016-10-09T16:56:55Z

← Older revision		Revision as of 16:56, 9 October 2016
Line 1:		Line 1:
	{{Server function}}		{{Server function}}
	__NOTOC__		__NOTOC__
			{{New items\|3.0153\|1.5.3\|
	This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).		This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).
			}}

	==Syntax==		==Syntax==

Zneext: /* Syntax */

2016-10-09T14:54:07Z

Syntax

← Older revision		Revision as of 14:54, 9 October 2016
Line 6:		Line 6:
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table ~~getElementsByType~~ ( [ resource theResource ] )		table getCommandHandlers ( [ resource theResource ] )
	</syntaxhighlight>		</syntaxhighlight>

AleksCore: /* Returns */

2016-10-09T14:16:47Z

Returns

← Older revision		Revision as of 14:16, 9 October 2016
Line 14:		Line 14:

	===Returns===		===Returns===
	Returns a ''table'' containing all the commands of the given resource or a table with subtables containing the command and theResource pointer ( { "command", theResource } )		Returns a ''table'' containing all the commands of the given resource or a table with subtables containing the command and theResource pointer ( { "command", theResource } ). See examples below if you don't understand it.

	==Example==		==Example==

AleksCore: /* Example */

2016-10-09T14:12:56Z

Example

@@ Line 18: / Line 18: @@
 ==Example==
 <section class="server" name="Server" show="true">
-This simple example add a command to output list of all commands in the chat.
+This example add a command to output list of all commands in the chat.
 <syntaxhighlight lang="lua">
 addCommandHandler( "commands",
@@ Line 45: / Line 45: @@
 				outputChatBox( "/"..command, player, 255, 255, 255 )
 			end
 		end
 	end

AleksCore: /* Example */

2016-10-09T13:57:32Z

Example

← Older revision		Revision as of 13:57, 9 October 2016
Line 20:		Line 20:
	This simple example add a command to output list of all commands in the chat.		This simple example add a command to output list of all commands in the chat.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler("commands",		addCommandHandler( "commands",
	function()		function(player)
	local commandsList = {}		local commandsList = {} --table to store commands

			--store/sort commands in the table where key is resource and value is table with commands
	for _, subtable in pairs( getCommandHandlers() ) do		for _, subtable in pairs( getCommandHandlers() ) do
	local commandName = subtable[1]		local commandName = subtable[1]
Line 32:		Line 33:
	end		end

	table.insert(commandsList[theResource], commandName)		table.insert( commandsList[theResource], commandName )
	end		end

	for theResource, commands in pairs(commandsList) do		--output sorted information in the chat
	local resourceName = getResourceInfo(theResource, "name") or getResourceName(theResource)		for theResource, commands in pairs( commandsList ) do
			local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name
			outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )

	~~outputChatBox("== "..resourceName.. " ==")~~		--output list of commands
			for _, command in pairs( commands ) do
	for _, command in pairs(commands) do		outputChatBox( "/"..command, player, 255, 255, 255 )
	outputChatBox("/"..command)
	end		end

	end		end
	end		end

AleksCore: /* Example */

2016-10-09T13:33:38Z

Example

← Older revision		Revision as of 13:33, 9 October 2016
Line 26:		Line 26:
	for _, subtable in pairs( getCommandHandlers() ) do		for _, subtable in pairs( getCommandHandlers() ) do
	local commandName = subtable[1]		local commandName = subtable[1]
	local ~~res~~ = subtable[2]		local theResource = subtable[2]

	if not commandsList[~~res~~] then		if not commandsList[theResource] then
	commandsList[~~res~~] = {}		commandsList[theResource] = {}
	end		end

	table.insert(commandsList[~~res~~], commandName)		table.insert(commandsList[theResource], commandName)
	end		end

	for ~~res~~, commands in pairs(commandsList) do		for theResource, commands in pairs(commandsList) do
	local resourceName = getResourceInfo(~~res~~, "name") or getResourceName(~~res~~)		local resourceName = getResourceInfo(theResource, "name") or getResourceName(theResource)

	outputChatBox("== "..resourceName.. " ==")		outputChatBox("== "..resourceName.. " ==")

AleksCore: /* Example */

2016-10-09T13:32:33Z

Example

← Older revision		Revision as of 13:32, 9 October 2016
Line 36:		Line 36:

	for res, commands in pairs(commandsList) do		for res, commands in pairs(commandsList) do
	local ~~resName~~ = ~~getresInfo~~(res, "name") or ~~getresName~~(res)		local resourceName = getResourceInfo(res, "name") or getResourceName(res)

	outputChatBox("== "..~~resName~~.. " ==")		outputChatBox("== "..resourceName.. " ==")

	for _, command in pairs(commands) do		for _, command in pairs(commands) do