---
title: "getBooleanArrayProperty"
canonical: "https://help.vicon.com/space/ShogunPost121/1253738732/getBooleanArrayProperty"
format: markdown
---
# Description

Retrieves an array of Boolean values from a object's attributes.

Because Shogun Post commands can only have one return type, there must be separate commands for retrieving different types of property data.

This command is mainly used to retrieve the DOF (Degrees of Freedom) attribute. A six element Boolean array is returned. DOFs that are turned on will have "true" array values.

## Functional area

Data retrieval

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

|  |
| --- |
| `getBooleanArrayProperty moduleName propertyName` |

### Arguments

> Macro (scroll-tablelayout)

| Name | Type | Required | Comments |
| --- | --- | --- | --- |
| `propertyName` | string | yes | Name of the property on the object. |
| `moduleName` | string | yes | Object to retrieve property value from. |

### Flags

None

## Return value

boolean array

> Macro (scroll-pagebreak)

## Examples

```plaintext
// Get the DOFs of the "thorax" bone.
boolean $dofs[];
$dofs = `getBooleanArrayProperty "thorax" "DOF"`;
print $dofs;
```

# Additional information

## Related commands

- [getBooleanProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737690)
- [getFloatProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737640)
- [getIntArrayProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737426)
- [getIntProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737493)
- [getProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253737125)
- [getStringProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253740024)
- [getVectorProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736549)
- [setProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736551)