@flag

From TinyMUX
Jump to: navigation, search


Command: Command.gif @flag[/<switch>] <oldflag>[=<newflag>]

TinyMUX behavior

This command either removes aliases of existing flags, or renames the flag. For example, if you rename CONNECTED to BOBTHEWIZ, then whenever you reference the previous 'CONNECTED' flag, it will be seen as 'BOBTHEWIZ' instead. This does not affect the character of 'c' for the flag, only the name of it. This takes effect until the server is shutdown or rebooted. To make a permanent addition, you need to use the 'flag_name' config parameter in the conf file. The flag name must be no less than three characters, no greater than 15 characters, and can not be a previously existing flag name. If such a condition exists, it will return an error.

Switches:

    /remove - used to remove a flag's alias.

Examples

   @flag/remove con (removes alias 'con' for 'connected')
   @flag connect=bobthewiz (renames 'connected' to 'bobthewiz')
40px-Icon stickynote.gif Note: The previous naming conventions are referenced automatically as aliases for the flag unless specifically removed.

Related Topics: flag_name, Configuration, Flag

PennMUSH behavior

The @flag command manipulates the list of flags in a PennMUSH database. The PennMUSH syntax is:

 @flag <flag name>
 @flag/list [<flag name pattern>]
 @flag/add <flag name>=[<letter>], [<type(s)>], [<setperms>], [<unsetperms>]
 @flag/delete <flag name>
 @flag/alias <flag name>=<alias>
 @flag/letter <flag name>[=<letter>]
 @flag/restrict <flag name>=[<setperms>], [<unsetperms>]
 @flag/type <flag name>=<type(s)>
 @flag/enable <flag name>
 @flag/disable <flagname>

User commands

Given just a flag name, @flag displays information about the flag, including any aliases and permissions.

The @flag/list command lists all enabled flags, or those that match the optional wildcard pattern given.

Administrative commands

The remaining @flag command switches can only be used by God.

@flag/disable disables a flag, making it invisible and unusable. @flag/enable re-enables a disabled flag. @flag/delete deletes a flag completely, removing it from all objects in the database and removing the flag from the flag table.

@flag/alias adds a new alias for an existing flag. To remove an alias, use @flag/alias <flagname>=!<alias>

@flag/letter changes or removes a single-character alias for an existing flag. Single-character aliases must be unique within flags that can apply to the same type of object. A flag without a single-character alias is perfectly acceptable; such a flag must be set by name and doesn't appear in lists of flag characters.

@flag/type changes the types of objects on which the flag can be set. Types are specified as a space-separated list of room, thing, player', or exit; any may be used for flags which should apply to all types.

@flag/restrict changes the flag permissions required to set or unset the flag.

@flag/add adds a new flag with a given name, optionally specifying a single-character alias, list of object types, and flag permissions required to set or unset the flag.

Flags added with @flag/add are saved with the database when it is dumped, and do not need to be re-added at each startup. They are treated exactly as any other flag in the server.