Click or drag to resize

RestrictPickup Class

Restricts a Pickup to a specified rectangle, or to snap after a timeout period if it is dropped. It will snap back to it's origin when it either of these criteria is valid.
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDK.InteractionRestrictPickup

Namespace:  ImmerseSDK.Interaction
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
Copy
[UnityEngine.RequireComponent(typeof(Pickup))]
public class RestrictPickup : LoggingBehaviour

The RestrictPickup type exposes the following members.

Constructors
  NameDescription
Public methodRestrictPickup
Initializes a new instance of the RestrictPickup class
Top
Properties
  NameDescription
Public propertyDelaySnapAfterDisengagementInSeconds
If this value > 0, then the pickup will be snapped to Origin after it is dropped
Public propertyForceEngagementToStop
Force stop engagement if the object passes outside of the boundary
Public propertyLocalBounds
Bounds in Local space to restrict the Pickup to
Top
Methods
  NameDescription
Protected methodAwake
Unity Component Method
Protected methodOnDisable
Unity Component Method
Protected methodOnDrawGizmosSelected
Unity Component Method
Protected methodOnEnable
Unity Component Method
Top
Fields
  NameDescription
Private field_checkBounds
Force stop engagement if the object passes outside of the boundary
Private field_delaySnapAfterDisengagementInSeconds
If this value > 0, then the pickup will be snapped to Origin after it is dropped
Private field_forceEngagementToStop
Force stop engagement if the object passes outside of the boundary
Private field_localBounds
Bounds in Local space to restrict the Pickup to
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also