##master-page:CommandTemplate
##master-date:2017-08-17
##master-revision:3
#format wiki
#language en
{{{#!wiki caution
'''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 [[Commands/Globals/PagePlusPlus|page]] command.''-~
||||<rowbgcolor="&quot" rowstyle="&quot; &amp; quot;  &amp; amp;  quot;   &amp; amp;  amp;   quot;    &amp; amp;  amp;   quot;   &amp; amp;  quot;   ;  #CCCCCC&amp; amp;  quot&amp; quot;  ; &amp; amp; quot&amp; quot&quot; ;&amp;quot&quot"style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">'''Command Information''' ||
||''Keyword'' ||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{ @reg }}} ||
||''Type'' ||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{ BuiltIn }}} ||
||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:left&amp; amp;  quot;  &amp; quot; &quot;" |3>''Arguments'' ||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{ #help }}} ||
||||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">                        ||
||||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{ <ARGUMENT_N}}} ||
||''Aliases'' ||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{@register}}} ||
||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:left&amp; amp;  quot;  &amp; quot; &quot;" |3>''Usage'' ||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{ <USAGE_1> }}} ||
||||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{ ... }}} ||
||||<style="&quot; &amp; quot;  &amp; amp;  quot;text-align:center&amp; amp;  quot;  &amp; quot; &quot;">{{{ <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:

 .
 ''{{{ <COMMAND> <PARAMETERS_1> }}}''


To describe more than one syntax:

 .
 ''{{{ page <COMMAND> <ARGUMENTS_N> }}}''


=== Parameters ===
''{{{<ARGUMENT_1>}}}''

 . A description of the first argument of the command.

''{{{<ARGUMENT_N>}}}''

 . A description of the Nth argument of the command.

=== Examples ===
__Example 1__

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

 .
 {{{ <COMMAND> <EXAMPLE_ARGUMENTS_1> }}}


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

 .
 {{{ <EXEC_USER_OUTPUT_DESC> }}}


Then explain what other users might see, if anything:

 .
 {{{ <OTHER_USER_OUTPUT_DESC> }}}


__Example N__

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

 .
 {{{ <COMMAND> <EXAMPLE_ARGUMENTS_N> }}}


And keep writing user example output:

 .
 {{{ <EXEC_USER_OUTPUT_DESC> }}}


And More Output:

 .
 {{{ <OTHER_USER_OUTPUT_DESC> }}}


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

=== Related ===
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:

[[Commands/BuiltIn|List of SpinDizzy MUCK System Built-In and Local Commands]] [[Commands/Globals|List of SpinDizzy MUCK System Global Commands]]

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

 .
 CategoryBuiltincmd - for Built-In Commands

 .
 CategoryGlobalcmd - for Global Commands


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

 .
 CategoryBasiccmd

 .
 CategoryBuildingcmd

 .
 CategoryProgrammingcmd

 .
 CategoryWizardcmd


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

 .
 CategoryNecessitiesgcmd

 .
 CategoryInfogcmd

 .
 CategoryMovementgcmd

 .
 CategoryCommgcmd

 .
 CategoryBuildinggcmd

 .
 CateoryObjgcmd

 .
 CategoryMiscgcmd

 .
 CategoryFindpeoplegcmd