HoverEvent
ClassTriggered when a mouse hover event occurs.
- Available on all platforms
Triggered when a mouse hover event occurs. Only triggered in the Preview panel of Lens studio. Useful when working with Spectacles, where you can simulate the use of your hand to hover over an object. Does not get triggered on mobile.
Index
Properties
Methods
Extends
Properties
enabled
enabled:
boolean
If true, the event is able to trigger. If false, the event will not trigger.
Default Value
true
Inherited from
Methods
bind()
bind(
evCallback):void
Binds a callback function to this event.
Parameters
| Parameter | Type |
|---|---|
evCallback | (arg1) => void |
Returns
void
Inherited from
getHoverPosition()
getHoverPosition():
vec2
The normalized screen position of the hover event.
Returns
Since
Lens Scripting Version 272
getSceneObject()
getSceneObject():
SceneObject
Returns the SceneObject this Event is associated with.
Returns
Inherited from
SceneObjectEvent.getSceneObject
getTypeName()
staticgetTypeName():TypeName<HoverEvent>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<HoverEvent>
Overrides
getTypeName()
getTypeName():
string
Returns the typename of the SceneEvent.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean