Short Location Description

From ADRIFT 5 Manual Wiki
(Redirected from %location%.Name function)
Jump to: navigation, search

This is a property of all Locations. Key = ShortLocationDescription

The Short Location Desciption is one of the two properties shown on the description page of locations, where it is labeled "Short description".

Although it is a text property, it is normally displayed as a single line of text instead of as a text box.

To display the full text box, click on the down-arrow at the right-hand end. This allows you to create an alternate description so that the location can have a different name if it has changed substantially.

The contents of this text box is displayed when the player moves into this location, or when they use the Look command, and is usually followed by the Long Location Description and a list of dynamic objects and characters that are currently at this location.

> look
Lounge Room
This is a very basic lounge room. A couple of well worn chairs face a very old television set.
Also here is a bouquet of flowers and a fountain pen. Marcia and Jan are here.

It is also displayed inside the box representing this location on the map.

The Name location function will return the contents of this text box.


This property is defined in the "Properties" folder of The Standard Library:


  • Property of: Locations - It is only available on the property page of Locations.
  • Type: Text - This property will contain a text box.
  • Because this property is shown on the description page, not the properties page, the "Mandatory" tick-box and the "This property will only appear if the following are true" section, will have no effect.

%location%.Name function

The "Name" function is an alias of the "ShortLocationDescription" function. Both of these functions return the contents of the "Short Location Description" property of locations, which is the drop-down text box marked "Short Description:" at the top of the "Description" page of a location.

<<< DescriptionLocation FunctionsList Functions >>>