Differences between revisions 1 and 2

Page Under Construction

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

Look

This page describes the functionality for the Built-In look command. For more information on how the extended page functionality works, look at the global look command.

Command Information
Keyword	`look`
Type	`BuiltIn`
Arguments	`<object>`
Aliases	`read`
Usage	`look`
Usage	`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

If Alkani wanted to look at Jaxen's new outfit, he would type the following:

look Jaxen

If Lepus wanted to see what an object named Crate looked like, he would type the following:

look Crate

If 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

If 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

If 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.

Messages - Object Messages Properties - Object Properties

Parent Topic

List of SpinDizzy MUCK System Built-In and Local Commands

CategoryBuiltincmd CategoryBasiccmd

-  ⇤ ← Revision 1 as of 2017-08-21 04:56:13 → 
  Size: 3188
  Editor: Alkani
  Comment: CAA - Initial Commit
+   ← Revision 2 as of 2017-08-21 06:08:58 → ⇥
  Size: 2795
  Editor: Alkani
  Comment: CAA - Initial Commit
-Deletions are marked like this.
+Additions are marked like this.
 Line 2:
-##master-date:<<DateTime(2017-08-21T04:56:13-0800)>>
+##master-date:2017-08-17
 Line 13:
-= Commands/BuiltIn/look =
+= Look =
 Line 15:
-~-''<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 page functionality works, look at the global [[Commands/Globals/LookPlusPlus|look]] command.''-~
 Line 18:
-||''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 27:
-<COMMAND FUNCTION OR PURPOSE>
+Look at the description for an object.
-Line 34:
+Line 31:
-To describe syntax functionality of a program:
+To look at the description for the current room you are in:
-Line 36:
+Line 33:
- . ''{{{ <COMMAND> <PARAMETERS_1> }}}''
+ . ''{{{ look }}}''
-Line 38:
+Line 35:
-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 37:
- . ''{{{ page <COMMAND> <ARGUMENTS_N> }}}''
+ . ''{{{ look <object> }}}''
-Line 44:
+Line 41:
-''{{{<ARGUMENT_1>}}}''
+''{{{<object>}}}''
-Line 46:
+Line 43:
- . 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 49:
-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 51:
- . {{{ <COMMAND> <EXAMPLE_ARGUMENTS_1> }}}
+ . {{{ look }}}
-Line 60:
+Line 53:
-They would explain what the user output was for the user executing the command, if any:
+If Alkani wanted to look at Jaxen's new outfit, he would type the following:
-Line 62:
+Line 55:
- . {{{ <EXEC_USER_OUTPUT_DESC> }}}
+ . {{{ look Jaxen }}}
-Line 64:
+Line 57:
-Then explain what other users might see, if anything:
+If Lepus wanted to see what an object named {{{Crate}}} looked like, he would type the following:
-Line 66:
+Line 59:
- . {{{ <OTHER_USER_OUTPUT_DESC> }}}
+ . {{{ look Crate }}}
-Line 68:
+Line 61:
+If Jaxen wanted to look at the description for an exit labeled "This Way to Grandmother's House", she would type the following:
-Line 69:
+Line 63:
-__Example N__
+ . {{{ look This Way to Grandmother's House }}}
-Line 71:
+Line 65:
-If an editor wanted to continue writing examples, they could write as many as they wanted, following the general format above:
+If 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 73:
+Line 67:
- . {{{ <COMMAND> <EXAMPLE_ARGUMENTS_N> }}}
+ . {{{ read }}}
-Line 75:
+Line 69:
-And keep writing user example output:
+If Alkani wanted to look at an object called "The Book of Tea and SPAM" using the alternate syntax, he would type the following:
-Line 77:
+Line 71:
- . {{{ <EXEC_USER_OUTPUT_DESC> }}}

And More Output:

 . {{{ <OTHER_USER_OUTPUT_DESC> }}}
+ . {{{ read The Book of Tea and SPAM }}}
-Line 86:
+Line 76:
-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 79:
-[[NullPage|NullPage]] - These links should point to pages inside the wiki
+[[Programming/Messages|Messages]] - Object Messages
[[Programming/Properties|Properties]] - Object Properties
-Line 92:
+Line 83:
-[[ParentTopic|List of Whichever Category This Page Belongs In]]
+[[Commands/BuiltIn|List of SpinDizzy MUCK System Built-In and Local Commands]]
-Line 95:
+Line 86:
-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

Diff for "Commands/BuiltIn/look"