Restrict

Commands, functions and attributes can have their permission levels controlled in the mush config files, or by wizards from the game via @command, @function and @attribute.

In the config file, the syntax is:
restrict_command <command-name> <restriction> [" <error message>]
restrict_function <function-name> <restriction>
restrict_attribute <attribute-name> <restriction>

From the game:
@command/restrict <command-name>=<restriction> [" <error message>]
@function/restrict <function-name>=<restriction>
@attribute/access <attribute-name>=<restriction>

For commands, if <error message> is given, that message is sent to the player who runs it instead of a generic, unhelpful error message.

Command restriction rules

For commands, <restriction> should be an @lock-style boolexp (though, for backwards compatability, the restrictions below can be used, and will be converted into an @lock automatically). For functions, <restriction> should be any combination of the phrases below. For attributes, <restriction> is a list of attribute flags, or “none” to create a standard attribute with no restrictions (see attribute flags).

god        Command or function is usable only by God.<br>
wizard     Usable only by wizards.<br>
admin      Usable only by Wiz/Roy.<br>
nogagged   Usable only by non-GAGGED objects.<br>
nofixed    Usable only by non-FIXED objects.<br>
noguest    Usable only by non-guest `@powered` objects.<br>
nobody     Nothing can use it. Same as the /disable switch to `@command` or `@function`.<br>
logname    When used, log cmd/fun name, and who is using it<br>
logargs    When used, log cmd/fun name and args, and who is using it

Functions only:
noparse Function arguments are not evaluated. Only applies to @functions.
localize %q-registers are saved/restored when evaluating, as if the @function were wrapped in localize().
userfn Function can only be called from within an @function.
nosidefx Don’t allow side-effects for this function. See also the function_side_effects @config option.
deprecated This function should no longer be used. Warns the executor’s owner whenever someone uses the function.

Commands only:
noplayer Cannot be used by players.
Commands can also give any flag, power or type, to restrict to objects with one of those flags or powers, or of one of those types.

Function and command permissions

In cases where there are a function and command that do the same thing (like pemit() and @pemit), the command’s restrictions are also checked when the function is called, so to use pemit() you must also be able to use @pemit. However, a function’s restrictions are not checked when a command is called, to allow disabling side-effect functions.

Some functions (like name()) have non-side-effect and side-effect versions depending on how many arguments they’re called with. The side-effect version can be disabled while keeping the safe non-side-effect form with the ‘nosidefx’ restriction. This can also be used to disable pure side-effect functions.

Examples:

  Only allow admin to use ansi():
    > @function/restrict ansi=admin

  Don't let anyone set SUSPECT or GAGGED use @emit, and log the name of anyone who uses it.
    > @command/restrict @emit=logname
    > @command/restrict @emit=!flag^suspect&!flag^gagged

::: seealso