Lens Scripting API
    Preparing search index...

    Class OnFullScreenExitEvent

    Triggered when the Lens returns to the standard UI with carousel and other Snapchat UI elements.

    This event is useful for Venue AR and gaming use cases where UI layout and interaction models change based on the viewport state.

    Lens Scripting Version 375

    Example js

    script.createEvent("OnFullScreenExitEvent").bind(function (eventData)
    {
        print("Exited full-screen mode");
    });

    Example ts

    @component
    export class NewScript extends BaseScriptComponent {
      onAwake() {
        this.createEvent("OnFullScreenExitEvent").bind(() => {
          print("Exited full-screen mode");
        });
      }
    }

    Hierarchy (View Summary)

    Index

    Properties

    enabled

    Methods

    bind getTypeName getTypeName isOfType isSame

    Properties

    enabled: boolean

    If true, the event is able to trigger. If false, the event will not trigger.

    true

    Methods

    • Binds a callback function to this event.

      Parameters

      • evCallback: (arg1: this) => void

      Returns void

    • 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 string

      Lens Scripting Version 375

    • Returns the typename of the SceneEvent.

      Returns string

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods