dualsense-ts 2.1.44 → 2.2.0

package/docs/Touch.md

@@ -46,6 +46,7 @@ with [0,0] representing the center of the touchpad.
 - [degrees](../wiki/Touch#degrees)
 - [direction](../wiki/Touch#direction)
 - [directionDegrees](../wiki/Touch#directiondegrees)
+- [force](../wiki/Touch#force)
 - [magnitude](../wiki/Touch#magnitude)
 - [radians](../wiki/Touch#radians)
 - [vector](../wiki/Touch#vector)
@@ -103,7 +104,7 @@ with [0,0] representing the center of the touchpad.
 
 #### Defined in
 
-[src/elements/analog.ts:28](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L28)
+[src/elements/analog.ts:40](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L40)
 
 ## Properties
 
@@ -132,7 +133,7 @@ with [0,0] representing the center of the touchpad.
 
 #### Defined in
 
-[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L128)
+[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L128)
 
 ___
 
@@ -146,7 +147,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L162)
+[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L162)
 
 ___
 
@@ -160,7 +161,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L157)
+[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L157)
 
 ___
 
@@ -174,7 +175,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L154)
+[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L154)
 
 ___
 
@@ -188,7 +189,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L160)
+[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L160)
 
 ___
 
@@ -196,13 +197,15 @@ ___
 
 • `Readonly` **button**: [`Momentary`](../wiki/Momentary)
 
+Button triggered by pressing the stick.
+
 #### Inherited from
 
 [Analog](../wiki/Analog).[button](../wiki/Analog#button)
 
 #### Defined in
 
-[src/elements/analog.ts:26](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L26)
+[src/elements/analog.ts:38](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L38)
 
 ___
 
@@ -212,7 +215,7 @@ ___
 
 #### Defined in
 
-[src/elements/touch.ts:10](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/touch.ts#L10)
+[src/elements/touch.ts:10](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/touch.ts#L10)
 
 ___
 
@@ -226,7 +229,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L58)
+[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L58)
 
 ___
 
@@ -240,7 +243,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L61)
+[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L61)
 
 ___
 
@@ -254,7 +257,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L64)
+[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L64)
 
 ___
 
@@ -268,7 +271,7 @@ ___
 
 #### Defined in
 
-[src/elements/touch.ts:9](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/touch.ts#L9)
+[src/elements/touch.ts:9](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/touch.ts#L9)
 
 ___
 
@@ -282,7 +285,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L67)
+[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L67)
 
 ___
 
@@ -292,7 +295,7 @@ ___
 
 #### Defined in
 
-[src/elements/touch.ts:11](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/touch.ts#L11)
+[src/elements/touch.ts:11](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/touch.ts#L11)
 
 ___
 
@@ -300,13 +303,15 @@ ___
 
 • `Readonly` **x**: [`Axis`](../wiki/Axis)
 
+The left/right position of the input.
+
 #### Inherited from
 
 [Analog](../wiki/Analog).[x](../wiki/Analog#x)
 
 #### Defined in
 
-[src/elements/analog.ts:24](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L24)
+[src/elements/analog.ts:30](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L30)
 
 ___
 
@@ -314,13 +319,15 @@ ___
 
 • `Readonly` **y**: [`Axis`](../wiki/Axis)
 
+The up/down position of the input.
+
 #### Inherited from
 
 [Analog](../wiki/Analog).[y](../wiki/Analog#y)
 
 #### Defined in
 
-[src/elements/analog.ts:25](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L25)
+[src/elements/analog.ts:34](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L34)
 
 ___
 
@@ -404,7 +411,7 @@ Analog.\_\_@toStringTag@66
 
 #### Defined in
 
-[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L149)
+[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L149)
 
 ___
 
@@ -422,7 +429,7 @@ Analog.active
 
 #### Defined in
 
-[src/elements/touch.ts:13](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/touch.ts#L13)
+[src/elements/touch.ts:13](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/touch.ts#L13)
 
 ___
 
@@ -430,6 +437,8 @@ ___
 
 • `get` **angle**(): `number`
 
+Alias for `.direction`
+
 #### Returns
 
 `number`
@@ -440,7 +449,7 @@ Analog.angle
 
 #### Defined in
 
-[src/elements/analog.ts:68](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L68)
+[src/elements/analog.ts:100](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L100)
 
 ___
 
@@ -448,6 +457,8 @@ ___
 
 • `get` **angleDegrees**(): `number`
 
+Alias for `.directionDegrees`.
+
 #### Returns
 
 `number`
@@ -458,7 +469,7 @@ Analog.angleDegrees
 
 #### Defined in
 
-[src/elements/analog.ts:83](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L83)
+[src/elements/analog.ts:121](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L121)
 
 ___
 
@@ -466,6 +477,8 @@ ___
 
 • `get` **degrees**(): `number`
 
+Alias for `.directionDegrees`.
+
 #### Returns
 
 `number`
@@ -476,7 +489,7 @@ Analog.degrees
 
 #### Defined in
 
-[src/elements/analog.ts:78](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L78)
+[src/elements/analog.ts:114](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L114)
 
 ___
 
@@ -484,6 +497,8 @@ ___
 
 • `get` **direction**(): `number`
 
+Returns the stick's angle in radians.
+
 #### Returns
 
 `number`
@@ -494,7 +509,7 @@ Analog.direction
 
 #### Defined in
 
-[src/elements/analog.ts:58](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L58)
+[src/elements/analog.ts:86](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L86)
 
 ___
 
@@ -502,6 +517,8 @@ ___
 
 • `get` **directionDegrees**(): `number`
 
+Alias for `.direction` converted to degrees.
+
 #### Returns
 
 `number`
@@ -512,7 +529,27 @@ Analog.directionDegrees
 
 #### Defined in
 
-[src/elements/analog.ts:73](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L73)
+[src/elements/analog.ts:107](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L107)
+
+___
+
+### force
+
+• `get` **force**(): `number`
+
+Returns an force from the stick's position.
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+Analog.force
+
+#### Defined in
+
+[src/elements/analog.ts:70](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L70)
 
 ___
 
@@ -520,6 +557,8 @@ ___
 
 • `get` **magnitude**(): `number`
 
+Returns a magnitude from the stick's position.
+
 #### Returns
 
 `number`
@@ -530,7 +569,7 @@ Analog.magnitude
 
 #### Defined in
 
-[src/elements/analog.ts:53](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L53)
+[src/elements/analog.ts:79](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L79)
 
 ___
 
@@ -538,6 +577,8 @@ ___
 
 • `get` **radians**(): `number`
 
+Alias for `.direction`
+
 #### Returns
 
 `number`
@@ -548,7 +589,7 @@ Analog.radians
 
 #### Defined in
 
-[src/elements/analog.ts:63](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L63)
+[src/elements/analog.ts:93](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L93)
 
 ___
 
@@ -556,6 +597,8 @@ ___
 
 • `get` **vector**(): `Object`
 
+Returns a direction and magnitude representing the stick's position.
+
 #### Returns
 
 `Object`
@@ -571,7 +614,7 @@ Analog.vector
 
 #### Defined in
 
-[src/elements/analog.ts:48](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/elements/analog.ts#L48)
+[src/elements/analog.ts:63](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L63)
 
 ## Methods
 
@@ -592,7 +635,7 @@ And decide if this is the root Input.
 
 #### Defined in
 
-[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L168)
+[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L168)
 
 ___
 
@@ -617,7 +660,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L190)
+[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L190)
 
 ___
 
@@ -642,7 +685,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L194)
+[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L194)
 
 ___
 
@@ -660,7 +703,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L186)
+[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L186)
 
 ___
 
@@ -691,7 +734,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L199)
+[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L199)
 
 ___
 
@@ -717,7 +760,7 @@ Update the input's state and trigger all necessary callbacks.
 
 #### Defined in
 
-[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L215)
+[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L215)
 
 ___
 
@@ -735,7 +778,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L139)
+[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L139)
 
 ___
 
@@ -753,7 +796,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L131)
+[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L131)
 
 ___
 
@@ -777,7 +820,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L143)
+[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L143)
 
 ___
 
@@ -831,7 +874,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L44)
+[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L44)
 
 ___
 
@@ -980,7 +1023,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L78)
+[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L78)
 
 ___
 
@@ -1034,7 +1077,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L37)
+[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L37)
 
 ___
 
@@ -1189,7 +1232,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L91)
+[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L91)
 
 ___
 
@@ -1433,7 +1476,7 @@ Render a convenient debugging string.
 
 #### Defined in
 
-[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/6f02111/src/input.ts#L102)
+[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L102)
 
 ___