VR Interaction Framework v2.0
Loading...
Searching...
No Matches
BNG.GrappleShot Class Reference
Inheritance diagram for BNG.GrappleShot:
BNG.GrabbableEvents

Public Member Functions

override void OnTrigger (float triggerValue)
 Amount of Trigger being held down on the grabbed items controller. Only fired if object is being held.
 
override void OnGrab (Grabber grabber)
 Item has been grabbed by a Grabber.
 
override void OnRelease ()
 Has been dropped from the Grabber.
 
- Public Member Functions inherited from BNG.GrabbableEvents
virtual void OnGrab (Grabber grabber)
 Item has been grabbed by a Grabber.
 
virtual void OnRelease ()
 Has been dropped from the Grabber.
 
virtual void OnBecomesClosestGrabbable (ControllerHand touchingHand)
 Called if this is the closest grabbable but wasn't in the previous frame.
 
virtual void OnBecomesClosestGrabbable (Grabber touchingGrabber)
 Called if this is the closest grabbable but wasn't in the previous frame.
 
virtual void OnNoLongerClosestGrabbable (ControllerHand touchingHand)
 No longer closest grabbable. May need to disable highlight, ring, etc.
 
virtual void OnNoLongerClosestGrabbable (Grabber touchingGrabber)
 No longer closest grabbable. May need to disable highlight, ring, etc.
 
virtual void OnBecomesClosestRemoteGrabbable (ControllerHand touchingHand)
 Fires if this is the closest remote grabbable but wasn't in the previous frame.
 
virtual void OnBecomesClosestRemoteGrabbable (Grabber theGrabber)
 Fires if this is the closest remote grabbable but wasn't in the previous frame.
 
virtual void OnNoLongerClosestRemoteGrabbable (ControllerHand touchingHand)
 Fires if this was the closest remote grabbable last frame, but not this frame.
 
virtual void OnNoLongerClosestRemoteGrabbable (Grabber theGrabber)
 Fires if this was the closest remote grabbable last frame, but not this frame.
 
virtual void OnGrip (float gripValue)
 Amount of Grip (0-1). Only fired if object is being held.
 
virtual void OnTrigger (float triggerValue)
 Amount of Trigger being held down on the grabbed items controller. Only fired if object is being held.
 
virtual void OnTriggerDown ()
 Fires if trigger was pressed down on this controller this frame, but was not pressed last frame. Only fired if object is being held.
 
virtual void OnTriggerUp ()
 Fires if Trigger is not held down this frame.
 
virtual void OnButton1 ()
 Button 1 is being held down this frame but not last Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
virtual void OnButton1Down ()
 Button 1 Pressed down this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
virtual void OnButton1Up ()
 Button 1 Released this frame Oculus : Button 1 = "A" if held in Right controller."X" if held in Left Controller.
 
virtual void OnButton2 ()
 Button 2 is being held down this frame but not last Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
virtual void OnButton2Down ()
 Button 2 Pressed down this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
virtual void OnButton2Up ()
 Button 2 Released this frame Oculus : Button 2 = "B" if held in Right controller."Y" if held in Left Controller.
 
virtual void OnSnapZoneEnter ()
 Grabbable has been successfully inserted into a SnapZone.
 
virtual void OnSnapZoneExit ()
 Grabbable has been removed from a SnapZone.
 

Public Attributes

float MaxRange = 100f
 
float GrappleReelForce = 0.5f
 
float MinReelDistance = 0.25f
 
float GrappleForce = 3f
 
ForceMode GrappleForceMode = ForceMode.Acceleration
 
LayerMask GrappleLayers
 
Transform MuzzleTransform
 
Transform HitTargetPrefab
 
LineRenderer GrappleLine
 
LineRenderer HelperLine
 
AudioClip GrappleShotSound
 
float currentGrappleDistance = 0
 
Climbable ClimbHelper
 

Additional Inherited Members

- Protected Member Functions inherited from BNG.GrabbableEvents
virtual void Awake ()
 
- Protected Attributes inherited from BNG.GrabbableEvents
Grabbable grab
 
Grabber thisGrabber
 
InputBridge input
 

Member Function Documentation

◆ OnGrab()

override void BNG.GrappleShot.OnGrab ( Grabber  grabber)
virtual

Item has been grabbed by a Grabber.

Parameters
grabber

Reimplemented from BNG.GrabbableEvents.

◆ OnRelease()

override void BNG.GrappleShot.OnRelease ( )
virtual

Has been dropped from the Grabber.

Reimplemented from BNG.GrabbableEvents.

◆ OnTrigger()

override void BNG.GrappleShot.OnTrigger ( float  triggerValue)
virtual

Amount of Trigger being held down on the grabbed items controller. Only fired if object is being held.

Parameters
triggerValue0 - 1 Open / Closed

Reimplemented from BNG.GrabbableEvents.

Member Data Documentation

◆ ClimbHelper

Climbable BNG.GrappleShot.ClimbHelper

◆ currentGrappleDistance

float BNG.GrappleShot.currentGrappleDistance = 0

◆ GrappleForce

float BNG.GrappleShot.GrappleForce = 3f

◆ GrappleForceMode

ForceMode BNG.GrappleShot.GrappleForceMode = ForceMode.Acceleration

◆ GrappleLayers

LayerMask BNG.GrappleShot.GrappleLayers

◆ GrappleLine

LineRenderer BNG.GrappleShot.GrappleLine

◆ GrappleReelForce

float BNG.GrappleShot.GrappleReelForce = 0.5f

◆ GrappleShotSound

AudioClip BNG.GrappleShot.GrappleShotSound

◆ HelperLine

LineRenderer BNG.GrappleShot.HelperLine

◆ HitTargetPrefab

Transform BNG.GrappleShot.HitTargetPrefab

◆ MaxRange

float BNG.GrappleShot.MaxRange = 100f

◆ MinReelDistance

float BNG.GrappleShot.MinReelDistance = 0.25f

◆ MuzzleTransform

Transform BNG.GrappleShot.MuzzleTransform

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