Bool Property

A Boolean Property, or more simply “Bool Property,” provides the ability alter the state of a selection by turning an option On or Off. This property is derived from the Int Property since typically “on” and “off” each signify specific mathematical functions or values, such as 1 or 0.

Toggling this property On or Off is also indicated by indention of the button. When toggled On, the button will be indented in. When toggled Off, the button will be raised.

For scripting API documentation, see DzBoolProperty.

Bool properties typically display the Default Anatomy features as well as features specific to the Numeric Property type, specifically the On/Off toggle.

As a derivative of the Numeric and Int properties, the Header of a Bool property displays a link widget. When this widget is selected, a dialog appears to display an option to link the selected property to another property.

The Body of a Bool property typically displays a toggle button that is depressed (indented) when the property is toggled On and is raised when the property is toggled Off.

The Bool property has additional attributes that help determine how the value is manipulated and how the property functions.

The Mappable attribute displays a drop-down menu option in addition to the typical Bool property features. This menu displays the option to select a map or to browse to a map. Toggle the bool On/Off button to alter the state of the selected map.

When a map is selected, mouse over the map icon to display a larger view of the map as well as the path of the map.

The Must Map attribute is a sub-group of the Mappable attribute and provides meaning to the bool state. With this property, no state will appear until a map is chosen. In this same manner, the map lacks meaning without a state. Once a map is selected, the property will reflect the same features as the Mappable attribute.