Vivecraft Spigot API

https://vivecraft.github.io/spigot-javadoc/
Admin
The Vivecraft Spigot API provides an interface for developers to interact with Vivecraft...
Tokens:10,826
Snippets:50
Trust Score:8.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### VRAPI Instance

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/VRAPI

Gets the API instance for interacting with Vivecraft's common API.

```APIDOC
## GET /vr/api/instance

### Description
Gets the API instance for interacting with Vivecraft's common API.

### Method
GET

### Endpoint
/vr/api/instance

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **VRAPI** (object) - The Vivecraft API instance.

#### Response Example
```json
{
  "message": "VRAPI instance retrieved successfully"
}
```
```

--------------------------------

### Get Historical VR Poses

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/VRAPI

Returns the history of VR poses for the player. Note that due to latency, historical data may be unideal.

```APIDOC
## GET /vr/api/getHistoricalVRPoses

### Description
Returns the history of VR poses for the player. Note that due to the inherent latency of networking, historical VR data retrieved by the server may be unideal.

### Method
GET

### Endpoint
/vr/api/getHistoricalVRPoses

### Parameters
#### Query Parameters
- **player** (string) - Required - The unique identifier of the player.

#### Request Body
None

### Request Example
```
GET /vr/api/getHistoricalVRPoses?player=player123
```

### Response
#### Success Response (200)
- **vrPoseHistory** (object | null) - The history of VR poses for the player. Will be `null` if the player isn't in VR or if VR-specific data hasn't been received.
  - **poses** (array) - An array of VR pose objects.

#### Response Example
```json
{
  "vrPoseHistory": {
    "poses": [
      {
        "timestamp": 1678886400000,
        "head": {
          "x": 0.0,
          "y": 1.6,
          "z": 0.0,
          "yaw": 0.1,
          "pitch": 0.0,
          "roll": 0.0
        },
        "leftHand": {
          "x": -0.5,
          "y": 1.0,
          "z": 0.2,
          "yaw": 0.0,
          "pitch": 0.0,
          "roll": 0.0
        },
        "rightHand": {
          "x": 0.5,
          "y": 1.0,
          "z": 0.2,
          "yaw": 0.0,
          "pitch": 0.0,
          "roll": 0.0
        }
      }
    ]
  }
}
```
```

--------------------------------

### Get VR Player Pose History Data (Java)

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRPoseHistory

Provides methods to retrieve and analyze the historical pose data of a VR player. This includes getting the number of available historical ticks, retrieving all historical poses, getting a specific historical pose, and calculating net movement, average velocity, and average speed for a given body part within a specified time frame. It handles exceptions for invalid tick ranges or body parts.

```java
import org.bukkit.util.Vector;
import java.util.List;

public interface VRPoseHistory {
    /**
     * Gets the number of ticks, historical data is currently available for.
     * The number returned by this method will never be higher than 200, the maximum number of ticks Vivecraft holds data for, however, it can be lower than 200.
     *
     * @return The number of ticks, historical data is currently available for.
     * @since 1.3.0
     */
    int ticksOfHistory();

    /**
     * Gets a raw list of `VRPose` instances, with index 0 representing the current tick's pose, 1 representing last tick's pose, etc.
     *
     * @return The aforementioned list of `VRPose` instances.
     * @since 1.3.0
     */
    List<VRPose> getAllHistoricalData();

    /**
     * Gets the pose from `ticksBack` ticks back, or `null` if such data isn't available.
     *
     * @param ticksBack Ticks back to retrieve data from.
     * @return A `VRPose` instance from `ticksBack` ticks ago, or `null` if that data isn't available.
     * @throws IllegalArgumentException Thrown when `ticksBack` is outside the range [0,200].
     * @since 1.3.0
     */
    VRPose getHistoricalData(int ticksBack) throws IllegalArgumentException;

    /**
     * Gets the net movement between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.
     *
     * @param bodyPart The body part to get the net movement for.
     * @param maxTicksBack The maximum number of ticks back to compare the most recent data with.
     * @return The aforementioned net movement. Note that this will return zero change on all axes if only zero ticks can be looked back. Will be `null` if the body part requested isn't available.
     * @throws IllegalArgumentException Thrown when `maxTicksBack` is outside the range [0,200] or an invalid `bodyPart` is supplied.
     * @since 1.3.0
     */
    @Nullable
    Vector netMovement(VRBodyPart bodyPart, int maxTicksBack) throws IllegalArgumentException;

    /**
     * Gets the average velocity in blocks/tick between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.
     *
     * @param bodyPart The body part to get the average velocity for.
     * @param maxTicksBack The maximum number of ticks back to calculate velocity with.
     * @return The aforementioned average velocity on each axis. Note that this will return zero velocity on all axes if only zero ticks can be looked back. Will be `null` if the body part requested isn't available.
     * @throws IllegalArgumentException Thrown when `maxTicksBack` is outside the range [0,200] or an invalid `bodyPart` is supplied.
     * @since 1.3.0
     */
    @Nullable
    Vector averageVelocity(VRBodyPart bodyPart, int maxTicksBack) throws IllegalArgumentException;

    /**
     * Gets the average speed in blocks/tick between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.
     *
     * @param bodyPart The body part to get the average speed for.
     * @param maxTicksBack The maximum number of ticks back to calculate speed with.
     * @return The aforementioned average speed. Note that this will return zero speed if only zero ticks can be looked back.
     * @throws IllegalArgumentException Thrown when `maxTicksBack` is outside the range [0,200] or an invalid `bodyPart` is supplied.
     * @since 1.3.0
     */
    double averageSpeed(VRBodyPart bodyPart, int maxTicksBack) throws IllegalArgumentException;

    /**
     * Gets the average position between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.
     *
     * @param bodyPart The body part to get the average position for.
     * @param maxTicksBack The maximum number of ticks back to calculate position with.
     * @return The aforementioned average position. Note that this will return the current position if only zero ticks can be looked back. Will be `null` if the body part requested isn't available.
     * @throws IllegalArgumentException Thrown when `maxTicksBack` is outside the range [0,200] or an invalid `bodyPart` is supplied.
     * @since 1.3.0
     */
    @Nullable
    Vector averagePosition(VRBodyPart bodyPart, int maxTicksBack) throws IllegalArgumentException;
}

```

--------------------------------

### Get VR Pose

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/VRAPI

Returns the VR pose for the given player. Returns null if the player isn't in VR.

```APIDOC
## GET /vr/api/getVRPose

### Description
Returns the VR pose for the given player. Will return `null` if the player isn't in VR or no data has been received for said player.

### Method
GET

### Endpoint
/vr/api/getVRPose

### Parameters
#### Query Parameters
- **player** (string) - Required - The unique identifier of the player.

#### Request Body
None

### Request Example
```
GET /vr/api/getVRPose?player=player123
```

### Response
#### Success Response (200)
- **vrPose** (object | null) - The VR pose for a player, or `null` if the player isn't in VR or no data has been received.
  - **head** (object) - Pose of the head.
  - **leftHand** (object) - Pose of the left hand.
  - **rightHand** (object) - Pose of the right hand.

#### Response Example
```json
{
  "vrPose": {
    "head": {
      "x": 0.0,
      "y": 1.6,
      "z": 0.0,
      "yaw": 0.0,
      "pitch": 0.0,
      "roll": 0.0
    },
    "leftHand": {
      "x": -0.5,
      "y": 1.0,
      "z": 0.2,
      "yaw": 0.0,
      "pitch": 0.0,
      "roll": 0.0
    },
    "rightHand": {
      "x": 0.5,
      "y": 1.0,
      "z": 0.2,
      "yaw": 0.0,
      "pitch": 0.0,
      "roll": 0.0
    }
  }
}
```
```

--------------------------------

### Get Average Speed of VR Body Part (Java)

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRPoseHistory

Calculates the average speed of a specified VR body part in blocks per tick. It considers poses within a maximum tick range. Returns zero speed if insufficient data or the body part is unavailable. Throws IllegalArgumentException for invalid parameters.

```Java
/**
 * Gets the average speed in blocks/tick between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.
 *
 * @param bodyPart The body part to get the average speed for.
 * @param maxTicksBack The maximum number of ticks back to calculate speed with.
 * @return The aforementioned average speed on each axis. Note that this will return zero speed if only zero ticks can be looked back, or if the body part requested isn't available.
 * @throws IllegalArgumentException Thrown when `maxTicksBack` is outside the range [0,200] or an invalid `bodyPart` is supplied.
 * @since 1.3.0
 */
@Nullable
public Vector averageSpeed(VRBodyPart bodyPart, int maxTicksBack) throws IllegalArgumentException
```

--------------------------------

### Get Average Position

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRPoseHistory

Retrieves the average position of a specified body part over a given number of ticks.

```APIDOC
## GET /api/vivecraft/averagePosition

### Description
Gets the average position between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.

### Method
GET

### Endpoint
/api/vivecraft/averagePosition

### Parameters
#### Query Parameters
- **bodyPart** (VRBodyPart) - Required - The body part to get the average position for.
- **maxTicksBack** (int) - Required - The maximum number of ticks back to calculate the position with. Must be between 0 and 200.

### Request Example
```json
{
  "query": {
    "bodyPart": "LEFT_HAND",
    "maxTicksBack": 50
  }
}
```

### Response
#### Success Response (200)
- **position** (Vector) - The average position. Returns the current position if only zero ticks can be looked back. Will be `null` if the body part requested isn't available.

#### Response Example
```json
{
  "position": {
    "x": 1.5,
    "y": -0.8,
    "z": 2.1
  }
}
```

#### Error Response (400)
- **error** (string) - Description of the error, e.g., "Invalid maxTicksBack value."
- **error** (string) - Description of the error, e.g., "Invalid bodyPart supplied."
```

--------------------------------

### Get Average Speed

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRPoseHistory

Retrieves the average speed of a specified body part over a given number of ticks.

```APIDOC
## GET /api/vivecraft/averageSpeed

### Description
Gets the average speed in blocks/tick between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.

### Method
GET

### Endpoint
/api/vivecraft/averageSpeed

### Parameters
#### Query Parameters
- **bodyPart** (VRBodyPart) - Required - The body part to get the average speed for.
- **maxTicksBack** (int) - Required - The maximum number of ticks back to calculate speed with. Must be between 0 and 200.

### Request Example
```json
{
  "query": {
    "bodyPart": "HEAD",
    "maxTicksBack": 100
  }
}
```

### Response
#### Success Response (200)
- **speed** (Vector) - The average speed on each axis. Returns zero speed if only zero ticks can be looked back, or if the body part requested isn't available.

#### Response Example
```json
{
  "speed": {
    "x": 0.1,
    "y": 0.0,
    "z": -0.05
  }
}
```

#### Error Response (400)
- **error** (string) - Description of the error, e.g., "Invalid maxTicksBack value."
- **error** (string) - Description of the error, e.g., "Invalid bodyPart supplied."
```

--------------------------------

### Get Average Position of VR Body Part (Java)

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRPoseHistory

Retrieves the average position of a specified VR body part. It averages poses within a defined maximum tick range. Returns the current position if only zero ticks are available, or null if the body part is not found. Throws IllegalArgumentException for invalid parameters.

```Java
/**
 * Gets the average position between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.
 *
 * @param bodyPart The body part to get the average position for.
 * @param maxTicksBack The maximum number of ticks back to calculate the position with.
 * @return The aforementioned average position. Note that this will return the current position if only zero ticks can be looked back. Will be `null` if the body part requested isn't available.
 * @throws IllegalArgumentException Thrown when `maxTicksBack` is outside the range [0,200] or an invalid `bodyPart` is supplied.
 * @since 1.3.0
 */
@Nullable
public Vector averagePosition(VRBodyPart bodyPart, int maxTicksBack) throws IllegalArgumentException
```

--------------------------------

### VRBodyPartData Methods

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRBodyPartData

This section details the methods available for retrieving data from a VRBodyPartData object.

```APIDOC
## VRBodyPartData

### Description
Represents the data for a body part, or a device usually tied to a body part in VR, such as the HMD or a controller.

### Methods

#### getPos

##### Description
Gets the world space position for this body part.

##### Method
GET

##### Endpoint
`/bodypart/position`

##### Response
*   **position** (Vector) - The position of this body part in Minecraft world coordinates.

##### Response Example
```json
{
  "position": {
    "x": 0.0,
    "y": 1.6,
    "z": 0.0
  }
}
```

#### getDir

##### Description
Gets the forward direction this body part is facing.

##### Method
GET

##### Endpoint
`/bodypart/direction`

##### Response
*   **direction** (Vector) - The forward direction of this body part.

##### Response Example
```json
{
  "direction": {
    "x": 0.0,
    "y": 0.0,
    "z": 1.0
  }
}
```

#### getPitch

##### Description
Gets the pitch of this body part.

##### Method
GET

##### Endpoint
`/bodypart/pitch`

##### Response
*   **pitch** (double) - The pitch of this body part in radians.

##### Response Example
```json
{
  "pitch": 0.0
}
```

#### getYaw

##### Description
Gets the yaw of this body part.

##### Method
GET

##### Endpoint
`/bodypart/yaw`

##### Response
*   **yaw** (double) - The yaw of this body part in radians.

##### Response Example
```json
{
  "yaw": 0.0
}
```

#### getRoll

##### Description
Gets the roll of this body part.

##### Method
GET

##### Endpoint
`/bodypart/roll`

##### Response
*   **roll** (double) - The roll of this body part in radians.

##### Response Example
```json
{
  "roll": 0.0
}
```

#### getRotation

##### Description
Gets the quaternion representing the rotation of this body part.

##### Method
GET

##### Endpoint
`/bodypart/rotation`

##### Response
*   **rotation** (Quaternion) - The quaternion representing the rotation of this body part.

##### Response Example
```json
{
  "rotation": {
    "x": 0.0,
    "y": 0.0,
    "z": 0.0,
    "w": 1.0
  }
}
```
```

--------------------------------

### Send Haptic Pulse (Full Control)

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/VRAPI

Sends a haptic pulse (vibration/rumble) for the specified VRBodyPart, if possible, to the given player with full control over parameters.

```APIDOC
## POST /vr/api/sendHapticPulse

### Description
Sends a haptic pulse (vibration/rumble) for the specified VRBodyPart, if possible, to the given player. This function silently fails if called for players not in VR or players who are in seated mode.

### Method
POST

### Endpoint
/vr/api/sendHapticPulse

### Parameters
#### Query Parameters
- **player** (string) - Required - Player to send the haptic pulse to.
- **bodyPart** (string) - Required - The VRBodyPart to trigger a haptic pulse on (e.g., "HEAD", "LEFT_HAND", "RIGHT_HAND").
- **duration** (float) - Required - The duration of the haptic pulse in seconds.
- **frequency** (float) - Required - The frequency of the haptic pulse in Hz. (e.g., 160.0)
- **amplitude** (float) - Required - The amplitude of the haptic pulse. Should be between 0 and 1.
- **delay** (float) - Required - An amount of time to delay until creating the haptic pulse in seconds. (e.g., 0.0)

#### Request Body
None

### Request Example
```
POST /vr/api/sendHapticPulse?player=player123&bodyPart=RIGHT_HAND&duration=0.5&frequency=160.0&amplitude=0.8&delay=0.1
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., "success", "failed_not_in_vr").

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Send Haptic Pulse (Default)

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/VRAPI

Sends a haptic pulse (vibration/rumble) at full strength with 160 Hz for the specified VRBodyPart, if possible, to the given player.

```APIDOC
## POST /vr/api/sendHapticPulse/default

### Description
Sends a haptic pulse (vibration/rumble) at full strength with 160 Hz for the specified VRBodyPart, if possible, to the given player. This function silently fails if called for players not in VR or players who are in seated mode.

### Method
POST

### Endpoint
/vr/api/sendHapticPulse/default

### Parameters
#### Query Parameters
- **player** (string) - Required - Player to send the haptic pulse to.
- **bodyPart** (string) - Required - The VRBodyPart to trigger a haptic pulse on (e.g., "HEAD", "LEFT_HAND", "RIGHT_HAND").
- **duration** (float) - Required - The duration of the haptic pulse in seconds.

#### Request Body
None

### Request Example
```
POST /vr/api/sendHapticPulse/default?player=player123&bodyPart=LEFT_HAND&duration=0.3
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., "success", "failed_not_in_vr").

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### VRPoseHistory API

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Provides methods to retrieve and manage VR pose history data.

```APIDOC
## Interface VRPoseHistory

### Description
Represents the pose history of the VR player.

### Methods

#### netMovement(VRBodyPart bodyPart, int maxTicksBack)

##### Description
Gets the net movement between the most recent VRPose in this instance and the oldest VRPose that can be retrieved, going no farther back than `maxTicksBack`.

##### Parameters
- **bodyPart** (VRBodyPart) - The VR body part to get the net movement for.
- **maxTicksBack** (int) - The maximum number of ticks to look back in history.

#### ticksOfHistory()

##### Description
Gets the number of ticks, historical data is currently available for.

##### Parameters
None
```

--------------------------------

### VRBodyPart Enum

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Represents the different tracked device roles supported by Vivecraft.

```APIDOC
## Enum Class VRBodyPart

### Description
Corresponds to the different tracked device roles that are supported by Vivecraft.

### Enum Constants
- **OFF_HAND**
- **RIGHT_ELBOW**
- **RIGHT_FOOT**
- **RIGHT_KNEE**
- **WAIST**

### Methods

#### opposite()

##### Description
Gets the VRBodyPart which is the same type but on the opposite side of the body.

##### Parameters
None

#### valueOf(String name)

##### Description
Returns the enum constant of this class with the specified name.

##### Parameters
- **name** (String) - the name of the enum constant to return

#### values()

##### Description
Returns an array containing the constants of this enum class, in the order they are declared.

##### Parameters
None
```

--------------------------------

### VRAPI Interface

Source: https://vivecraft.github.io/spigot-javadoc/allclasses-index

The main interface for interacting with Vivecraft from server-side code, providing access to VR functionalities.

```APIDOC
## VRAPI Interface

### Description
The main interface for interacting with Vivecraft from code.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### FBTMode Class

Source: https://vivecraft.github.io/spigot-javadoc/allclasses-index

Details the different modes available for full-body tracking in Vivecraft, specifying which body parts are tracked.

```APIDOC
## FBTMode Class

### Description
The mode used for full-body tracking, denoting which body parts are being tracked.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### Player VR Pose Information

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Endpoints to retrieve the current VR pose and historical VR poses for a given player.

```APIDOC
## GET /api/vr/player/{player}/pose

### Description
Retrieves the current VR pose for a specific player.

### Method
GET

### Endpoint
/api/vr/player/{player}/pose

### Parameters
#### Path Parameters
- **player** (string) - Required - The unique identifier of the player.

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **VRPose** (object) - An object containing the player's current VR pose data.

#### Response Example
```json
{
  "head": { ... },
  "mainHand": { ... },
  "offHand": { ... },
  "fbtMode": "ARMS_LEGS",
  "isLeftHanded": false,
  "isSeated": false
}
```

## GET /api/vr/player/{player}/history

### Description
Retrieves the history of VR poses for a specific player.

### Method
GET

### Endpoint
/api/vr/player/{player}/history

### Parameters
#### Path Parameters
- **player** (string) - Required - The unique identifier of the player.

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **VRPoseHistory** (object) - An object containing the player's VR pose history.

#### Response Example
```json
{
  "poses": [
    { ... },
    { ... }
  ]
}
```
```

--------------------------------

### Full-Body Tracking (FBT) Mode Information

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Endpoints related to the Full-Body Tracking (FBT) modes and their capabilities.

```APIDOC
## GET /api/vr/fbtMode/{mode}/availableBodyParts

### Description
Checks which body parts are available in a given Full-Body Tracking (FBT) mode.

### Method
GET

### Endpoint
/api/vr/fbtMode/{mode}/availableBodyParts

### Parameters
#### Path Parameters
- **mode** (string) - Required - The FBTMode to check (e.g., ARMS_LEGS, ARMS_ONLY).

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **VRBodyPart[]** (array) - An array of VRBodyPart enums available in the specified mode.

#### Response Example
```json
[
  "HEAD",
  "MAIN_HAND",
  "OFF_HAND"
]
```

## GET /api/vr/fbtMode/{mode}/bodyPart/{bodyPart}/isAvailable

### Description
Checks if a specific body part is available in a given Full-Body Tracking (FBT) mode.

### Method
GET

### Endpoint
/api/vr/fbtMode/{mode}/bodyPart/{bodyPart}/isAvailable

### Parameters
#### Path Parameters
- **mode** (string) - Required - The FBTMode to check (e.g., ARMS_LEGS).
- **bodyPart** (string) - Required - The VRBodyPart to check (e.g., HEAD).

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **boolean** - True if the body part is available in the mode, false otherwise.

#### Response Example
```json
true
```
```

--------------------------------

### FBTMode Enum

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Defines modes for Full Body Tracking (FBT) in Vivecraft.

```APIDOC
## Enum Class FBTMode

### Description
Defines modes for Full Body Tracking (FBT) in Vivecraft.

### Enum Constants
- **WITH_JOINTS** - Head, hands, waist, feet, elbow, and knee trackers are available.

### Methods

#### valueOf(String name)

##### Description
Returns the enum constant of this class with the specified name.

##### Parameters
- **name** (String) - the name of the enum constant to return

#### values()

##### Description
Returns an array containing the constants of this enum class, in the order they are declared.

##### Parameters
None
```

--------------------------------

### Vivecraft VR Body Tracking Data

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/package-summary

This section details the core data structures used by Vivecraft for VR body tracking, including tracking modes, body part definitions, and pose information.

```APIDOC
## Vivecraft VR Body Tracking Data Structures

### Description
Provides classes and interfaces for managing Full-Body Tracking (FBT) modes, defining VR body parts, and representing VR pose data and history.

### Classes and Interfaces

#### `FBTMode`

*   **Description**: Enum representing the different modes for full-body tracking, indicating which body parts are actively being tracked.
*   **Type**: Enum

#### `VRBodyPart`

*   **Description**: Represents the various tracked device roles supported by Vivecraft, corresponding to different body parts.
*   **Type**: Enum

#### `VRBodyPartData`

*   **Description**: Holds the data associated with a specific body part or VR device, such as the Head-Mounted Display (HMD) or controllers.
*   **Type**: Class

#### `VRPose`

*   **Description**: Represents the current pose (position and rotation) of the VR player.
*   **Type**: Class

#### `VRPoseHistory`

*   **Description**: Stores a history of the VR player's poses, allowing for tracking movement over time.
*   **Type**: Class

### Related Packages

*   `org.vivecraft.api`
```

--------------------------------

### VRPoseHistory Class

Source: https://vivecraft.github.io/spigot-javadoc/allclasses-index

Represents a collection of past poses for the VR player, useful for interpolation and smoothing.

```APIDOC
## VRPoseHistory Class

### Description
Represents the pose history of the VR player.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### VRAPI Haptic Feedback

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Methods for sending haptic pulses to players for specific VR body parts.

```APIDOC
## Interface VRAPI

### Description
The main interface for interacting with Vivecraft from code.

### Methods

#### sendHapticPulse(Player player, VRBodyPart bodyPart, float intensity)

##### Description
Sends a haptic pulse (vibration/rumble) at full strength with 160 Hz for the specified VRBodyPart, if possible, to the given player.

##### Parameters
- **player** (Player) - The player to send the haptic pulse to.
- **bodyPart** (VRBodyPart) - The VR body part to send the haptic pulse to.
- **intensity** (float) - The intensity of the haptic pulse.

#### sendHapticPulse(Player player, VRBodyPart bodyPart, float duration, float frequency, float amplitude, float phase)

##### Description
Sends a haptic pulse (vibration/rumble) for the specified VRBodyPart, if possible, to the given player.

##### Parameters
- **player** (Player) - The player to send the haptic pulse to.
- **bodyPart** (VRBodyPart) - The VR body part to send the haptic pulse to.
- **duration** (float) - The duration of the haptic pulse in seconds.
- **frequency** (float) - The frequency of the haptic pulse in Hz.
- **amplitude** (float) - The amplitude of the haptic pulse (0.0 to 1.0).
- **phase** (float) - The phase offset of the haptic pulse.
```

--------------------------------

### VRBodyPart Enum Class

Source: https://vivecraft.github.io/spigot-javadoc/allclasses-index

Represents the different tracked device roles supported by Vivecraft, such as HMD, controllers, and trackers.

```APIDOC
## VRBodyPart Enum Class

### Description
Corresponds to the different tracked device roles that are supported by Vivecraft.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### VRBodyPartData Class

Source: https://vivecraft.github.io/spigot-javadoc/allclasses-index

Represents the data associated with a specific body part or VR device, including its pose and tracking status.

```APIDOC
## VRBodyPartData Class

### Description
Represents the data for a body part, or a device usually tied to a body part in VR, such as the HMD or a controller.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### VRPose Class

Source: https://vivecraft.github.io/spigot-javadoc/allclasses-index

Represents the 3D pose (position and rotation) of the VR player in the game world.

```APIDOC
## VRPose Class

### Description
Represents the pose of the VR player.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Response Example
N/A
```

--------------------------------

### VRBodyPart Enum Methods

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRBodyPart

Details the methods available for the VRBodyPart enum, including checking availability in different modes, identifying body part types (foot, hand), and retrieving opposite body parts.

```java
public static VRBodyPart[] values()
Returns an array containing the constants of this enum class, in the order they are declared. 

Returns:
    an array containing the constants of this enum class, in the order they are declared
    * ### valueOf 
public static VRBodyPart valueOf(String name)
Returns the enum constant of this class with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.) 

Parameters:
    `name` - the name of the enum constant to be returned. 

Returns:
    the enum constant with the specified name 

Throws:
    `IllegalArgumentException` - if this enum class has no constant with the specified name     `NullPointerException` - if the argument is null
    * ### opposite 
public VRBodyPart opposite()
Gets the VRBodyPart which is the same type but on the opposite side of the body. VRBodyParts that don't have an opposite counterpart will return itself. 

Returns:
    the opposite VRBodyPart 

Since:
    1.3.0
    * ### availableInMode 
public boolean availableInMode(FBTMode fbtMode)
Whether this body part type is available in the provided full-body tracking mode. 

Parameters:
    `fbtMode` - The full-body tracking mode to check. 

Returns:
    Whether this body part has available data in the provided mode. 

Since:
    1.3.0
    * ### isFoot 
public boolean isFoot()
Checks if `this` VRBodyPart is a foot 

Returns:
    Whether this body part is a foot. 

Since:
    1.3.0
    * ### isHand 
public boolean isHand()
Checks if `this` VRBodyPart is a hand 

Returns:
    Whether this body part is a hand. 

Since:
    1.3.0
```

--------------------------------

### VR Body Part Type Checks

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Utility methods to check the type of a VRBodyPart enum.

```APIDOC
## GET /api/vr/bodyPart/{bodyPart}/isHand

### Description
Checks if the given VRBodyPart is a hand.

### Method
GET

### Endpoint
/api/vr/bodyPart/{bodyPart}/isHand

### Parameters
#### Path Parameters
- **bodyPart** (string) - Required - The VRBodyPart enum (e.g., MAIN_HAND).

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **boolean** - True if the body part is a hand, false otherwise.

#### Response Example
```json
true
```

## GET /api/vr/bodyPart/{bodyPart}/isFoot

### Description
Checks if the given VRBodyPart is a foot.

### Method
GET

### Endpoint
/api/vr/bodyPart/{bodyPart}/isFoot

### Parameters
#### Path Parameters
- **bodyPart** (string) - Required - The VRBodyPart enum (e.g., LEFT_FOOT).

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **boolean** - True if the body part is a foot, false otherwise.

#### Response Example
```json
true
```
```

--------------------------------

### VRBodyPart Enum Constants

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRBodyPart

Lists and describes the enum constants for VRBodyPart, representing specific tracked body parts like HEAD, MAIN_HAND, and WAIST.

```java
public static final VRBodyPart HEAD
corresponds to the player's headset, so it is at their eye position 

Since:
    1.3.0
  * ## Method Details 
    * ### values 
public static VRBodyPart[] values()
Returns an array containing the constants of this enum class, in the order they are declared. 

Returns:
    an array containing the constants of this enum class, in the order they are declared
    * ### valueOf 
public static VRBodyPart valueOf(String name)
Returns the enum constant of this class with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.) 

Parameters:
    `name` - the name of the enum constant to be returned. 

Returns:
    the enum constant with the specified name 

Throws:
    `IllegalArgumentException` - if this enum class has no constant with the specified name     `NullPointerException` - if the argument is null
    * ### opposite 
public VRBodyPart opposite()
Gets the VRBodyPart which is the same type but on the opposite side of the body. VRBodyParts that don't have an opposite counterpart will return itself. 

Returns:
    the opposite VRBodyPart 

Since:
    1.3.0
    * ### availableInMode 
public boolean availableInMode(FBTMode fbtMode)
Whether this body part type is available in the provided full-body tracking mode. 

Parameters:
    `fbtMode` - The full-body tracking mode to check. 

Returns:
    Whether this body part has available data in the provided mode. 

Since:
    1.3.0
    * ### isFoot 
public boolean isFoot()
Checks if `this` VRBodyPart is a foot 

Returns:
    Whether this body part is a foot. 

Since:
    1.3.0
    * ### isHand 
public boolean isHand()
Checks if `this` VRBodyPart is a hand 

Returns:
    Whether this body part is a hand. 

Since:
    1.3.0
```

--------------------------------

### VR Body Part Data

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Endpoints to retrieve specific VR body part data from a VRPose object.

```APIDOC
## GET /api/vr/pose/{poseId}/bodyPart/{bodyPart}

### Description
Retrieves the pose data for a specific body part from a given VR pose.

### Method
GET

### Endpoint
/api/vr/pose/{poseId}/bodyPart/{bodyPart}

### Parameters
#### Path Parameters
- **poseId** (string) - Required - The identifier of the VR pose.
- **bodyPart** (string) - Required - The VRBodyPart to retrieve data for (e.g., HEAD, MAIN_HAND, LEFT_FOOT).

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **VRBodyPartData** (object) - An object containing the pose data for the specified body part.

#### Response Example
```json
{
  "position": [x, y, z],
  "rotation": [x, y, z, w],
  "direction": [x, y, z],
  "pitch": 0.0,
  "yaw": 0.0,
  "roll": 0.0
}
```
```

--------------------------------

### Check VR Player Status

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/VRAPI

Checks whether a given player is currently in VR.

```APIDOC
## GET /vr/api/isVRPlayer

### Description
Checks whether a given player is currently in VR.

### Method
GET

### Endpoint
/vr/api/isVRPlayer

### Parameters
#### Query Parameters
- **player** (string) - Required - The unique identifier of the player.

#### Request Body
None

### Request Example
```
GET /vr/api/isVRPlayer?player=player123
```

### Response
#### Success Response (200)
- **isVR** (boolean) - true if the player is in VR, false otherwise.

#### Response Example
```json
{
  "isVR": true
}
```
```

--------------------------------

### Player VR Status

Source: https://vivecraft.github.io/spigot-javadoc/index-all

Endpoints to check if a player is currently in VR or if they are using left-handed mode.

```APIDOC
## GET /api/vr/player/{player}/isVRPlayer

### Description
Checks whether a given player is currently in VR.

### Method
GET

### Endpoint
/api/vr/player/{player}/isVRPlayer

### Parameters
#### Path Parameters
- **player** (string) - Required - The unique identifier of the player.

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **boolean** - True if the player is in VR, false otherwise.

#### Response Example
```json
true
```

## GET /api/vr/pose/{poseId}/isLeftHanded

### Description
Gets whether the player was using left-handed mode when the pose was created.

### Method
GET

### Endpoint
/api/vr/pose/{poseId}/isLeftHanded

### Parameters
#### Path Parameters
- **poseId** (string) - Required - The identifier of the VR pose.

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **boolean** - True if the player was using left-handed mode, false otherwise.

#### Response Example
```json
false
```
```

--------------------------------

### FBTMode Enum Methods: values() and valueOf()

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/FBTMode

Provides static methods to retrieve all FBTMode constants or a specific constant by its name. These are standard enum utility methods.

```java
public static FBTMode[] values() {
    // Returns an array containing the constants of this enum class, in the order they are declared.
    return $VALUES.clone();
}

public static FBTMode valueOf(String name) {
    // Returns the enum constant of this class with the specified name.
    return Enum.valueOf(FBTMode.class, name);
}
```

--------------------------------

### VRBodyPart Enum Definition

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/VRBodyPart

Defines the VRBodyPart enum, representing tracked device roles in Vivecraft. It includes constants for various body parts and methods to query their properties and availability.

```java
public enum VRBodyPart extends Enum<VRBodyPart>
Corresponds to the different tracked device roles that are supported by Vivecraft. 

Since:
    1.3.0
* * *
public enum VRBodyPart extends Enum<VRBodyPart>
Corresponds to the different tracked device roles that are supported by Vivecraft. 

Since:
    1.3.0
  * ## Nested Class Summary 
## Nested classes/interfaces inherited from class java.lang.Enum
`Enum.EnumDesc<E extends Enum<E>>`
  * ## Enum Constant Summary 
Enum Constants
Enum Constant
Description
`HEAD`
corresponds to the player's headset, so it is at their eye position
`LEFT_ELBOW`
`LEFT_FOOT`
`LEFT_KNEE`
`MAIN_HAND`
Main hand of the player, this is the hand the player points with.
`OFF_HAND`
`RIGHT_ELBOW`
`RIGHT_FOOT`
`RIGHT_KNEE`
`WAIST`
  * ## Method Summary 
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
`boolean`
`availableInMode(FBTMode fbtMode)`
Whether this body part type is available in the provided full-body tracking mode.
`boolean`
`isFoot()`
Checks if `this` VRBodyPart is a foot
`boolean`
`isHand()`
Checks if `this` VRBodyPart is a hand
`VRBodyPart`
`opposite()`
Gets the VRBodyPart which is the same type but on the opposite side of the body.
`static VRBodyPart`
`valueOf(String name)`
Returns the enum constant of this class with the specified name.
`static VRBodyPart[]`
`values()`
Returns an array containing the constants of this enum class, in the order they are declared.
### Methods inherited from class java.lang.Enum
`clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`
### Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
```

--------------------------------

### FBTMode Enum Definition and Constants

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/FBTMode

Defines the FBTMode enum for full-body tracking in Vivecraft. It includes constants representing different tracking configurations and their descriptions.

```java
public enum FBTMode extends Enum<FBTMode> {
    ARMS_LEGS("Head, hands, waist, and feet trackers are available."),
    ARMS_ONLY("Only head and hands are available."),
    WITH_JOINTS("Head, hands, waist, feet, elbow, and knee trackers are available.");

    private final String description;

    FBTMode(String description) {
        this.description = description;
    }

    public String getDescription() {
        return description;
    }
}
```

--------------------------------

### FBTMode Method: bodyPartAvailable()

Source: https://vivecraft.github.io/spigot-javadoc/org/vivecraft/api/data/FBTMode

Checks if a specific VRBodyPart is available in the current FBTMode. This method helps determine the tracking capabilities of a given mode.

```java
public boolean bodyPartAvailable(VRBodyPart bodyPart) {
    // Whether the provided body part is available in this full-body tracking mode.
    // Implementation details would depend on the specific FBTMode.
    return false; // Placeholder implementation
}
```
Tokens:
Raw