CConCommandSystem - Revision history

Outerbeast at 14:35, 7 April 2025

2025-04-07T14:35:32Z

← Older revision		Revision as of 16:35, 7 April 2025
Line 1:		Line 1:
	The Angelscript API provides a means to create custom console commands and variables, as well as client commands.		The Angelscript API provides a means to create custom console commands and variables, as well as client commands.

			A single global instance exists:<code>CConCommandSystem g_ConCommandSystem</code>

	The CConCommandSystem class only contains two methods:		The CConCommandSystem class only contains two methods:

Outerbeast at 19:59, 29 March 2025

2025-03-29T19:59:10Z

← Older revision		Revision as of 21:59, 29 March 2025
Line 21:		Line 21:
	Server commands can only be used by the host and/or through [https://developer.valvesoftware.com/wiki/Source_RCON_Protocol rcon]. Client commands can be executed by any connected client.		Server commands can only be used by the host and/or through [https://developer.valvesoftware.com/wiki/Source_RCON_Protocol rcon]. Client commands can be executed by any connected client.

	=== Classes ===		== Classes ==
	The following classes are part of the command system API:		The following classes are part of the command system API:

Line 45:		Line 45:
	\|}		\|}

			== Usage ==
	=== Creating custom commands ===		=== Creating custom commands ===
	Creating a custom command is relatively simple. All you have to do is create a global instance of the command kind you want to create and specify its name and other parameters.		Creating a custom command is relatively simple. All you have to do is create a global instance of the command kind you want to create and specify its name and other parameters.

Outerbeast at 19:58, 29 March 2025

2025-03-29T19:58:07Z

@@ Line 14: / Line 14: @@
 | style="vertical-align:middle;" | Executes an Angelscript server command.
 |}
+<hr/>
 There are 3 kinds of commands:
 * Server command
 * Server variable
 * Client command
 Server commands can only be used by the host and/or through [https://developer.valvesoftware.com/wiki/Source_RCON_Protocol rcon]. Client commands can be executed by any connected client.
 === Classes ===
@@ Line 109: / Line 89: @@
 Syntax: as_findcommands <substring>: Finds all commands that match the given substring.
 [[Category:Scripting]]

Outerbeast at 19:56, 29 March 2025

2025-03-29T19:56:33Z

← Older revision		Revision as of 21:56, 29 March 2025
Line 108:		Line 108:

	Syntax: as_findcommands <substring>: Finds all commands that match the given substring.		Syntax: as_findcommands <substring>: Finds all commands that match the given substring.

			[[Category:Scripting]]

Outerbeast: /* Classes */

2025-03-29T19:56:11Z

Classes

← Older revision		Revision as of 21:56, 29 March 2025
Line 57:		Line 57:
	\| [[CConCommand]]		\| [[CConCommand]]
	\| style="vertical-align:middle;" \| Represents a server command.		\| style="vertical-align:middle;" \| Represents a server command.
			\|-
			\| [[CClientCommand]]
			\| style="vertical-align:middle;" \| Represents a client command.
	\|-		\|-
	\| [[CCVar]]		\| [[CCVar]]
	\| Represents a server variable.		\| Represents a server variable.
	\|-
	~~\| [[CClientCommand]]~~
	~~\| style="vertical-align:middle;" \| Represents a client command.~~
	\|}		\|}

Outerbeast at 19:52, 29 March 2025

2025-03-29T19:52:54Z

← Older revision		Revision as of 21:52, 29 March 2025
Line 1:		Line 1:
	The Angelscript API provides a means to create custom console commands and variables, as well as client commands.		The Angelscript API provides a means to create custom console commands and variables, as well as client commands.

			The CConCommandSystem class only contains two methods:

			{\| class="wikitable"
			\|- style="font-weight:bold; text-align:center; vertical-align:middle;"
			! Declaration
			! Description
			\|-
			\| <code>CBasePlayer@ GetCurrentPlayer() const
			\| style="vertical-align:middle;" \| If the current command was executed by a player, this returns that player.
			\|-
			\| <code>void ServerCommand(const string& in szCommand)
			\| style="vertical-align:middle;" \| Executes an Angelscript server command.
			\|}

	=== Command kinds ===		=== Command kinds ===

Outerbeast: /* Creating custom commands */

2025-03-29T19:49:41Z

Creating custom commands

← Older revision		Revision as of 21:49, 29 March 2025
Line 55:		Line 55:

	For example, to create a new server command named "mycommand":		For example, to create a new server command named "mycommand":
	</pre>
			<pre>
	CConCommand mycommand( "mycommand", "this is my command", @MyCommandFunc );		CConCommand mycommand( "mycommand", "this is my command", @MyCommandFunc );

Outerbeast: Created page with "The Angelscript API provides a means to create custom console commands and variables, as well as client commands. === Command kinds === There are 3 kinds of commands: * Serv..."

2025-03-29T19:49:22Z

Created page with "The Angelscript API provides a means to create custom console commands and variables, as well as client commands. === Command kinds === There are 3 kinds of commands: * Serv..."

New page

The Angelscript API provides a means to create custom console commands and variables, as well as client commands.

=== Command kinds ===
There are 3 kinds of commands:

* Server command
* Server variable
* Client command
Server commands can only be used by the host and/or through [https://developer.valvesoftware.com/wiki/Source_RCON_Protocol rcon]. Client commands can be executed by any connected client.

=== Flags ===
Commands can have a number of flags set on them:

{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Flag
! Description
|-
| ConCommandFlag::None
| Constant used to indicate the absence of flags.
|-
| ConCommandFlag::AdminOnly
| If set, the invoking player (if any) must have admin access.
|-
| ConCommandFlag::Cheat
| If set, the invoking player (if any) must have cheat access.
|}

=== Classes ===
The following classes are part of the command system API:

{| class="wikitable"
|- style="font-weight:bold; text-align:center; vertical-align:middle;"
! Class
! Description
|-
| [[CConCommandSystem]]
| style="vertical-align:middle;" | Represents the console command system as a whole.
|-
| [[CCommand]]
| style="vertical-align:middle;" | Contains the arguments that were given for this command, including the command name itself.
|-
| [[CConCommand]]
| style="vertical-align:middle;" | Represents a server command.
|-
| [[CCVar]]
| Represents a server variable.
|-
| [[CClientCommand]]
| style="vertical-align:middle;" | Represents a client command.
|}

=== Creating custom commands ===
Creating a custom command is relatively simple. All you have to do is create a global instance of the command kind you want to create and specify its name and other parameters.

For example, to create a new server command named "mycommand":
</pre>
CConCommand mycommand( "mycommand", "this is my command", @MyCommandFunc );

void MyCommandFunc( const CCommand@ pArgs )
{
g_Game.AlertMessage( at_console, "Hello world!\n" );
}
</pre>

=== Using custom commands ===
All custom commands created in plugins have a dot '.' prepended to their name to prevent name conflicts, and to prevent built-in commands added in the future from conflicting. Map scripts do not have this limitation.

Plugins also have a concept of namespaces: a server operator can specify a console command namespace to put all commands into their own namespace, which helps prevent conflicts between plugins. The namespace is prepended to the name, in front of the dot.
See the Plugin list file documentation for more information.

To use a custom server command, you will have to use the as_command console command to forward it to Angelscript. This is an engine limitation.

For example:

as_command .mycommand
If you are using rcon, you will have to specify as_command as well:

rcon as_command .mycommand
Client commands do not have this limitation, and can be executed by using their name on their own, but still including the namespace and dot.

=== Console commands ===
In addition to as_command, there are a few other console commands that pertain to Angelscript's console command system:

as_commandstats
This command displays console command statistics to the server console. This currently only covers the number of commands.

as_removeallcommands
Removes all commands from the system. This is used to purge commands if a plugin or map script breaks anything. Only admins can use this.

as_findcommands
This command will find any commands that are registered by any scripts.

Syntax: as_findcommands <substring>: Finds all commands that match the given substring.