VR Interaction Framework  1.0
A vr framework for the Oculus Quest
BNG.Climbable Class Reference

Allows the Player to climb objects by Grabbing them More...

Inheritance diagram for BNG.Climbable:
BNG.Grabbable

Public Member Functions

override void GrabItem (Grabber grabbedBy)
 
override void DropItem ()
 
- Public Member Functions inherited from BNG.Grabbable
void AddValidGrabber (Grabber grabber)
 
void RemoveValidGrabber (Grabber grabber)
 
virtual void GrabRemoteItem (Grabber grabbedBy)
 
void ResetGrabbing ()
 
virtual void DropItem (bool resetVelocity, bool resetParent)
 
ControllerHand GetControllerHand ()
 
Grabber GetGrabber ()
 
virtual bool IsValidCollision (Collision collision)
 

Additional Inherited Members

- Public Attributes inherited from BNG.Grabbable
bool BeingHeld = false
 
bool RemoteGrabbable = false
 Can the object be picked up from far away. More...
 
float RemoteGrabDistance = 2f
 
GrabButton GrabButton = GrabButton.Grip
 Configure which button is used to initiate the grab More...
 
HoldType Grabtype = HoldType.HoldDown
 Should the Grab Button be held down, or can it be toggle on and off More...
 
GrabPhysics GrabPhysics = GrabPhysics.PhysicsJoint
 Kinematic Physics locks the object in place on the hand / grabber. More...
 
GrabType GrabMechanic = GrabType.Snap
 Snap to a location or grab anywhere on the object More...
 
float GrabSpeed = 7.5f
 How fast to Lerp the object to the hand More...
 
float ThrowForceMultiplier = 2f
 Multiply controller's velocity times this when throwing More...
 
float ThrowForceMultiplierAngular = 1.5f
 Multiply controller's angular velocity times this when throwing More...
 
bool HideHandGraphics = false
 Enabling this will hide the Transform specified in the Grabber's HandGraphics property More...
 
bool ParentToHands = true
 Parent this object to the hands for better stability. More...
 
bool ParentHandModel = false
 If true, the hand model will be attached to the grabbed object More...
 
Grabbable OtherGrabbableMustBeGrabbed = null
 The Grabbable can only be grabbed if this grabbable is being held. More...
 
float CollisionSpring = 3000
 How much Spring Force to apply to the joint when something comes in contact with the grabbable A higher Spring Force will make the Grabbable more rigid More...
 
float CollisionSlerp = 500
 How much Slerp Force to apply to the joint when something is in contact with the grabbable A higher Slerp value More...
 
Vector3 GrabPositionOffset = Vector3.zero
 If GrabMechanic is set to Snap, offset local position by this amount More...
 
Vector3 GrabRotationOffset = Vector3.zero
 If GrabMechanic is set to Snap, offset local rotation by this amount More...
 
bool MirrorOffsetForOtherHand = true
 
- Protected Attributes inherited from BNG.Grabbable
Grabber heldBy
 The grabber that is currently holding us. More...
 
float grabTime
 
InputBridge input
 
GrabbableEvents events
 
- Properties inherited from BNG.Grabbable
bool IsGrabbable [get]
 
Transform grabTransform [get]
 

Detailed Description

Allows the Player to climb objects by Grabbing them

Member Function Documentation

◆ DropItem()

override void BNG.Climbable.DropItem ( )
virtual

Reimplemented from BNG.Grabbable.

◆ GrabItem()

override void BNG.Climbable.GrabItem ( Grabber  grabbedBy)
virtual

Reimplemented from BNG.Grabbable.


The documentation for this class was generated from the following file: