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

Set a key on the named property of the selected modules.

Use setKey to set explicit key frames on the named property. These values can either be absolute or relative to existing values.

## Functional area

Data manipulators

# Command syntax

## Syntax

> Macro (scroll-tablelayout)

|  |
| --- |
| `setKey "propertyType" value1 ...[-t integer] [-r] [-all] [-onMod string] [-type string]` |

### Arguments

One string argument indicating the property to be keyed, one or three float arguments, dependent upon the property name called. For example, one value for TranslationX, and three values if Translation is indicated. Set value relative to current value instead of absolute value.

> Macro (scroll-tablelayout)

| Name | Type | Required | Comments |
| --- | --- | --- | --- |
| `floatValue3` | float |  | Property value3 if applicable, depends on the property |
| `floatValue2` | float |  | Property value2 if applicable, depends on the property |
| `floatValue1` | float |  | Property value1 |
| `propertyName` | string |  | String name of the property for the key |

> Macro (scroll-pagebreak)

### Flags

| Name | Flag arguments | Argument type | Exclusive to | Comments |
| --- | --- | --- | --- | --- |
| `t` | 1 | integer | — | — |
| `r` | 0 | — | — | — |
| `onMod` | 1 | string | — | — |
| `-all` |  |  |  |  |
| `type` |  | string |  |  |

## Return value

void

## Examples

```plaintext
select LFWT;
 setKey -t 250 "Translation" 35 15 150;
// Set a key for the Translation XYZ property of the Marker "LFWT" 
// at frame 250.
```

# Additional information

## Related commands

- [setProperty](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost121/pages/1253736551)