-
-
Notifications
You must be signed in to change notification settings - Fork 59
Mod API VRClientAPI
fayer3 edited this page Jul 3, 2025
·
1 revision
You can find the full javadoc for the VRClientAPI here.
Allows to interact with the local main player side of Vivecraft:
- Check VR states with
isVRInitialized
andisVRActive
. - register Trackers/Modules for the Local Player with
addClientRegistrationHandler
. - get the players device/body part data in different spaces:
- positions relative to the players room can be received with:
-
getLatestRoomPose
: gets the most up to date poses, updated every frame. -
getPostTickRoomPose
: gets the poses from the last tick, updated every game tick.
-
- positions relative to the world can be received with:
-
getPreTickWorldPose
: gets the poses from the last tick, updated before every game tick. -
getPostTickWorldPose
: gets the poses from the last tick, updated after every game tick. -
getWorldRenderPose
: gets the most up to date poses, updated every frame.
-
- positions relative to the players room can be received with:
- get world poses of previous ticks with
getHistoricalVRPoses
, this has built in methods to get the speed and movement direction of body parts. - trigger haptics with
triggerHapticPulse
- get some information about the players setup, with:
-
isSeated
: If the player plays without controllers, and instead with mouse and keyboard. -
isLeftHanded
: If the player uses the left hand as the dominant hand. -
getFBTMode
: If the player has any Full Body Trackers available. -
getWorldScale
: If the player has scaled the world to be smaller or bigger.
-
- show hide the VR keyboard with:
-
openKeyboard
: show the keyboard,respecting the players preferences for when it should show, by providing the rightOpenKeyboardContext
for your situation. -
closeKeyboard
: closes the keyboard,respecting the players preferences for when it should close, by providing the rightCloseKeyboardContext
for your situation.
-