|
Size: 3188
Comment: CAA - Initial Commit
|
← Revision 7 as of 2017-08-21 17:41:46 ⇥
Size: 2804
Comment: CAA - Properly formatted the examples.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| ##master-date:<<DateTime(2017-08-21T04:56:13-0800)>> | ##master-date:2017-08-17 |
| Line 7: | Line 7: |
| {{{#!wiki caution '''Page Under Construction''' |
= Look = |
| Line 10: | Line 9: |
| This page is under construction and using the CommandTemplate. This should be removed once the page is finished. }}} = Commands/BuiltIn/look = ~-''<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.''-~ |
~-''This page describes the functionality for the Built-In {{{ look }}} command. For more information on how the extended look functionality works, look at the global [[Commands/Globals/LookPlusPlus|look]] command.''-~ |
| Line 18: | Line 12: |
| ||''Keyword'' ||<:>{{{ <KEYWORD> }}}|| ||''Type'' ||<:>{{{ BuiltIn | Global }}}|| ||<(|3>''Arguments'' ||<:>{{{ <ARGUMENT_1> }}}|| ||||<:>{{{ ... }}}|| ||||<:>{{{ <ARGUMENT_N}}}|| ||''Aliases''||<:>{{{<ALIASES>}}}|| ||<(|3>''Usage''||<:>{{{ <USAGE_1> }}}|| ||||<:>{{{ ... }}}|| ||||<:>{{{ <USAGE_N> }}}|| |
||''Keyword'' ||<:>{{{ look }}}|| ||''Type'' ||<:>{{{ BuiltIn }}}|| ||<(>''Arguments'' ||<:>{{{ <object> }}}|| ||''Aliases''||<:>{{{read}}}|| ||<(|2>''Usage''||<:>{{{ look }}}|| ||||<:>{{{ look <object> }}}|| |
| Line 30: | Line 21: |
| <COMMAND FUNCTION OR PURPOSE> | Look at the description for an object. |
| Line 34: | Line 25: |
| To describe syntax functionality of a program: | To look at the description for the current room you are in: |
| Line 36: | Line 27: |
| . ''{{{ <COMMAND> <PARAMETERS_1> }}}'' | . ''{{{ look }}}'' |
| Line 38: | Line 29: |
| To describe more than one syntax: | To look at the description for a specific object, including rooms, players, things, exits, actions, programs, and any other objects: |
| Line 40: | Line 31: |
| . ''{{{ page <COMMAND> <ARGUMENTS_N> }}}'' | . ''{{{ look <object> }}}'' |
| Line 44: | Line 35: |
| ''{{{<ARGUMENT_1>}}}'' | ''{{{<object>}}}'' |
| Line 46: | Line 37: |
| . A description of the first argument of the command. ''{{{<ARGUMENT_N>}}}'' . A description of the Nth argument of the command. |
. The name of a room, player, program, thing, exit, action, or other object whose description you would like to view. |
| Line 56: | Line 43: |
| If an editor wanted to describe an example of a command, they would type the following: | If a player named Morticon wanted to see what the current room looked like, they would type the following: |
| Line 58: | Line 45: |
| . {{{ <COMMAND> <EXAMPLE_ARGUMENTS_1> }}} | . {{{ look }}} |
| Line 60: | Line 47: |
| They would explain what the user output was for the user executing the command, if any: | __Example 2__ |
| Line 62: | Line 49: |
| . {{{ <EXEC_USER_OUTPUT_DESC> }}} | If a player named Alkani wanted to look at Jaxen's new outfit, he would type the following: |
| Line 64: | Line 51: |
| Then explain what other users might see, if anything: | . {{{ look Jaxen }}} |
| Line 66: | Line 53: |
| . {{{ <OTHER_USER_OUTPUT_DESC> }}} | __Example 3__ |
| Line 68: | Line 55: |
| If a player named Lepus wanted to see what an object named {{{Crate}}} looked like, he would type the following: | |
| Line 69: | Line 57: |
| __Example N__ | . {{{ look Crate }}} |
| Line 71: | Line 59: |
| If an editor wanted to continue writing examples, they could write as many as they wanted, following the general format above: | __Example 4__ |
| Line 73: | Line 61: |
| . {{{ <COMMAND> <EXAMPLE_ARGUMENTS_N> }}} | If a player named Jaxen wanted to look at the description for an exit labeled "This Way to Grandmother's House", she would type the following: |
| Line 75: | Line 63: |
| And keep writing user example output: | . {{{ look This Way to Grandmother's House }}} |
| Line 77: | Line 65: |
| . {{{ <EXEC_USER_OUTPUT_DESC> }}} | __Example 5__ |
| Line 79: | Line 67: |
| And More Output: | If a player named Jaxen traveled through the exit she just looked at and wanted to look at the description for where she ended up using the alternate syntax, she would type the following: |
| Line 81: | Line 69: |
| . {{{ <OTHER_USER_OUTPUT_DESC> }}} | . {{{ read }}} __Example 6__ If a player named Alkani wanted to look at an object called "The Book of Tea and SPAM" using the alternate syntax, he would type the following: . {{{ read The Book of Tea and SPAM }}} |
| Line 86: | Line 80: |
| Caveats for the command being written about should be placed here. These can be things like restrictions, special operations for wizards, &c. | Looking at a Room will trigger any programs set on the room's success or failure properties. Additionally, programs nested in a description will be called and/or evaluated based on a success or failure or by looking at the room itself. |
| Line 89: | Line 83: |
| [[NullPage|NullPage]] - These links should point to pages inside the wiki | [[Programming/Messages|Messages]] - Working With Messages [[Concepts/Properties|Properties]] - Information on Object Properties |
| Line 92: | Line 89: |
| [[ParentTopic|List of Whichever Category This Page Belongs In]] | [[Commands/BuiltIn|List of SpinDizzy MUCK System Built-In and Local Commands]] |
| Line 95: | Line 92: |
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 |
CategoryBuiltincmd CategoryBasiccmd |
Look
This page describes the functionality for the Built-In look command. For more information on how the extended look functionality works, look at the global look command.
Command Information |
|
Keyword |
look |
Type |
BuiltIn |
Arguments |
<object> |
Aliases |
read |
Usage |
look |
look <object> |
|
Purpose
Look at the description for an object.
Syntax
To look at the description for the current room you are in:
look
To look at the description for a specific object, including rooms, players, things, exits, actions, programs, and any other objects:
look <object>
Parameters
<object>
- The name of a room, player, program, thing, exit, action, or other object whose description you would like to view.
Examples
Example 1
If a player named Morticon wanted to see what the current room looked like, they would type the following:
look
Example 2
If a player named Alkani wanted to look at Jaxen's new outfit, he would type the following:
look Jaxen
Example 3
If a player named Lepus wanted to see what an object named Crate looked like, he would type the following:
look Crate
Example 4
If a player named Jaxen wanted to look at the description for an exit labeled "This Way to Grandmother's House", she would type the following:
look This Way to Grandmother's House
Example 5
If a player named Jaxen traveled through the exit she just looked at and wanted to look at the description for where she ended up using the alternate syntax, she would type the following:
read
Example 6
If a player named Alkani wanted to look at an object called "The Book of Tea and SPAM" using the alternate syntax, he would type the following:
read The Book of Tea and SPAM
Caveats
Looking at a Room will trigger any programs set on the room's success or failure properties. Additionally, programs nested in a description will be called and/or evaluated based on a success or failure or by looking at the room itself.
Related
Messages - Working With Messages
Properties - Information on Object Properties
Parent Topic
List of SpinDizzy MUCK System Built-In and Local Commands