Show / Hide Table of Contents

Class RotateCmd

Sent to server, generic message that can control any rotating device. This message can take multiple commands for devices with multiple rotators.

Inheritance
Object
ButtplugMessage
ButtplugDeviceMessage
RotateCmd
Inherited Members
ButtplugDeviceMessage.DeviceIndex
ButtplugMessage.Id
ButtplugMessage.Name
ButtplugMessage.GetName(Type)
Namespace: Buttplug.Core.Messages
Assembly: Buttplug.dll
Syntax
public class RotateCmd : ButtplugDeviceMessage

Constructors

RotateCmd(List<RotateCmd.RotateSubcommand>)

Initializes a new instance of the RotateCmd class.

Declaration
public RotateCmd(List<RotateCmd.RotateSubcommand> rotations)
Parameters
Type Name Description
List<RotateCmd.RotateSubcommand> rotations

List of rotations.

RotateCmd(UInt32, List<RotateCmd.RotateSubcommand>, UInt32)

Initializes a new instance of the RotateCmd class.

Declaration
public RotateCmd(uint deviceIndex, List<RotateCmd.RotateSubcommand> rotations, uint id = null)
Parameters
Type Name Description
UInt32 deviceIndex

Device index.

List<RotateCmd.RotateSubcommand> rotations

List of rotations.

UInt32 id

Message ID.

Fields

Rotations

List of rotation speeds and directions.

Declaration
public List<RotateCmd.RotateSubcommand> Rotations
Field Value
Type Description
List<RotateCmd.RotateSubcommand>

Methods

Create(IEnumerable<RotateCmd.RotateCommand>)

Declaration
public static RotateCmd Create(IEnumerable<RotateCmd.RotateCommand> cmds)
Parameters
Type Name Description
IEnumerable<RotateCmd.RotateCommand> cmds
Returns
Type Description
RotateCmd

Create(Double, Boolean, UInt32)

Declaration
public static RotateCmd Create(double speed, bool clockwise, uint cmdCount)
Parameters
Type Name Description
Double speed
Boolean clockwise
UInt32 cmdCount
Returns
Type Description
RotateCmd

Create(UInt32, UInt32, IEnumerable<RotateCmd.RotateCommand>)

Declaration
public static RotateCmd Create(uint deviceIndex, uint msgId, IEnumerable<RotateCmd.RotateCommand> cmds)
Parameters
Type Name Description
UInt32 deviceIndex
UInt32 msgId
IEnumerable<RotateCmd.RotateCommand> cmds
Returns
Type Description
RotateCmd

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

Declaration
public static RotateCmd Create(uint deviceIndex, uint msgId, double speed, bool clockwise, uint cmdCount)
Parameters
Type Name Description
UInt32 deviceIndex
UInt32 msgId
Double speed
Boolean clockwise
UInt32 cmdCount
Returns
Type Description
RotateCmd
In This Article
Back to top Generated by DocFX