VRC SDK
This project aims to completely document the VRChat Unity SDK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Properties | Private Member Functions | List of all members
VRC.SDKBase.VRC_Pickup Class Reference
Inheritance diagram for VRC.SDKBase.VRC_Pickup:
Inheritance graph
[legend]
Collaboration diagram for VRC.SDKBase.VRC_Pickup:
Collaboration graph
[legend]

Public Types

enum  PickupOrientation : Enum
 
enum  AutoHoldMode : Enum
 
enum  PickupHand : Enum
 

Public Member Functions

delegate void AwakeDelegate (VRC_Pickup obj)
 
delegate void ForceDropDelegate (VRC_Pickup obj)
 
delegate void OnDestroyedDelegate (VRC_Pickup obj)
 
delegate void HapticEventDelegate (VRC_Pickup obj, float duration, float amplitude, float frequency)
 
void Drop ()
 
void Drop (VRCPlayerApi instigator)
 
void GenerateHapticEvent (float duration=0.25f, float amplitude=0.5f, float frequency=0.5f)
 
void PlayHaptics ()
 
IEnumerable< VRC_EventHandler.VrcEvent > ProvideEvents ()
 
IEnumerable< VRC_EventHandler.VrcEvent > ProvideEvents ()
 

Public Attributes

ForceMode MomentumTransferMethod
 
bool DisallowTheft
 
Transform ExactGun
 
Transform ExactGrip
 
bool allowManipulationWhenEquipped
 
PickupOrientation orientation
 
AutoHoldMode AutoHold
 
string InteractionText = ""
 
string UseText = "Use"
 
VRC_EventHandler.VrcBroadcastType useEventBroadcastType
 
string UseDownEventName
 
string UseUpEventName
 
VRC_EventHandler.VrcBroadcastType pickupDropEventBroadcastType
 
string PickupEventName
 
string DropEventName
 
float ThrowVelocityBoostMinSpeed = 1f
 
float ThrowVelocityBoostScale = 1f
 
Component currentlyHeldBy
 
VRCPlayerApi currentLocalPlayer
 
bool pickupable = true
 
float proximity = 2f
 

Static Public Attributes

static AwakeDelegate OnAwake
 
static ForceDropDelegate ForceDrop
 
static OnDestroyedDelegate OnDestroyed
 
static HapticEventDelegate HapticEvent
 

Properties

VRCPlayerApi currentPlayer [get]
 
bool IsHeld [get]
 
PickupHand currentHand [get]
 
float Proximity [get]
 
- Properties inherited from VRC.SDKBase.Source.IVRCInteractable
float Proximity [get]
 

Private Member Functions

void Awake ()
 
void Reset ()
 
void OnDestroy ()
 

Detailed Description

Definition at line 5033 of file VRCSDKBase.cs.

Member Enumeration Documentation

◆ AutoHoldMode

enum VRC.SDKBase.VRC_Pickup.AutoHoldMode : Enum

Definition at line 5042 of file VRCSDKBase.cs.

◆ PickupHand

enum VRC.SDKBase.VRC_Pickup.PickupHand : Enum

Definition at line 5049 of file VRCSDKBase.cs.

◆ PickupOrientation

enum VRC.SDKBase.VRC_Pickup.PickupOrientation : Enum

Definition at line 5035 of file VRCSDKBase.cs.

Member Function Documentation

◆ Awake()

void VRC.SDKBase.VRC_Pickup.Awake ( )
private

Definition at line 5161 of file VRCSDKBase.cs.

◆ AwakeDelegate()

delegate void VRC.SDKBase.VRC_Pickup.AwakeDelegate ( VRC_Pickup  obj)

◆ Drop() [1/2]

void VRC.SDKBase.VRC_Pickup.Drop ( )

Definition at line 5174 of file VRCSDKBase.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Drop() [2/2]

void VRC.SDKBase.VRC_Pickup.Drop ( VRCPlayerApi  instigator)

Definition at line 5184 of file VRCSDKBase.cs.

◆ ForceDropDelegate()

delegate void VRC.SDKBase.VRC_Pickup.ForceDropDelegate ( VRC_Pickup  obj)

◆ GenerateHapticEvent()

void VRC.SDKBase.VRC_Pickup.GenerateHapticEvent ( float  duration = 0.25f,
float  amplitude = 0.5f,
float  frequency = 0.5f 
)

Definition at line 5210 of file VRCSDKBase.cs.

Here is the caller graph for this function:

◆ HapticEventDelegate()

delegate void VRC.SDKBase.VRC_Pickup.HapticEventDelegate ( VRC_Pickup  obj,
float  duration,
float  amplitude,
float  frequency 
)

◆ OnDestroy()

void VRC.SDKBase.VRC_Pickup.OnDestroy ( )
private

Definition at line 5218 of file VRCSDKBase.cs.

◆ OnDestroyedDelegate()

delegate void VRC.SDKBase.VRC_Pickup.OnDestroyedDelegate ( VRC_Pickup  obj)

◆ PlayHaptics()

void VRC.SDKBase.VRC_Pickup.PlayHaptics ( )

Definition at line 5227 of file VRCSDKBase.cs.

Here is the call graph for this function:

◆ ProvideEvents()

IEnumerable< VRC_EventHandler.VrcEvent > VRC.SDKBase.VRC_Pickup.ProvideEvents ( )

Implements VRC.SDKBase.IVRCEventProvider.

Definition at line 5232 of file VRCSDKBase.cs.

◆ Reset()

void VRC.SDKBase.VRC_Pickup.Reset ( )
private

Definition at line 5169 of file VRCSDKBase.cs.

Member Data Documentation

◆ allowManipulationWhenEquipped

bool VRC.SDKBase.VRC_Pickup.allowManipulationWhenEquipped

Definition at line 5072 of file VRCSDKBase.cs.

◆ AutoHold

AutoHoldMode VRC.SDKBase.VRC_Pickup.AutoHold

Definition at line 5076 of file VRCSDKBase.cs.

◆ currentLocalPlayer

VRCPlayerApi VRC.SDKBase.VRC_Pickup.currentLocalPlayer

Definition at line 5114 of file VRCSDKBase.cs.

◆ currentlyHeldBy

Component VRC.SDKBase.VRC_Pickup.currentlyHeldBy

Definition at line 5111 of file VRCSDKBase.cs.

◆ DisallowTheft

bool VRC.SDKBase.VRC_Pickup.DisallowTheft

Definition at line 5066 of file VRCSDKBase.cs.

◆ DropEventName

string VRC.SDKBase.VRC_Pickup.DropEventName

Definition at line 5104 of file VRCSDKBase.cs.

◆ ExactGrip

Transform VRC.SDKBase.VRC_Pickup.ExactGrip

Definition at line 5070 of file VRCSDKBase.cs.

◆ ExactGun

Transform VRC.SDKBase.VRC_Pickup.ExactGun

Definition at line 5068 of file VRCSDKBase.cs.

◆ ForceDrop

ForceDropDelegate VRC.SDKBase.VRC_Pickup.ForceDrop
static

Definition at line 5123 of file VRCSDKBase.cs.

◆ HapticEvent

HapticEventDelegate VRC.SDKBase.VRC_Pickup.HapticEvent
static

Definition at line 5127 of file VRCSDKBase.cs.

◆ InteractionText

string VRC.SDKBase.VRC_Pickup.InteractionText = ""

Definition at line 5078 of file VRCSDKBase.cs.

◆ MomentumTransferMethod

ForceMode VRC.SDKBase.VRC_Pickup.MomentumTransferMethod

Definition at line 5064 of file VRCSDKBase.cs.

◆ OnAwake

AwakeDelegate VRC.SDKBase.VRC_Pickup.OnAwake
static

Definition at line 5121 of file VRCSDKBase.cs.

◆ OnDestroyed

OnDestroyedDelegate VRC.SDKBase.VRC_Pickup.OnDestroyed
static

Definition at line 5125 of file VRCSDKBase.cs.

◆ orientation

PickupOrientation VRC.SDKBase.VRC_Pickup.orientation

Definition at line 5074 of file VRCSDKBase.cs.

◆ pickupable

bool VRC.SDKBase.VRC_Pickup.pickupable = true

Definition at line 5116 of file VRCSDKBase.cs.

◆ pickupDropEventBroadcastType

VRC_EventHandler.VrcBroadcastType VRC.SDKBase.VRC_Pickup.pickupDropEventBroadcastType

Definition at line 5096 of file VRCSDKBase.cs.

◆ PickupEventName

string VRC.SDKBase.VRC_Pickup.PickupEventName

Definition at line 5100 of file VRCSDKBase.cs.

◆ proximity

float VRC.SDKBase.VRC_Pickup.proximity = 2f

Definition at line 5119 of file VRCSDKBase.cs.

◆ ThrowVelocityBoostMinSpeed

float VRC.SDKBase.VRC_Pickup.ThrowVelocityBoostMinSpeed = 1f

Definition at line 5106 of file VRCSDKBase.cs.

◆ ThrowVelocityBoostScale

float VRC.SDKBase.VRC_Pickup.ThrowVelocityBoostScale = 1f

Definition at line 5108 of file VRCSDKBase.cs.

◆ UseDownEventName

string VRC.SDKBase.VRC_Pickup.UseDownEventName

Definition at line 5088 of file VRCSDKBase.cs.

◆ useEventBroadcastType

VRC_EventHandler.VrcBroadcastType VRC.SDKBase.VRC_Pickup.useEventBroadcastType

Definition at line 5084 of file VRCSDKBase.cs.

◆ UseText

string VRC.SDKBase.VRC_Pickup.UseText = "Use"

Definition at line 5080 of file VRCSDKBase.cs.

◆ UseUpEventName

string VRC.SDKBase.VRC_Pickup.UseUpEventName

Definition at line 5092 of file VRCSDKBase.cs.

Property Documentation

◆ currentHand

PickupHand VRC.SDKBase.VRC_Pickup.currentHand
get

Definition at line 5157 of file VRCSDKBase.cs.

◆ currentPlayer

VRCPlayerApi VRC.SDKBase.VRC_Pickup.currentPlayer
get

Definition at line 5133 of file VRCSDKBase.cs.

◆ IsHeld

bool VRC.SDKBase.VRC_Pickup.IsHeld
get

Definition at line 5145 of file VRCSDKBase.cs.

◆ Proximity

float VRC.SDKBase.VRC_Pickup.Proximity
get

Implements VRC.SDKBase.Source.IVRCInteractable.

Definition at line 5159 of file VRCSDKBase.cs.

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