Boolean functions

From ADRIFT 5 Manual Wiki
Revision as of 07:05, 9 September 2013 by Saabie (Talk | contribs) (examples)

Jump to: navigation, search

The boolean item functions correspond to selection-only properties.

They can be used in two ways:

  • If used to read a property value, the function will return 0 if the property is not selected and 1 if it is selected.
  • If used with a group then the function will filter the group so that only those members which have that property selected will remain.

Common object properties

These properties are shared by both static and dynamic objects:

Surface

If the "Object is a supporter" property of an object is selected, then this object is a flat surface such as a table, chair or bed, on top of which other objects may be placed.

The "%object%.Surface" function will return 1 if this property is set, or 0 if it's not.

Used with an object group this function will filter the group to only contain objects with surfaces that can support other objects.

Selecting this property will also make four other properties available:

ObjectPropertiesCanHold.jpg

The first 3 are selection-only properties which determine whether a character (including the player) are able to lay down on, sit on or stand on this object.

The "...and the surface can hold" property indicates the number of objects that can be placed on this surface. This value can be read with the %object%.SurfaceHold function

Lieable

Returns the value 1 if the "Characters can lie on this object" property is selected, 0 otherwise.

This property must be selected for the player to be able to lie down on this object.

Sittable

Returns the value 1 if the "Characters can sit on this object" property is selected, 0 otherwise.

This property must be selected for the player to be able to sit down on this object.

Standable

Returns the value 1 if the "Characters can stand on this object" property is selected, 0 otherwise.

This property must be selected for the player to be able to stand on top of this object.

Container

Openable

Lockable

CharactersCanGoInOb

Static object properties

Objects which are too big or heavy to pick up and move around will have these properties:

ExplicitlyList

Dynamic object properties

Objects that the player can pick up will have these properties:

Drinkable

Edible

Readable

Wearable

ExplicitlyExclude

Examples

  • Object7.Surface
Returns 1 if the specific object with the key "Object7" can have other objects placed on top of it, 0 if not.
  • %object%.Openable
Returns 1 if the referenced object, in a task with an %object% reference, can be opened and closed by the player.
  • LightSources.Container.List
Filters the list of objects in the object group "Light Sources" so that only those that are containers (that have the "Object is a container" property selected) are listed.