Skip to main content

OnFullScreenExitEvent

Class

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

  • 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

Platform details

  • Snapchat — Not supported — Available on Camera Kit only.

  • SPECS — Not supported — Available on Camera Kit only.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v375

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.

Index

Example

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");
});
}
}

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

SceneEvent.enabled

Methods

bind()

bind(evCallback): void

Binds a callback function to this event.

Parameters

ParameterType
evCallback(arg1) => void

Returns

void

Inherited from

SceneEvent.bind


getTypeName()

static getTypeName(): TypeName<OnFullScreenExitEvent>

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<OnFullScreenExitEvent>

Since

Lens Scripting Version 375

Overrides

SceneEvent.getTypeName


getTypeName()

getTypeName(): string

Returns the typename of the SceneEvent.

Returns

string

Inherited from

SceneEvent.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

SceneEvent.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

SceneEvent.isSame