Silent Creating Custom Commands - Revision history

Hellreturn: /* Example */

2016-06-04T18:50:48Z

Example

← Older revision		Revision as of 18:50, 4 June 2016
Line 37:		Line 37:
	syntax =		syntax =
	levels = 5		levels = 5

			[command]
			command = omnifix
			exec = bot kickall
			desc = To kick all bots if their are more then 5 vs 5 players playing.
			syntax =
			levels = 21

	'''Note:'''		'''Note:'''

Hellreturn at 16:04, 4 June 2016

2016-06-04T16:04:50Z

← Older revision		Revision as of 16:04, 4 June 2016
Line 30:		Line 30:
	syntax = [name]		syntax = [name]
	levels = 0 1 2 3 4 5		levels = 0 1 2 3 4 5

			[command]
			command = takess
			exec = pb_sv_getss [1]
			desc = Send pb SS of player to server. Use /pb_plist & type !takess PB slot number.
			syntax =
			levels = 5

	'''Note:'''		'''Note:'''

Gaoesa: /* Example */

2014-12-30T16:05:58Z

Example

← Older revision		Revision as of 16:05, 30 December 2014
Line 41:		Line 41:
	== Example ==		== Example ==

	For the purposes of this example, the command is mycommand. It will be executed when the ~~uses~~ enters !mycommand in the console, assuming that player has been assigned level 2 or higher shrubbot level.		For the purposes of this example, the command is mycommand. It will be executed when the user enters !mycommand to the console, assuming that player has been assigned level 2 or higher shrubbot level.

	1. Create your command in the shrubbot file. Open your shrubbot.cfg file (in silent\database directory) and add the following block:		1. Create your command in the shrubbot file. Open your shrubbot.cfg file (in silent\database directory) and add the following block:

Gaoesa: /* What Are Custom Commands */

2014-09-22T16:50:13Z

What Are Custom Commands

← Older revision		Revision as of 16:50, 22 September 2014
Line 1:		Line 1:
	= What Are Custom Commands =		= What Are Custom Commands =

	Custom commands are shrubbot like commands that are not implemented by the silEnT mod, but instead by server admins. There are three ways to create custom commands. One is to simply use the [command] blocks in the shrubbot.cfg. Second one is to combine [command] block with a Lua script that will do more complicated work than what just ~~what~~ the rcon can do. And the third method is to implement everything with Lua. The following sections describe each of these methods.		Custom commands are shrubbot like commands that are not implemented by the silEnT mod, but instead by server admins. There are three ways to create custom commands. One is to simply use the [command] blocks in the shrubbot.cfg. Second one is to combine [command] block with a Lua script that will do more complicated work than what just the rcon can do. And the third method is to implement everything with Lua. The following sections describe each of these methods.

	= Shrubbot.cfg Method =		= Shrubbot.cfg Method =

Gaoesa: /* Example */

2014-09-22T14:46:02Z

Example

← Older revision		Revision as of 14:46, 22 September 2014
Line 112:		Line 112:

	-- we're not interested if the level is too low or if the client is flooding		-- we're not interested if the level is too low or if the client is flooding
	if (level < 1) ~~and~~ (flood == 1) then		if (level < 1) or (flood == 1) then
	return 0		return 0
	end		end

Gaoesa: /* Example */

2014-09-22T14:18:26Z

Example

← Older revision		Revision as of 14:18, 22 September 2014
Line 88:		Line 88:
	<nowiki>		<nowiki>
	function SplitToArguments(line)		function SplitToArguments(line)

	local array = {}		local array = {}
	local aindex = 0		local aindex = 0

Gaoesa: /* Example */

2014-09-22T14:18:01Z

Example

← Older revision		Revision as of 14:18, 22 September 2014
Line 88:		Line 88:
	<nowiki>		<nowiki>
	function SplitToArguments(line)		function SplitToArguments(line)
	local array = {}
	local aindex = 0		local array = {}
	for i in string.gmatch(line, "%S+") do		local aindex = 0
	array[aindex] = string.lower(i)		for i in string.gmatch(line, "%S+") do
	aindex = aindex + 1		array[aindex] = string.lower(i)
	end		aindex = aindex + 1
			end
	return array
			return array
	end		end

	function CheckCommand(clientNum, arguments)		function CheckCommand(clientNum, arguments)
	if( arguments[0] == "!mycommand" ) then		if( arguments[0] == "!mycommand" ) then
	et.trap_SendServerCommand(clientNum, "chat \"Your command "..arguments[0].." has been received\"")		et.trap_SendServerCommand(clientNum, "chat \"Your command "..arguments[0].." has been received\"")
	return 1		return 1
	end		end
	return 0
			return 0
	end		end

	function et_ClientCommand(clientNum, command)		function et_ClientCommand(clientNum, command)
	local level = et.G_shrubbot_level(clientNum)		local level = et.G_shrubbot_level(clientNum)
	local flood = et.ClientIsFlooding(clientNum)		local flood = et.ClientIsFlooding(clientNum)

	-- we're not interested if the level is too low or if the client is flooding		-- we're not interested if the level is too low or if the client is flooding
	if (level < 1) and (flood == 1) then		if (level < 1) and (flood == 1) then
	return 0		return 0
	end		end

	local arg0 = string.lower(et.trap_Argv(0))		local arg0 = string.lower(et.trap_Argv(0))
	local arguments		local arguments

	-- check to see if the command was given through any of the chat methods or as sparse text from the console		-- check to see if the command was given through any of the chat methods or as sparse text from the console
	if arg0 == "say" or arg0 == "say_team" or arg0 == "say_buddy" or arg0 == "say_teamnl" then		if arg0 == "say" or arg0 == "say_team" or arg0 == "say_buddy" or arg0 == "say_teamnl" then
	arguments = SplitToArguments(et.trap_Argv(1))		arguments = SplitToArguments(et.trap_Argv(1))
	else		else
	arguments = SplitToArguments(et.ConcatArgs(0))		arguments = SplitToArguments(et.ConcatArgs(0))
	end		end

	return CheckCommand(clientNum, arguments)		-- actual command handling
	end</nowiki>		return CheckCommand(clientNum, arguments)
			end
			</nowiki>

	This example shows the same functionality as the combined example above. Do note, that if the full admin system is made manually, handling the command arguments require special care. In the above example it shows how the arguments are handled differently depending if the script is handling player chatting, or if the commands are read from sparse texts that players write to console. For safety, ConcatArgs could be used for both, just in case there are bugs in the silEnT implementation, but splitting the single argument should work equally well in all cases.		This example shows the same functionality as the combined example above. Do note, that if the full admin system is made manually, handling the command arguments require special care. In the above example it shows how the arguments are handled differently depending if the script is handling player chatting, or if the commands are read from sparse texts that players write to console. For safety, ConcatArgs could be used for both, just in case there are bugs in the silEnT implementation, but splitting the single argument should work equally well in all cases.

Gaoesa: /* Example */

2014-09-22T14:15:37Z

Example

← Older revision		Revision as of 14:15, 22 September 2014
Line 107:		Line 107:

	function et_ClientCommand(clientNum, command)		function et_ClientCommand(clientNum, command)
	local level = et.G_shrubbot_level(clientNum)		local level = et.G_shrubbot_level(clientNum)
	local flood = et.ClientIsFlooding(clientNum)		local flood = et.ClientIsFlooding(clientNum)

Gaoesa: /* Shrubbot.cfg Method */

2014-09-22T14:15:03Z

Shrubbot.cfg Method

← Older revision		Revision as of 14:15, 22 September 2014
Line 22:		Line 22:
	:*There is also the possibility to add ? to the parameter placeholders. If the question mark is added, the parameter is substituted with a player name if only one name matches the pattern. If there are no matches or there are several matches, the command will fail and reports an informative error. All placeholders can have the question mark if that is needed for the command.		:*There is also the possibility to add ? to the parameter placeholders. If the question mark is added, the parameter is substituted with a player name if only one name matches the pattern. If there are no matches or there are several matches, the command will fail and reports an informative error. All placeholders can have the question mark if that is needed for the command.

	~~'''~~Example~~:'''~~		== Example ==

	[command]		[command]

Gaoesa: /* Combining shrubbot.cfg and Lua Scripts */

2014-09-22T14:14:36Z

Combining shrubbot.cfg and Lua Scripts

← Older revision		Revision as of 14:14, 22 September 2014
Line 39:		Line 39:
	One method to extend what the commands can do, is to use a Lua script to implement the actual command operation. To do this, create a custom command to the shrubbot.cfg, which executes a command, that is not recognized by the silEnT mod. Such commands will pass through to the [[Silent Lua#et_ConsoleCommand\|et_ConsoleCommand]] Lua callback. Where it can be intercepted and proper actions can be taken. The advantage of this method is that the command privileges and the help are handled by the silEnT mod. This includes the Admin Level Protection. In other words, it is easy to ensure that the command is not used by unwanted persons.		One method to extend what the commands can do, is to use a Lua script to implement the actual command operation. To do this, create a custom command to the shrubbot.cfg, which executes a command, that is not recognized by the silEnT mod. Such commands will pass through to the [[Silent Lua#et_ConsoleCommand\|et_ConsoleCommand]] Lua callback. Where it can be intercepted and proper actions can be taken. The advantage of this method is that the command privileges and the help are handled by the silEnT mod. This includes the Admin Level Protection. In other words, it is easy to ensure that the command is not used by unwanted persons.

	~~'''~~Example~~:'''~~		== Example ==

	For the purposes of this example, the command is mycommand. It will be executed when the uses enters !mycommand in the console, assuming that player has been assigned level 2 or higher shrubbot level.		For the purposes of this example, the command is mycommand. It will be executed when the uses enters !mycommand in the console, assuming that player has been assigned level 2 or higher shrubbot level.