Specifically list object in location descriptions

From ADRIFT 5 Manual Wiki
Jump to: navigation, search

This is a property of STATIC objects only. Static objects are those that are too big or too heavy for the player to carry around, or nailed down so they can't be moved. This usually includes things like beds, tables, desks, refridgerator, doors, wardobes, television, sofa, carpet, walls, etc.

If you need to check if a referenced object is static, then you can use a property restriction to check that the "Object Type" is "Static".

RestrictionObjectStatic.jpg

Normally all static objects are expected to be described within the description of the location in which they reside, while dynamic objects are listed separately because they can be moved to any 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.

This property allows you to change that behavior. If you select it (by ticking the box) then ADRIFT will list its name along with the dynamic objects after printing the location description, whenever the player uses the "Look" command.

> look
Lounge Room
A couple of well worn chairs sit in the centre of a very basic lounge room.
Also here is an old television, a bouquet of flowers and a fountain pen. Marcia and Jan are here.

To check if a referenced object has this property selected, you need to use an object restriction:

RestrictionExplicitlyList.jpg

The ExplicitlyList object function will return 0 if this property is not selected, or 1 if it is.

ExplicitlyList can also be used as an Object Group Function to filter a group of objects so that only those with this property selected are returned.

When the object is listed in location, display this

When the "Specifically list object in location description" property is selected, another property called "When the object is listed in location, disply this" will be added immediately under it on this object's property list:

PropertyListDescription.jpg

This property is a text box, and if this property is selected then the text that is entered in this text box will be printed after the location description, and before the list of dynamic objects, when the player enters "Look".

> look
Lounge Room
A couple of well worn chairs sit in the centre of a very basic lounge room.
An old TV set sits in the corner.
Also here is a bouquet of flowers and a fountain pen. Marcia and Jan are here.

Alternate Descriptions can be used to change the description of the object, for example to give different descriptions when the TV is switched on or off.


To check if this property is selected, use an object restriction:

RestrictionHasListDescription.jpg

To compare the contents of the text box with a text variable or the result of an expression, you can use a property restriction:

RestrictionListDescription.jpg

To change the contents of the text box you can use a set property action:

ActionListDescription.jpg

The ListDescription object function will return the text in this text box.

Definition

These properties are defined in the "Look and Examine" folder of The Standard Library:

PropertyDialogExplicitlyList.jpg

  • Property of: Objects - It is only available on the property page of Objects.
  • Type: Selection Only - It only has a tick-box, so can be selected or not.
  • Its not mandatory.
  • It only appears if the object type is static, so is not available on dynamic objects.

PropertyDialogListDescription.jpg

  • Property of: Objects - It is only available on the property page of Objects.
  • Type: Text - As well as a tick-box, this property will also contain a text box.
  • Its not mandatory, so you can choose whether to select it or not.
  • It only appears if the "Specifically list object in location description" property has first been selected.


<<< ObjectsMain_PageObject is wearable >>>