##master-page:CommandTemplate
##master-date:2017-08-17
##master-revision:3
#format wiki
#language en

= Home =

||||<rowstyle="background-color: #CCCCCC;">'''Command Information'''||
||''Keyword'' ||<:>{{{ home }}}||
||''Type'' ||<:>{{{ BuiltIn }}}||
||<(|1>''Arguments'' ||<:> None ||
||''Aliases''||<:> None ||
||<(|1>''Usage''||<:>{{{ home }}}||

=== Purpose ===

Sends a character to their designated home location.

=== Syntax ===

For a character to go to their home:

 . ''{{{ home }}}''

=== Parameters ===

This command does not accept parameters.

=== Examples ===

__Example 1__

If Lepus needed to return home to recharge for the evening, they would type:

 . {{{ home }}}

Lepus would see:

 . {{{ "There's no place like home." }}}
 . {{{ "There's no place like home." }}}
 . {{{ "There's no place like home." }}}
 . {{{ "You wake up back home, without your possessions." }}}

Lepus would then see the description of their designated home room.

Others in the room would see:

 . {{{ "Lepus goes home." }}}
 . {{{ "Lepus has left." }}}

=== Caveats ===

When a player uses this command, they will be sent to their designated home without any of their belongings.

A similar process for returning home can be performed using the [[Commands/BuiltIn/go|go]] built-in command and by using the [[Commands/Globals/Teleport|Teleport]] global command.

=== Related ===

[[Commands/Globals/Teleport|Teleport]] - Teleport to a location

[[Commands/BuiltIn/go|Go]] - Move in a particular direction

[[Concepts/Characters#Belongings|Belongings]] - Information about Character Belongings

[[Concepts/Rooms#Home|Home]] - Information about the special Home room

=== Parent Topic ===

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

-----
CategoryBuiltincmd CategoryBasiccmd