Editor Scripting API
Guide Docs
Preparing search index...
The search index is not available
Lens Scripting API
Lens Scripting API
Built-In
ModuleBuilt-In
Version
5.2.0 For Snapchat Version: 13.11
Index
Namespaces
Animation
Clip
Animation
Curve
Audio
Bitmoji2DOptions
Bitmoji3DOptions
Body
Tracking
Asset
Camera
Camera
Module
Canvas
Cloth
Visual
Cloud
Storage
List
Options
Cloud
Storage
Options
Cloud
Storage
Read
Options
Cloud
Storage
Write
Options
Connected
Lens
Module
Connected
Lens
Session
Options
Dialog
Expressions
General
Data
Store
Geo
Location
Geo
Position
Gesture
Module
global
Gltf
Settings
Hit
Test
Session
Options
Layer
Set
Leaderboard
Located
At
Component
Location
Asset
Location
Cloud
Storage
Options
Location
Render
Object
Provider
Location
Texture
Provider
Look
At
Component
Machine
Learning
Mapping
Session
mat2
mat3
mat4
Math
Utils
Mesh
Builder
Motion
Controller
Object
Tracking3D
Physics
Pin
To
Mesh
Component
Procedural
Texture
Provider
quat
Realtime
Store
Create
Options
Rect
Remote
Api
Request
Remote
Service
Http
Request
Render
Target
Provider
Rotated
Rect
Scan
Module
Shape
Storage
Options
Studio
Tensor
Math
Text
Input
System
Text
To
Speech
vec2
vec3
vec4
VoiceML
VoiceMLModule
Enumerations
Animation
Layer
Blend
Mode
Animation
Layer
Scale
Mode
Attachment
Point
Type
Axis
Blend
Mode
Capitilization
Override
Clear
Color
Option
Colorspace
Cull
Mode
Depth
Clear
Option
Device
Tracking
Mode
Face
Inset
Region
Filtering
Mode
Frustum
Cull
Mode
Geo
Location
Accuracy
Haptic
Feedback
Type
Horizontal
Alignment
Horizontal
Overflow
Load
Status
Location
Proximity
Status
Manipulate
Type
Mesh
Classification
Format
Mesh
Index
Type
Mesh
Shadow
Mode
Mesh
Topology
Native
Plane
Tracking
Type
OS
Playback
Mode
Screen
Region
Type
Sort
Order
Stencil
Clear
Option
Stencil
Face
Stencil
Function
Stencil
Operation
Storage
Scope
Stretch
Mode
Tangent
Type
Text
Fill
Mode
Tile
Zone
Tracked
Mesh
Face
Classification
Tracked
Plane
Orientation
Transformer
Rotation
Vertical
Alignment
Vertical
Overflow
Video
Status
Weather
Condition
Weighted
Mode
Wrap
Mode
Zodiac
Classes
mat2
mat3
mat4
Mesh
Builder
quat
vec2
vec3
vec4
vec4b
Interfaces
Anchor
Animated
Texture
File
Provider
Animation
Asset
Animation
Clip
Animation
Curve
Animation
Curve
Track
Animation
Key
Frame
Animation
Player
Animation
Player
On
Event
Args
Animation
Property
Event
Registration
Animation
Property
Layer
Animation
Track
Asset
Audio
Component
Audio
Effect
Asset
Audio
Effect
Component
Audio
Effect
Provider
Audio
Listener
Component
Audio
Output
Provider
Audio
Track
Asset
Audio
Track
Provider
Background
Settings
Base
Mesh
Visual
Base
Multiplayer
Session
Options
Base
Placeholder
Basic
Transform
Bin
Asset
Bitmoji2DOptions
Bitmoji2DResource
Bitmoji3DOptions
Bitmoji3DResource
Bitmoji
Module
Blur
Noise
Estimation
Body
Component
Body
Depth
Texture
Provider
Body
Normals
Texture
Provider
Body
Render
Object
Provider
Body
Tracking
Asset
Box
Shape
Brows
Lowered
Event
Brows
Raised
Event
Brows
Returned
To
Normal
Event
Camera
Camera
Back
Event
Camera
Frame
Camera
Front
Event
Camera
Module
Camera
Texture
Provider
Canvas
Capsule
Shape
Clear
Depth
Cloth
Visual
Cloud
Storage
List
Options
Cloud
Storage
Module
Cloud
Storage
Options
Cloud
Storage
Read
Options
Cloud
Storage
Write
Options
Cloud
Store
Collider
Component
Collision
Collision
Enter
Event
Args
Collision
Exit
Event
Args
Collision
Mesh
Collision
Stay
Event
Args
Colocated
Landmarks2DRender
Object
Provider
Colocated
Landmarks3DRender
Object
Provider
Colocated
Landmarks
Render
Object
Provider
Base
Colocated
Tracking
Component
Component
Component
Name
Map
Cone
Shape
Connected
Lens
Entered
Event
Connected
Lens
Module
Connected
Lens
Session
Options
Constraint
Constraint
Component
Contact
Crop
Texture
Provider
Cylinder
Shape
Deforming
Collision
Mesh
Delay
Delay
Builder
Delayed
Callback
Event
Delta
Delta
Builder
Depth
Setter
Depth
Stencil
Render
Target
Provider
Depth
Texture
Provider
Device
Camera
Device
Info
System
Device
Location
Tracking
Component
Device
Tracking
Device
Tracking
Module
Dialog
Module
Directivity
Effect
Direct
Multiplayer
Session
Options
Distance
Effect
Dropshadow
Settings
Dynamic
Resource
event0
event1
event2
event3
event4
event5
Event
Name
Map
Event
Registration
Expressions
Eye
Color
Visual
Face
Crop
Texture
Provider
Face
Found
Event
Face
Inset
Visual
Face
Lost
Event
Face
Mask
Visual
Face
Render
Object
Provider
Face
Stretch
Visual
Face
Texture
Provider
Face
Tracking
Event
File
Audio
Track
Provider
File
Licensed
Sound
Provider
File
Texture
Provider
Filter
Fixed
Collision
Mesh
Fixed
Constraint
Focus
End
Event
Args
Focus
Start
Event
Args
Font
Gaussian
Splatting
Asset
Gaussian
Splatting
Visual
General
Data
Store
Geo
Location
Geo
Position
Gesture
Module
Gltf
Asset
Gltf
Settings
Hair
Data
Asset
Hair
Visual
Hand
Specific
Data
Hand
Tracking3DAsset
Haptic
Feedback
System
Head
Hinge
Constraint
Hints
Component
Hit
Test
Session
Hit
Test
Session
Options
Hover
Event
IEvent
Parameters
Image
Input
Builder
Input
Placeholder
Interaction
Component
Kiss
Finished
Event
Kiss
Started
Event
Late
Update
Event
Layer
Set
Leaderboard
Leaderboard
Module
Levelset
Collider
Asset
Levelset
Shape
Light
Source
Liquify
Visual
Localizations
Asset
Localization
System
Located
At
Component
Location
Asset
Location
Cloud
Storage
Module
Location
Cloud
Storage
Options
Location
Cloud
Store
Location
Render
Object
Provider
Location
Service
Location
Texture
Provider
Look
At
Component
Machine
Learning
Manipulate
Component
Manipulate
End
Event
Manipulate
End
Event
Args
Manipulate
Frame
Intersect
Result
Manipulate
Start
Event
Manipulate
Start
Event
Args
Map
Module
Mapping
Options
Mapping
Session
Map
Texture
Provider
Marker
Asset
Marker
Provider
Marker
Tracking
Component
Masking
Component
Material
Material
Mesh
Visual
Math
Utils
Matter
Media
Picker
Texture
Provider
Mel
Spectrogram
Mel
Spectrogram
Builder
Mesh
Render
Object
Provider
Mesh
Shape
Mesh
Visual
MFCC
MFCCBuilder
Microphone
Audio
Provider
MLAsset
MLComponent
Motion
Controller
Motion
Controller
Module
Mouth
Closed
Event
Mouth
Opened
Event
Multiplayer
Session
Noise
Reduction
Noise
Reduction
Builder
Object3DAsset
Object
Prefab
Object
Specific
Data
Object
Tracking
Object
Tracking3D
Object
Tracking
Masked
Texture
Provider
Object
Tracking
Normals
Texture
Provider
Object
Tracking
Texture
Provider
On
Awake
Event
On
Destroy
Event
On
Disable
Event
On
Enable
Event
On
Start
Event
Outline
Settings
Output
Builder
Output
Placeholder
Overlap
Overlap
Enter
Event
Args
Overlap
Exit
Event
Args
Overlap
Stay
Event
Args
Palm
Tap
Down
Args
Palm
Tap
Up
Args
Pass
Pass
Wrapper
Pass
Wrappers
Persistent
Storage
System
Physics
Pinch
Down
Args
Pinch
Strength
Args
Pinch
Up
Args
Pin
To
Mesh
Component
Pitch
Shifter
Pitch
Shifter
Builder
Point
Cloud
Point
Constraint
Position
Effect
Post
Effect
Visual
Probe
Procedural
Mesh
Render
Object
Provider
Procedural
Texture
Provider
Processed
Location
Module
Properties
Property
On
Event
Args
Provider
Raw
Location
Module
Ray
Cast
Hit
Realtime
Store
Create
Options
Rect
Rectangle
Setter
Rect
Crop
Texture
Provider
Remote
Api
Request
Remote
Api
Response
Remote
Media
Module
Remote
Reference
Asset
Remote
Service
Http
Request
Remote
Service
Http
Response
Remote
Service
Module
Render
Mesh
Render
Mesh
Visual
Render
Object
Provider
Render
Target
Provider
Retouch
Visual
Rotated
Rect
Rotation
Options
Sampler
Sampler
Builder
Sampler
Wrapper
Sampler
Wrappers
Scan
Module
Scene
Event
Scene
Object
Scene
Object
Event
Screen
Region
Component
Screen
Texture
Provider
Screen
Transform
Script
Asset
Script
Component
Script
Object
Script
Scene
Segmentation
Model
Segmentation
Texture
Provider
Select
End
Event
Args
Select
Start
Event
Args
Serializable
WithUID
Shape
Single
Plane
Tracking
Updated
Event
Skin
Smile
Finished
Event
Smile
Started
Event
Snapchat
Friend
User
Info
Snapchat
User
Snapchat
User
Birthday
Snapcode
Marker
Provider
Snap
Image
Capture
Event
Snap
Record
Start
Event
Snap
Record
Stop
Event
Spatial
Audio
Spectrogram
Spectrogram
Builder
Sphere
Shape
Spline
Component
Sprite
Aligner
Stencil
State
Storage
Options
Studio
Surface
Options
Surface
Tracking
Reset
Event
Tap
Event
Tap
Event
Args
Targeting
Data
Args
Tensor
Math
Text
Text3D
Text
Fill
Text
Input
Module
Text
Input
System
Text
Provider
Text
To
Speech
Text
To
Speech
Module
Texture
Texture
Provider
Touch
Data
Provider
Touch
End
Event
Touch
End
Event
Args
Touch
Move
Event
Touch
Move
Event
Args
Touch
Start
Event
Touch
Start
Event
Args
Tracked
Mesh
Tracked
Mesh
Histogram
Result
Tracked
Mesh
Hit
Test
Result
Tracked
Plane
Tracked
Point
Tracked
Point
Component
Transform
Transformer
Transformer
Builder
Triangle
Hit
Trigger
Primary
Event
Trigger
Primary
Event
Args
Turn
Off
Event
Update
Event
Upper
Body
Render
Object
Provider
Upper
Body
Tracking
Asset
User
Context
System
Vertex
Cache
Vertex
Simulation
Settings
VFXAsset
VFXComponent
Video
Texture
Provider
Visual
VoiceML
VoiceMLModule
World
Component
World
Options
World
Query
Hit
Test
Result
World
Query
Module
World
Render
Object
Provider
World
Tracking
Capabilities
World
Tracking
Meshes
Added
Event
World
Tracking
Meshes
Removed
Event
World
Tracking
Meshes
Updated
Event
World
Tracking
Planes
Added
Event
World
Tracking
Planes
Removed
Event
World
Tracking
Planes
Updated
Event
World
Understanding
Module
Variables
script
Functions
fail
Async
get
Delta
Time
get
Real
Time
Nanos
get
Time
is
Null
print
require
require
Asset
require
Type
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
Editor Scripting API
Guide Docs
Lens Scripting API
Loading...
Version
5.2.0 For Snapchat Version: 13.11