Class BasicButtManager

Inheritance

System.Object

BasicButtManager

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: BasicButtManager

Assembly: BasicButtManager.dll

Syntax

public class BasicButtManager

Constructors

BasicButtManager(String)

Create a new manager for the given game.

Declaration

public BasicButtManager(string name = "BasicButtManager")

Parameters

Type	Name	Description
System.String	name	Name to identify the purpose of the manager, typically the game's name.

Methods

Control(Single, Single, Boolean)

Directly control your toys with the provided parameters.

Declaration

public async Task Control(float intensity, float position = -1F, bool oscillate = false)

Parameters

Type	Name	Description
System.Single	intensity	Intensity for vibrators, oscillators, rotators, pressurizers, etc.
System.Single	position	Position of linear actuators, if omitted will take the value of intensity.
System.Boolean	oscillate	If true, let the linear actuators move automatically at a set speed (based on intensity). Only applicable if position not given.

Returns

Type	Description
System.Threading.Tasks.Task

Remarks

It is recommended in most cases to use one of the provided convenient functions instead, most notably Set().

Exit()

Stop all connected toys and close server connection.

Declaration

public void Exit()

Fade(Single, Single)

Fade the intensity of all toys to a certain point.

Declaration

public async Task Fade(float targetIntensity, float smoothness = 1F)

Parameters

Type	Name	Description
System.Single	targetIntensity	The target intensity, can be higher or lower than the current intensity.
System.Single	smoothness	Between 0f and 1f, the higher the smoother the transition.

Returns

Type	Description
System.Threading.Tasks.Task

Remarks

Does not support multiple fades at one time.

FadeIn()

Fade all toys in from zero intensity to max power.

Declaration

public async Task FadeIn()

Returns

Type	Description
System.Threading.Tasks.Task

Remarks

Does not support multiple fades at one time.

FadeOut()

Fade all toys out from max intensity to zero power.

Declaration

public async Task FadeOut()

Returns

Type	Description
System.Threading.Tasks.Task

Remarks

Does not support multiple fades at one time.

Hold(Single)

Push all strokers down, buzz vibrators for a bit, then push strokers back up.

Declaration

public async Task Hold(float reboundSpeed)

Parameters

Type	Name	Description
System.Single	reboundSpeed	How long the action is held before being released, from 0f to 1f.

Returns

Type	Description
System.Threading.Tasks.Task

Remarks

Basically the slow version of Pulse().

Press(Single)

Set all toys to the same constant speed AND location.

Declaration

public async Task Press(float actionValue)

Parameters

Type	Name	Description
System.Single	actionValue	The intensity or location to be set to all connected toys.

Returns

Type	Description
System.Threading.Tasks.Task

Pulse(Single)

Press for a single buzz/squeeze/stroke/spin.

Declaration

public async Task Pulse(float reboundSpeed)

Parameters

Type	Name	Description
System.Single	reboundSpeed	How long the action is held before being released, from 0f to 1f.

Returns

Type	Description
System.Threading.Tasks.Task

Remarks

Client must make sure to not pulse too often too quickly (~ once per second is ideal).

Set(Single)

Vibrate, oscillate, stroke, etc. all connected devices according to the one given intensity value.

Declaration

public async Task Set(float intensity)

Parameters

Type	Name	Description
System.Single	intensity	The intensity to be applied to all connected toys.

Returns

Type	Description
System.Threading.Tasks.Task

Stop()

Stop all connected toys.

Declaration

public async Task Stop()

Returns

Type	Description
System.Threading.Tasks.Task