---
title: "SockpuppetProperty"
description: "API documentation for SockpuppetProperty"
url: https://developer.disguise.one/python-api/docs/sockpuppetproperty/
---

# SockpuppetProperty

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

## Properties

#### **address** : _str_

Name of the property if patched using an address scheme

_UserName: Address_

#### **default** : _float_

_UserName: Default value_

#### **defaultResourceUid** : _int_

UID for the default resource associated with this property

#### **defaultString** : _str_

_UserName: Default value_

#### **displayName** : _str_

_UserName: Display name_

#### **dmxChannelOffset** : _int_

Number of DMX channels to leave empty before this property, if patched to DMX.

_UserName: DMX channel offset_

#### **enabled** : _bool_

Globally enabled when patched

_UserName: Enabled_

#### **fieldName** : _str_

_UserName: Field name_

#### **gdtfAttribute** : _str_

Manual override for GDTF Attribute. Leave blank for automatic matching

_Category: GDTF  
UserName: GDTF Attribute_

#### **gdtfFeature** : _str_

Manual override for GDTF Feature. Leave blank for automatic matching

_Category: GDTF  
UserName: GDTF Feature_

#### **gdtfFeatureGroup** : _str_

Manual override for GDTF Feature Group. Leave blank for automatic matching

_Category: GDTF  
UserName: GDTF Feature Group_

#### **group** : _str_

_UserName: Group name_

#### **max** : _float_

_UserName: Maximum_

#### **min** : _float_

_UserName: Minimum_

#### **options** : _List\[[SockpuppetPropertyOption](/python-api/docs/sockpuppetpropertyoption#sockpuppetpropertyoption)\]_

_UserName: Options_

#### **resourceType** : _type_

_UserName: Resource type_

#### **resourceTypeName** : _str_ _(Read-Only)_

Returns the type of the Resource, in text form, that this Sockpuppet Property is set to control.

#### **step** : _float_

_UserName: Step_

#### **type** : _int_

_Options: {0: ‘8-bit’, 1: ‘bank/slot’, 2: ‘16-bit’, 3: ‘RGB-colour’, 4: ‘string’}  
UserName: Type_

## Variables

#### **Number** : _Final\[[SockpuppetPropertyType](/python-api/docs/sockpuppetpropertytype#sockpuppetpropertytype)\]_ = SockpuppetPropertyType.Number

#### **Number\_HighPrecision** : _Final\[[SockpuppetPropertyType](/python-api/docs/sockpuppetpropertytype#sockpuppetpropertytype)\]_ = SockpuppetPropertyType.Number\_HighPrecision

#### **Resource** : _Final\[[SockpuppetPropertyType](/python-api/docs/sockpuppetpropertytype#sockpuppetpropertytype)\]_ = SockpuppetPropertyType.Resource

#### **RgbColour** : _Final\[[SockpuppetPropertyType](/python-api/docs/sockpuppetpropertytype#sockpuppetpropertytype)\]_ = SockpuppetPropertyType.RgbColour

#### **String** : _Final\[[SockpuppetPropertyType](/python-api/docs/sockpuppetpropertytype#sockpuppetpropertytype)\]_ = SockpuppetPropertyType.String

## Methods

#### **floatValueToInt**(self, value: _float_, maxValue: _int_) -> _int_

Convert float value to 0-255 or 0-65535 int, using user-set min and max

#### **getDefaultResource**(self) -> _[Resource](/python-api/docs/resource#resource)_

Gets the default resource associated with this property.

#### **hasOptions**(self) -> _bool_

Returns true if the Sockpuppet Property has an assigned set of allowed options for its values.

#### **setDefaultResource**(self, resource: _[Resource](/python-api/docs/resource#resource)_) -> _Self_

Sets the default resource associated with this property.