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

Retrieves a vector value from an object.

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 channel or attributes values that are vectors or rotations (e.g. the translation channel or Local_Axis_Offset).

If `propertyName` represents a channel, the channel value at the current time is returned, unless the `-c` option is specified.

## Functional area

Data retrieval

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

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

### Arguments

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

### Flags

> Macro (scroll-tablelayout)

| Name | Flag arguments | Argument type | Exclusive to | Comments |
| --- | --- | --- | --- | --- |
| `c` | 0 | — | — | Retrieves the property's const value. Only has an effect if `propertyName` represents a channel (i.e. can be animated). |
| `d` | 0 | — | — | — |

> Macro (scroll-pagebreak)

## Return value

vector

## Examples

```plaintext
// Get some information about the "thorax" bone.
vector$constTrans;
vector$offsetRot;
//Get the Translation values of the thorax constants.
$constTrans = `getVectorProperty "thorax" "Translation" -c`;
print $constTrans;
// Get the local axis offset.
$offsetRot = `getVectorProperty "thorax" "Local_Axis_Offset"`;
print $offsetRot;
```

# Additional information

## Related commands

- [getBooleanArrayProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253738732)
- [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)
- [setProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736551)