Es regclientcmd

From EventScripts Community Encyclopedia

es_regclientcmd is the correct title for this article. The title you see above is incorrect due to technical limitations.

Overview

Syntax: es_regclientcmd <command> <script>/<block> "<description>"

Note: Command parameters are described inside the < and > characters. Optional parameters are contained within [ and ] characters.

Variation of this command that doesn't expand variables: es_xregclientcmd

Registers a client command that will initiate the specified block of code upon use, passing its parameters.

command - Name of the client command you want to create on the server-side console.
script - Name of the script that you want to initiate the block inside of.
block - Name of the block that you want to initiate.
description - A short description of what the command does.

block load
{
   es_regclientcmd test script/test "test command"
}
 
block test
{
   es_xmsg This command was run!
}

This will initiate the block test whenever the command test is run on a client console. So if I were to put this in my console:

test arg1 arg2 arg3

It would then message "This command was run!"

Once a command is registered, es_regclientcmd could fail on a subsequent attempt. Overwriting is currently not supported.