Index
All Classes and Interfaces|All Packages
A
- ACTION_COMPLETE - Enum constant in enum class org.vivecraft.api.client.data.CloseKeyboardContext
-
Will close the keyboard if the user has configured to close the keyboard when an action has been completed.
- activeProcess(LocalPlayer) - Method in interface org.vivecraft.api.client.Tracker
-
Called for the local player if this tracker is active, which is when
Tracker.isActive(LocalPlayer)
returns true. - addClientRegistrationHandler(Consumer<VivecraftClientRegistrationEvent>) - Method in interface org.vivecraft.api.client.VRClientAPI
-
Registers a handler, which consumes a
VivecraftClientRegistrationEvent
. - ARMS_LEGS - Enum constant in enum class org.vivecraft.api.data.FBTMode
-
Head, hands, waist, and feet trackers are available.
- ARMS_ONLY - Enum constant in enum class org.vivecraft.api.data.FBTMode
-
Only head and hands are available.
- availableInMode(FBTMode) - Method in enum class org.vivecraft.api.data.VRBodyPart
-
Whether this body part type is available in the provided full-body tracking mode.
- averagePosition(VRBodyPart, int) - Method in interface org.vivecraft.api.data.VRPoseHistory
-
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
. - averageSpeed(VRBodyPart, int) - Method in interface org.vivecraft.api.data.VRPoseHistory
-
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
. - averageVelocity(VRBodyPart, int) - Method in interface org.vivecraft.api.data.VRPoseHistory
-
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
.
B
- bodyPartAvailable(VRBodyPart) - Method in enum class org.vivecraft.api.data.FBTMode
-
Whether the provided body part is available in this full-body tracking mode.
C
- CAMERA - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the level from the view of the placeable Screenshot Camera
- CENTER - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the level from the view of the First-Person Mirror
- closeKeyboard(CloseKeyboardContext) - Method in interface org.vivecraft.api.client.VRClientAPI
-
Closes Vivecraft's keyboard, doing nothing if the keyboard is already opened or the provided
closeKeyboardContext
doesn't result in the keyboard closing. - CloseKeyboardContext - Enum Class in org.vivecraft.api.client.data
-
Determines how strict the closing of the VR keyboard should be
F
- FBTMode - Enum Class in org.vivecraft.api.data
-
The mode used for full-body tracking, denoting which body parts are being tracked.
- FOCUS - Enum constant in enum class org.vivecraft.api.client.data.OpenKeyboardContext
-
Only opens the keyboard if the user has configured to open the keyboard when a text box becomes focused.
- FOCUS_CHAT - Enum constant in enum class org.vivecraft.api.client.data.OpenKeyboardContext
-
Only opens the keyboard if the user has configured to open the keyboard when a text box or chat becomes focused.
- FORCE - Enum constant in enum class org.vivecraft.api.client.data.CloseKeyboardContext
-
Will close the keyboard no matter the situation.
- FORCE - Enum constant in enum class org.vivecraft.api.client.data.OpenKeyboardContext
-
Will open the keyboard no matter the situation.
- fromInteractionHand(InteractionHand) - Static method in enum class org.vivecraft.api.data.VRBodyPart
-
Gets the corresponding VRBodyPart to the provided InteractionHand
G
- getAllHistoricalData() - Method in interface org.vivecraft.api.data.VRPoseHistory
-
Gets a raw list of
VRPose
instances, with index 0 representing the current tick's pose, 1 representing last tick's pose, etc. - getBodyPartData(VRBodyPart) - Method in interface org.vivecraft.api.data.VRPose
-
Gets the pose data for a body part.
- getCurrentRenderPass() - Method in interface org.vivecraft.api.client.VRRenderingAPI
-
Gets the current render pass.
- getDir() - Method in interface org.vivecraft.api.data.VRBodyPartData
-
Gets the forward direction this body part is facing.
- getFBTMode() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Gets the mode used for full-body tracking for the local player.
- getFBTMode() - Method in interface org.vivecraft.api.data.VRPose
-
Gets the full-body tracking mode the player was using when the pose was created.
- getHand(InteractionHand) - Method in interface org.vivecraft.api.data.VRPose
-
Gets the body part data for a given hand.
- getHandRenderPos(InteractionHand) - Method in interface org.vivecraft.api.client.VRRenderingAPI
-
Gets the position that the provided
InteractionHand
renders at. - getHead() - Method in interface org.vivecraft.api.data.VRPose
-
Gets the body part pose data for the head.
- getHistoricalData(int) - Method in interface org.vivecraft.api.data.VRPoseHistory
-
Gets the pose from
ticksBack
ticks back, ornull
if such data isn't available. - getHistoricalVRPoses() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Returns the history of VR poses for the local player.
- getHistoricalVRPoses(Player) - Method in interface org.vivecraft.api.VRAPI
-
Returns the history of VR poses for the player.
- getId() - Method in interface org.vivecraft.api.client.InteractModule
-
The ID of this module.
- getLatestRoomPose() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Gets the VR pose representing the player in the room after the most recent poll of VR hardware.
- getMainHand() - Method in interface org.vivecraft.api.data.VRPose
-
Gets the body part data for the main-hand.
- getOffHand() - Method in interface org.vivecraft.api.data.VRPose
-
Gets the body part data for the off-hand.
- getPitch() - Method in interface org.vivecraft.api.data.VRBodyPartData
-
Gets the pitch of this body part.
- getPos() - Method in interface org.vivecraft.api.data.VRBodyPartData
-
Gets the world space position for this body part.
- getPostTickRoomPose() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Gets the VR pose representing the player in the room after the game tick.
- getPostTickWorldPose() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Gets the VR pose representing the player in Minecraft world coordinates after the game tick.
- getPreTickWorldPose() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Gets the VR pose representing the player in Minecraft world coordinates before the game tick.
- getPriority() - Method in interface org.vivecraft.api.client.InteractModule
-
The priority value of a module determines when its
InteractModule.isActive(net.minecraft.client.player.LocalPlayer, net.minecraft.world.InteractionHand, net.minecraft.world.phys.Vec3)
method is called compared to other modules. - getRoll() - Method in interface org.vivecraft.api.data.VRBodyPartData
-
Gets the roll of this body part.
- getRotation() - Method in interface org.vivecraft.api.data.VRBodyPartData
-
Gets the quaternion representing the rotation of this body part.
- getVRPose(Player) - Method in interface org.vivecraft.api.VRAPI
-
Returns the VR pose for the given player.
- getWorldRenderPose() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Gets the VR pose representing the player in Minecraft world coordinates interpolated for rendering.
- getWorldScale() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Get the currently active world scale.
- getYaw() - Method in interface org.vivecraft.api.data.VRBodyPartData
-
Gets the yaw of this body part.
- GUI - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the Gui/Hud to a RenderTarget to be rendered in the world in other passes.
H
- HEAD - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
-
corresponds to the player's headset, so it is at their eye position
- HeldInteractModule - Interface in org.vivecraft.api.client
-
Compared to a regular
InteractModule
, a HeldInteractModule blocks other modules from using the Interact keybind until it is released/not used anymore.
I
- idleProcess(LocalPlayer) - Method in interface org.vivecraft.api.client.Tracker
-
Called for the local player, whether the tracker is active or not.
- inactiveProcess(LocalPlayer) - Method in interface org.vivecraft.api.client.Tracker
-
Called to reset this tracker's state.
- instance() - Static method in interface org.vivecraft.api.client.VRClientAPI
-
Gets the API instance for interacting with Vivecraft from the client-side, for interactions not related to rendering.
- instance() - Static method in interface org.vivecraft.api.client.VRRenderingAPI
-
Gets the API instance for interacting with Vivecraft for rendering.
- instance() - Static method in interface org.vivecraft.api.server.VRServerAPI
-
Gets API instance for interacting with Vivecraft's server API
- instance() - Static method in interface org.vivecraft.api.VRAPI
-
Gets API instance for interacting with Vivecraft's common API
- InteractModule - Interface in org.vivecraft.api.client
-
An InteractModule can influence what happens when the user presses the Interact keybind.
- isActive(LocalPlayer) - Method in interface org.vivecraft.api.client.Tracker
-
Whether the tracker is active for the local player.
- isActive(LocalPlayer, InteractionHand, Vec3) - Method in interface org.vivecraft.api.client.InteractModule
-
This is used to check if the user can use the Interact keybind on the given
hand
to interact with the module. - isFirstPerson(RenderPass) - Static method in enum class org.vivecraft.api.client.data.RenderPass
-
Returns whether the provided RenderPass is rendered from the player's perspective.
- isFirstRenderPass() - Method in interface org.vivecraft.api.client.VRRenderingAPI
-
Returns if the current render pass is the first render pass for this render cycle.
- isFoot() - Method in enum class org.vivecraft.api.data.VRBodyPart
-
Checks if
this
VRBodyPart is a foot - isHand() - Method in enum class org.vivecraft.api.data.VRBodyPart
-
Checks if
this
VRBodyPart is a hand - isLeftHanded() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Get whether the local player is currently configured to use left-handed mode when in VR.
- isLeftHanded() - Method in interface org.vivecraft.api.data.VRPose
-
Gets whether the player was using left-handed mode when the pose was created.
- isSeated() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Get whether the local player is currently configured to be in seated mode when in VR.
- isSeated() - Method in interface org.vivecraft.api.data.VRPose
-
Gets whether the player was in seated mode when the pose was created.
- isThirdPerson(RenderPass) - Static method in enum class org.vivecraft.api.client.data.RenderPass
-
Returns whether the provided RenderPass is rendered from a third-person perspective.
- isVanillaRenderPass() - Method in interface org.vivecraft.api.client.VRRenderingAPI
-
Gets whether the current render pass is a vanilla render pass.
- isVRActive() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Get whether the client is actively in VR.
- isVRInitialized() - Method in interface org.vivecraft.api.client.VRClientAPI
-
Get whether VR support is currently initialized.
- isVRPlayer(Player) - Method in interface org.vivecraft.api.VRAPI
-
Check whether a given player is currently in VR.
- itemInUse(LocalPlayer) - Method in interface org.vivecraft.api.client.ItemInUseTracker
-
Called for the client player, to check if this tracker is currently causing the item to be used to not release the use key.
- ItemInUseTracker - Interface in org.vivecraft.api.client
-
A type of
Tracker
which can prevent the vanilla use key from being released, withItemInUseTracker.itemInUse(LocalPlayer)
.
L
- LEFT - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the level from the view of the Left eye
- LEFT_ELBOW - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
- LEFT_FOOT - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
- LEFT_KNEE - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
M
- MAIN_HAND - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
-
Main hand of the player, this is the hand the player points with.
- MIRROR - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Blits the mirror to the desktop screen
N
- netMovement(VRBodyPart, int) - Method in interface org.vivecraft.api.data.VRPoseHistory
-
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
.
O
- OFF_HAND - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
- onHoldTick(LocalPlayer, InteractionHand) - Method in interface org.vivecraft.api.client.HeldInteractModule
-
Called on tick while this module is active and the Interact keybind is still pressed.
- onPress(LocalPlayer, InteractionHand) - Method in interface org.vivecraft.api.client.InteractModule
-
Use this to do an action when the Interact keybind is being pressed.
- onRelease(LocalPlayer, InteractionHand) - Method in interface org.vivecraft.api.client.HeldInteractModule
-
Counterpart to
InteractModule.onPress(net.minecraft.client.player.LocalPlayer, net.minecraft.world.InteractionHand)
This is called when the module was active, and the Interact keybind released orHeldInteractModule.onHoldTick(net.minecraft.client.player.LocalPlayer, net.minecraft.world.InteractionHand)
returnedfalse
. - openKeyboard(OpenKeyboardContext) - Method in interface org.vivecraft.api.client.VRClientAPI
-
Opens Vivecraft's keyboard, doing nothing if the keyboard is already opened or the provided
openKeyboardContext
doesn't result in the keyboard opening. - OpenKeyboardContext - Enum Class in org.vivecraft.api.client.data
-
Determines how strict the opening of the VR keyboard should be
- opposite() - Method in enum class org.vivecraft.api.data.VRBodyPart
-
Gets the VRBodyPart which is the same type but on the opposite side of the body.
- org.vivecraft.api - package org.vivecraft.api
- org.vivecraft.api.client - package org.vivecraft.api.client
- org.vivecraft.api.client.data - package org.vivecraft.api.client.data
- org.vivecraft.api.client.event - package org.vivecraft.api.client.event
- org.vivecraft.api.data - package org.vivecraft.api.data
- org.vivecraft.api.server - package org.vivecraft.api.server
P
- PER_FRAME - Enum constant in enum class org.vivecraft.api.client.Tracker.ProcessType
-
processed every frame, before rendering starts
- PER_TICK - Enum constant in enum class org.vivecraft.api.client.Tracker.ProcessType
-
processed every tick, during the local player tick
- processType() - Method in interface org.vivecraft.api.client.Tracker
-
The process type for this tracker.
R
- registerInteractModules(InteractModule...) - Method in interface org.vivecraft.api.client.event.VivecraftClientRegistrationEvent
-
Registers the given interact modules to the list of all interact modules to be run for the local player.
- registerTrackers(Tracker...) - Method in interface org.vivecraft.api.client.event.VivecraftClientRegistrationEvent
-
Registers the given trackers to the list of all trackers to be run for the local player.
- RenderPass - Enum Class in org.vivecraft.api.client.data
-
A pass used to render things.
- renderPlayer(RenderPass) - Static method in enum class org.vivecraft.api.client.data.RenderPass
-
Returns whether the RenderPass is supposed to render the player model.
- reset(LocalPlayer, InteractionHand) - Method in interface org.vivecraft.api.client.InteractModule
-
Used to reset the module state for the given hand, this is called when the Interact Tracker is not active anymore, and before
InteractModule.isActive(net.minecraft.client.player.LocalPlayer, net.minecraft.world.InteractionHand, net.minecraft.world.phys.Vec3)
is called - RIGHT - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the level from the view of the Right eye
- RIGHT_ELBOW - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
- RIGHT_FOOT - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
- RIGHT_KNEE - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
S
- SCOPEL - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the level from the view of the Spyglass, when held in the off-hand
- SCOPER - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the level from the view of the Spyglass, when held in the main-hand
- sendHapticPulse(ServerPlayer, VRBodyPart, float) - Method in interface org.vivecraft.api.server.VRServerAPI
-
Sends a haptic pulse (vibration/rumble) at full strength with 160 Hz for the specified VRBodyPart, if possible, to the given player.
- sendHapticPulse(ServerPlayer, VRBodyPart, float, float, float, float) - Method in interface org.vivecraft.api.server.VRServerAPI
-
Sends a haptic pulse (vibration/rumble) for the specified VRBodyPart, if possible, to the given player.
- setupRenderingAtHand(InteractionHand, PoseStack) - Method in interface org.vivecraft.api.client.VRRenderingAPI
-
Sets the provided
PoseStack
to render at the position of and with the rotation of the providedInteractionHand
, this assumes the givenstack
to be set to an identity. - setupRenderingAtHand(InteractionHand, Matrix4f) - Method in interface org.vivecraft.api.client.VRRenderingAPI
-
Sets the provided
Matrix4f
to render at the position of and with the rotation of the providedInteractionHand
, this assumes the givenmatrix
to be an identity. - swingsArm() - Method in interface org.vivecraft.api.client.InteractModule
-
By default, an interaction causes an armswing, to give the player a visual indicator that the action was successful.
T
- THIRD - Enum constant in enum class org.vivecraft.api.client.data.RenderPass
-
Renders the level from the view of the Third-Person Mirror
- ticksOfHistory() - Method in interface org.vivecraft.api.data.VRPoseHistory
-
Gets the number of ticks, historical data is currently available for.
- Tracker - Interface in org.vivecraft.api.client
-
A tracker is an object that is run for the local player during the game tick or before rendering a frame only if they are in VR.
- Tracker.ProcessType - Enum Class in org.vivecraft.api.client
-
The process type used for processing trackers.
- triggerHapticPulse(VRBodyPart, float) - Method in interface org.vivecraft.api.client.VRClientAPI
-
Causes a haptic pulse (vibration/rumble) at full strength with 160 Hz for the specified VRBodyPart, if possible.
- triggerHapticPulse(VRBodyPart, float, float, float, float) - Method in interface org.vivecraft.api.client.VRClientAPI
-
Causes a haptic pulse (vibration/rumble) for the specified VRBodyPart, if possible.
V
- valueOf(String) - Static method in enum class org.vivecraft.api.client.data.CloseKeyboardContext
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.vivecraft.api.client.data.OpenKeyboardContext
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.vivecraft.api.client.data.RenderPass
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.vivecraft.api.client.Tracker.ProcessType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.vivecraft.api.data.FBTMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.vivecraft.api.data.VRBodyPart
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.vivecraft.api.client.data.CloseKeyboardContext
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.vivecraft.api.client.data.OpenKeyboardContext
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.vivecraft.api.client.data.RenderPass
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.vivecraft.api.client.Tracker.ProcessType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.vivecraft.api.data.FBTMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.vivecraft.api.data.VRBodyPart
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VivecraftClientRegistrationEvent - Interface in org.vivecraft.api.client.event
-
The event that is fired on the client for registering trackers and interact modules with Vivecraft.
- VRAPI - Interface in org.vivecraft.api
-
The main interface for interacting with Vivecraft from common code.
- VRBodyPart - Enum Class in org.vivecraft.api.data
-
Corresponds to the different tracked device roles that are supported by Vivecraft.
- VRBodyPartData - Interface in org.vivecraft.api.data
-
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.
- VRClientAPI - Interface in org.vivecraft.api.client
-
The main interface for interacting with the local player using Vivecraft from client code.
- VRPose - Interface in org.vivecraft.api.data
-
Represents the pose of the VR player.
- VRPoseHistory - Interface in org.vivecraft.api.data
-
Represents the pose history of the VR player.
- VRRenderingAPI - Interface in org.vivecraft.api.client
-
The main interface for interacting with Vivecraft from rendering code.
- VRServerAPI - Interface in org.vivecraft.api.server
-
The main interface for interacting with Vivecraft from server code.
W
- WAIST - Enum constant in enum class org.vivecraft.api.data.VRBodyPart
- WITH_JOINTS - Enum constant in enum class org.vivecraft.api.data.FBTMode
-
Head, hands, waist, feet, elbow, and knee trackers are available.
All Classes and Interfaces|All Packages