Specifically exclude object from location descriptions

From ADRIFT 5 Manual Wiki
Jump to: navigation, search

This is a property of DYNAMIC objects only. Dynamic objects are those that the player can pick up and carry around.

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

RestrictionObjectDynamic.jpg

Normally all dynamic objects are listed automatically following the location description:

> 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 no longer list it with the other dynamic objects. In this example the fountain pen has this property selected:

> 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. Marcia and Jan are here.

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

RestrictionExplicitlyExclude.jpg

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

ExplicitlyExclude 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 exclude object from location descriptions" property is NOT selected, another property called "When the object is listed in location, disply this" will be available immediately under it on this object's property page:

PropertyListDescriptionDynamic.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".

When "Specifically exclude object from location descriptions" is selected, the text box will be removed from the property page.

In this example note that the text shown in the text box above is printed, instead of the usual message "Also here is a top hat".

> look
Main street
This is the very centre of town, with businesses lining both sides of the roadway.
It is late at night. All of the shops closed long ago and the street is completely deserted.
A top hat lies forlornly in the gutter

Alternate Descriptions can be used to change the description of the object, for example to give a different description when it is raining and the hat is wet.


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 "Properties" folder of The Standard Library:

PropertyDialogExplicitlyExclude.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 dynamic, so is not available on static objects.

PropertyDialogListDescriptionDynamic.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 exclude object from location descriptions" property has NOT been selected.


<<< Object is wearableMain_PageObject is drinkable >>>