Complete ROCK API index
ROCK exposes 13 independently versioned interface families through ROCKAPI_QueryInterfaceV1. Every family is currently major 1. The base-contract map below follows each named header; compatible extensions are listed separately. Weapon 1.1 adds four calls, Grab 1.1 adds three, and Input 1.1 adds one, each retaining its released 1.0 header and table prefix. The earlier migration from the monolithic provider is separate from this compatible addition. See the migration guide.
Base-contract map
| ID | Interface | Version | Public header | CMake target | Calls |
|---|---|---|---|---|---|
| 1 | Core | 1.0 | ROCK/Core.h | RPS::ROCKCore | 12 |
| 2 | Hands | 1.1 | ROCK/Hands.h | RPS::ROCKHands | 6 |
| 3 | Collision | 1.0 | ROCK/Collision.h | RPS::ROCKCollision | 12 |
| 4 | Grab | 1.0 | ROCK/Grab.h | RPS::ROCKGrab | 17 |
| 5 | Touch | 1.0 | ROCK/Touch.h | RPS::ROCKTouch | 6 |
| 6 | Weapon | 1.0 | ROCK/Weapon.h | RPS::ROCKWeapon | 16 |
| 7 | WeaponParts | 1.1 | ROCK/WeaponParts.h | RPS::ROCKWeaponParts | 18 |
| 8 | Animation | 1.0 | ROCK/Animation.h | RPS::ROCKAnimation | 9 |
| 9 | Input | 1.0 | ROCK/Input.h | RPS::ROCKInput | 10 |
| 10 | References | 1.0 | ROCK/References.h | RPS::ROCKReferences | 3 |
| 11 | PlayerController | 1.0 | ROCK/PlayerController.h | RPS::ROCKPlayerController | 3 |
| 12 | Diagnostics | 1.0 | ROCK/Diagnostics.h | RPS::ROCKDiagnostics | 6 |
| 13 | Configuration | 1.0 | ROCK/Configuration.h | RPS::ROCKConfiguration | 3 |
Each family reference includes every table member and the complete public declarations. Shared types and results covers the common vocabulary. A repeated name such as getSample belongs to each table separately; there is no global slot numbering or global capability mask.
Compatible 1.1 extensions
The base contracts list 121 calls. The three extensions append eight calls, for 129 covered calls. Each preserves its original 1.0 prefix and Core 1.0 requirement. Negotiate exact major 1, minimum minor 1 and the extended table size.
Weapon inventory equip captures and draws an exact inventory stack. Grab held placement observes held objects and submits/cancels a one-update placement intent. Input placement reservation lets other consumers yield the complete placement click.
| Provider | Minimum minor | Header and type | Appended calls | Total table calls |
|---|---|---|---|---|
| Weapon | 1.1 | ROCK/WeaponV1_1.h, weapon::v1_1::Api | 4 | 20 |
| Grab | 1.1 | ROCK/GrabV1_1.h, grab::v1_1::Api | 3 | 20 |
| Input | 1.1 | ROCK/InputV1_1.h, input::v1_1::Api | 1 | 11 |
Callable index
Core
getModVersion, isProviderReady, getFrameSnapshot, registerConsumerV1, unregisterConsumerV1, registerAnimationPhaseCallbackV1, unregisterAnimationPhaseCallbackV1, registerFrameCallbackForOwnerV1, unregisterFrameCallbackForOwnerV1, getSample, bindInterface, copyEvents.
Hands
getHandFrameV1, getPresentedHandFrameV1, getPresentedHandPoseV1, getSample, getHeadPose, getRoles.
Collision
clearExternalBodies, getBodyContactSnapshotV1, registerExternalBodiesForScopeV1, clearExternalBodiesForScopeV1, copyExternalContactsSinceV1, copySemanticHandContactsV1, copyPlayerColliderDescriptorsV1, getHandCollisionAvailabilityV1, queryWorldRaycastV1, getSample, getEnvironment, copyEvents.
Grab
requestForceGrabV1, getInteractionCommandResultV1, requestForceReleaseV1, requestThrownDropV1, getHandInteractionStateV1, cancelInteractionCommandV1, acquireOffhandReservationV1, renewOffhandReservationV1, releaseOffhandReservationV1, getOffhandReservationStateV1, getHandTargetDetailsV1, requestPowerArmorGrabV1, getSample, requestInventoryGrab, copyEvents, setEventCallback, clearEventCallback.
Grab 1.1 appends getHeldPlacementState, submitHeldPlacementIntent and
clearHeldPlacementIntent. Placement contract and signatures.
Touch
setTouchGrabTargetsForScopeV1, clearTouchGrabTargetsForScopeV1, copyTouchGrabStatesForScopeV1, requestTouchGrabYieldV1, getSample, copyEvents.
Weapon
getPrimaryHandV1, getOffhandHandV1, queryEquippedWeaponClassificationV1, getWeaponEmitterCountV1, copyWeaponEmittersV1, getEquippedWeaponGripStateV1, setEquippedWeaponHandlingAuthorityV1, clearEquippedWeaponHandlingAuthorityV1, getEquippedWeaponHandlingStateV1, getEquippedWeaponStateV1, getScopeSightStateV1, getWeaponCompositionStateV1, copyWeaponCompositionEntriesV1, getSelectedAuthoredGripPoseV1, getSample, copyEvents.
WeaponParts
queryWeaponContactAtPoint, getWeaponEvidenceDetailCountV1, copyWeaponEvidenceDetailsV1, getWeaponEvidenceDetailPointCountV1, copyWeaponEvidenceDetailPointsV1, setWeaponPartTargetsV1, clearWeaponPartTargetsV1, setWeaponPartDriveTargetsV1, clearWeaponPartDriveTargetsV1, getWeaponPartGripStateV1, queryWeaponPartTargetResolutionV1, copyWeaponPartPoseSnapshotV1, copyWeaponPartDriveApplicationResultsV1, getSample, copySources, copyEvents, querySourcePose, querySourcePath.
Animation
setNativeAnimationAuthorityV1, clearNativeAnimationAuthorityV1, getNativeAnimationAuthorityStateV1, setHandVisualAuthorityV1, clearHandVisualAuthorityV1, publishNativeAnimationRuntimeV1, clearNativeAnimationRuntimeV1, getSample, copyEvents.
Input
setHandInputSuppressionV1, clearHandInputSuppressionV1, getRawWandButtonStateV1, isNativePipboyInputSuppressedV1, getHandInputSuppressionStateV1, getLogicalInputActionStateV1, getRawWandThumbstickV1, getNativeInputContextV1, getSample, copyEvents.
Input 1.1 appends getPlacementClickState.
Reservation contract and signature.
References
queryReferenceInteractionV1, queryPowerArmorTargetV1, getSample.
PlayerController
getPlayerControllerStateV1, requestPlayerControllerJumpV1, getSample.
Diagnostics
publishDebugOverlayV1, clearDebugOverlayV1, setColliderVisualizationOverrideV1, clearColliderVisualizationOverrideV1, getSample, copyEvents.
Configuration
revision, visit, setValue.