---
title: "getParameter"
canonical: "https://help.vicon.com/space/ShogunPost115/276208721/getParameter"
format: markdown
---
# Description

Returns the value of the given parameter.

Parameters are stored on characters and used by bones and constraints. The getParameter command allows the value of a parameter to be accessed. By default, the command expects the character to be selected, but the `-onMod` option can be used to specify the character without having to select it.

## Functional area

Parameters

# Command syntax

## Syntax

|  |
| --- |
| `getParameter parameterName[-onMod string] [-solving]` |

### Arguments

None

### Flags

| **Name** | **Flag arguments** | **Argument type** | **Exclusive to** | **Comments** |
| --- | --- | --- | --- | --- |
| `onMod` | 1 | string | — | Specifies which character to look on for a parameter of the given name. |
| `solving` |  |  |  |  |

> Macro (scroll-pagebreak)

## Return value

float

Returns the value of the parameter.

## Examples

```plaintext
// Get the parameter UpperLegLength from the character Bob 
float $upperLegLength = `getParameter UpperLegLength -onMod "Bob"`;
```

# Additional information

## Related commands

- [addParameter](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276201713)
- [getParameters](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276204443)
- [hasParameter](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276206872)
- [listParameters](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276211422)
- [removeAllParameters](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276206721)
- [removeParameter](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276205508)
- [removeUnusedParameters](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276202183)
- [renameParameter](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276202749)
- [selectByParameter](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276212630)
- [setParameter](https://vicon-help.atlassian.net/wiki/spaces/ShogunPost115/pages/276202195)