Click or drag to resize

IEngageableObject Interface

An object that can be engaged with by a player

Namespace:  ImmerseSDK.Interaction
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
public interface IEngageableObject : IInteractableObject

The IEngageableObject type exposes the following members.

Properties
  NameDescription
Public propertyControllerTrackingEnabled
True if the object is currently tracking the controller
Public propertyEngagingControllers
The list of engaged controllers
Public propertyInteractionAllowed
True if interaction is allowed, otherwise false
Public propertyIsEngaged
True if this object is currently engaged by one or more controllers
Public propertyIsKinematicAfterEngage
How the object's physics should behave after engagement
Public propertyRequiresTwoHands
Indicates whether this object needs to be engaged with by 2 controllers to move
Public propertyRigidbody
This object's Rigidbody component
Top
Methods
  NameDescription
Public methodEngage
Engage After this is called a Ghost message is broadcast
Public methodTriggerShortControlerVibration
Trigger a short vibration on the current engaged object
Top
Extension Methods
  NameDescription
Public Extension MethodDisengage
Disengage an engageable object
(Defined by EngagingExtensions.)
Public Extension MethodEngage
Engage an engageable object. This will be a local/remote engagement based on it's type (EngageableObject)
(Defined by EngagingExtensions.)
Public Extension MethodIsAvailable
Checks whether the target is available for interaction
(Defined by EngagingExtensions.)
Top
See Also