Page Under Construction

This page is under construction and using the CommandTemplate. This should be removed once the page is finished.

Commands/BuiltIn/at-reg

<Optional Tag If This is a Historical Document that has functionality that has been superceded by another program> This page describes the functionality for the Built-In  <COMMAND>  command. For more information on how the extended page functionality works, look at the global page command.

Command Information

Keyword

 @reg 

Type

 BuiltIn 

Arguments

 #help 

 <ARGUMENT_N

Aliases

@register

Usage

 <USAGE_1> 

 ... 

 <USAGE_N> 

Purpose

Register an alias to a #DBREF, allowing for $alias substitution in commands such as  t $alias  and  @tel $alias  (as opposed to  t #dbref  et al), as well as interacting with objects or rooms remotely (for example,  ex $my_bedroom ).

Output of @reg #help:

Syntaxes:
  The following prefixes set what the target object and the target propdir
   are.  The default target propdir is "_reg/" and the default target
   object is #0.
      #me
          Sets target object to you, and propdir to the default "_reg/".
      #prop <targobj>:<propdir>
          Sets target object to <targobj> and propdir to <propdir>.
  The following are the command syntaxes
      @register [<prefix>]
          List all registered objects in the target propdir on target object.
      @register [<prefix>] <subpropdir>
          List all registered objects in <subpropdir> in the target propdir.
      @register [<prefix>] <object> = <name>
          Register <name> to <object> in the propdir on the target object.
Example: @register #prop here:_disconnect gen-sweeproom=cleanup
  This registers the program gen-sweeproom as 'cleanup' in the _disconnect
   propdir on the current room.

Syntax

To describe syntax functionality of a program:

To describe more than one syntax:

Parameters

<ARGUMENT_1>

<ARGUMENT_N>

Examples

Example 1

If an editor wanted to describe an example of a command, they would type the following:

They would explain what the user output was for the user executing the command, if any:

Then explain what other users might see, if anything:

Example N

If an editor wanted to continue writing examples, they could write as many as they wanted, following the general format above:

And keep writing user example output:

And More Output:

Caveats

Caveats for the command being written about should be placed here. These can be things like restrictions, special operations for wizards, &c.

NullPage - These links should point to pages inside the wiki

Parent Topic

This page should have one of the following as it's Command List Page:

List of SpinDizzy MUCK System Built-In and Local Commands List of SpinDizzy MUCK System Global Commands


Specify the category types for this page. All Command pages will have one of the following:

Built-In Commands will have one the following sub-types:

Global Commands will have one of the following sub-types:

Commands/BuiltIn/at-reg (last edited 2022-08-04 16:44:29 by fluffy)