---
title: "getBooleanProperty"
canonical: "https://help.vicon.com/space/Shogun17/13536333/getBooleanProperty"
format: markdown
---
# Description

Retrieves a Boolean value from an 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 used to retrieve attributes that can have either an on or off state (e.g. Showing).

It can also be used to retrieve sub-elements of an attribute with many elements (e.g. DOF).

## Functional area

Data retrieval

# Command syntax

## Syntax

|  |
| --- |
| `getBooleanProperty moduleName propertyName[-c] [-d]` |

### Arguments

> Macro (scroll-tablelayout)

| **Name** | **Type** | **Required** | **Comments** |
| --- | --- | --- | --- |
| `subPropertyName` | string | no | If propertyName represents an array of booleans (e.g. the DOF attribute), this will specify one of the sub-fields. |
| `propertyName` | string | yes | Name of the property on the object. |
| `moduleName` | string | yes | Object to retrieve property value from. |

### Flags

| **Name** | **Flag arguments** | **Argument type** | **Exclusive to** | **Comments** |
| --- | --- | --- | --- | --- |
| `c` | 0 | — | — | — |
| `d` | 0 | — | — | — |


## Return value

boolean

## Examples

```plaintext
// Get some information about the "thorax" bone.
boolean $hasXRotDof;
boolean $isSpine; 
$hasXRotDof = `getBooleanProperty "thorax" "DOF" "Rx"`;
print $hasXRotDof;
$isSpine = `getBooleanProperty "thorax" "Spine_Bone"`;
print $isSpine;
```

# Additional information

## Related commands

- [getBooleanArrayProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13536335)
- [getFloatProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13536349)
- [getIntArrayProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13536419)
- [getIntProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13536427)
- [getProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13536619)
- [getStringProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13536651)
- [getVectorProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13537006)
- [setProperty](https://vicon-help.atlassian.net/wiki/spaces/Shogun17/pages/13537188)