OnFullScreenEnterEvent
ClassTriggered immediately when the Lens enters full-screen mode.
- Snapchat: not supported
- SPECS: not supported
- Camera Kit Web: fully supported
- Camera Kit Mobile: fully supported
- SnapchatNot supported — Available on Camera Kit only
- SPECSNot supported — Available on Camera Kit only
- Camera Kit WebFully supported
- Camera Kit MobileFully supported
Since Lens Scripting v375
Triggered immediately when the Lens enters full-screen mode.
This event is useful for Venue AR and gaming use cases where UI layout and interaction models change based on the viewport state.
Index
Properties
Methods
Example
Example js
script.createEvent("OnFullScreenEnterEvent").bind(function (eventData)
{
print("Entered full-screen mode");
});
Example ts
@component
export class NewScript extends BaseScriptComponent {
onAwake() {
this.createEvent("OnFullScreenEnterEvent").bind(() => {
print("Entered full-screen mode");
});
}
}
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
getTypeName()
staticgetTypeName():TypeName<OnFullScreenEnterEvent>
Camera Kit
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<OnFullScreenEnterEvent>
Since
Lens Scripting Version 375
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