Class LinearCmd

Sent to server, generic message that can control any linear-actuated device. This message can take multiple commands for devices with multiple actuators.

Inheritance

Object

ButtplugMessage

ButtplugDeviceMessage

LinearCmd

Inherited Members

ButtplugDeviceMessage.DeviceIndex

ButtplugMessage.Id

ButtplugMessage.Name

ButtplugMessage.GetName(Type)

Namespace: Buttplug.Core.Messages

Assembly: Buttplug.dll

Syntax

public class LinearCmd : ButtplugDeviceMessage

Constructors

LinearCmd(List<LinearCmd.VectorSubcommand>)

Declaration

public LinearCmd(List<LinearCmd.VectorSubcommand> vectors)

Parameters

Type	Name	Description
List<LinearCmd.VectorSubcommand>	vectors

LinearCmd(UInt32, List<LinearCmd.VectorSubcommand>, UInt32)

Initializes a new instance of the LinearCmd class.

Declaration

public LinearCmd(uint deviceIndex, List<LinearCmd.VectorSubcommand> vectors, uint id = null)

Parameters

Type	Name	Description
UInt32	deviceIndex	Device index.
List<LinearCmd.VectorSubcommand>	vectors	Movement vector list.
UInt32	id	Message ID.

Fields

Vectors

List of linear movement vectors.

Declaration

public List<LinearCmd.VectorSubcommand> Vectors

Field Value

Type	Description
List<LinearCmd.VectorSubcommand>

Methods

Create(IEnumerable<LinearCmd.VectorCommand>)

Declaration

public static LinearCmd Create(IEnumerable<LinearCmd.VectorCommand> cmds)

Parameters

Type	Name	Description
IEnumerable<LinearCmd.VectorCommand>	cmds

Returns

Type	Description
LinearCmd

Create(UInt32, Double, UInt32)

Declaration

public static LinearCmd Create(uint duration, double position, uint cmdCount)

Parameters

Type	Name	Description
UInt32	duration
Double	position
UInt32	cmdCount

Returns

Type	Description
LinearCmd

Create(UInt32, UInt32, IEnumerable<LinearCmd.VectorCommand>)

Declaration

public static LinearCmd Create(uint deviceIndex, uint msgId, IEnumerable<LinearCmd.VectorCommand> cmds)

Parameters

Type	Name	Description
UInt32	deviceIndex
UInt32	msgId
IEnumerable<LinearCmd.VectorCommand>	cmds

Returns

Type	Description
LinearCmd

Create(UInt32, UInt32, UInt32, Double, UInt32)

Declaration

public static LinearCmd Create(uint deviceIndex, uint msgId, uint duration, double position, uint cmdCount)

Parameters

Type	Name	Description
UInt32	deviceIndex
UInt32	msgId
UInt32	duration
Double	position
UInt32	cmdCount

Returns

Type	Description
LinearCmd