SockpuppetProperty

Category: Sockpuppet

Base class: Resource

Properties

address : str

Name of the property if patched using an address scheme

UserName: Address

default : float

UserName: Default value

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]

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 = 0

Number_HighPrecision : Final = 2

Resource : Final = 1

RgbColour : Final = 3

String : Final = 4

Methods

floatValueToInt(self, value: float, maxValue: int) -> int

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

hasOptions(self) -> bool

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