Editor Scripting API
Guide Docs
Preparing search index...
The search index is not available
Lens Scripting API
Lens Scripting API
Built-In
Module Built-In
Version
5.6.0 For Snapchat Version: 13.26
Namespaces
Audio
Camera
CameraModule
Canvas
ClothVisual
ConnectedLensModule
ConnectedLensSessionOptions
Dialog
GestureModule
global
Leaderboard
LookAtComponent
MachineLearning
MappingSession
MotionController
ObjectTracking3D
Physics
PinToMeshComponent
RealtimeStoreCreateOptions
RemoteServiceHttpRequest
RenderTargetProvider
ScanModule
TensorMath
TextInputSystem
TextToSpeech
VoiceML
VoiceMLModule
Enumerations
AnimationLayerBlendMode
AnimationLayerScaleMode
AttachmentPointType
Axis
BlendMode
CapitilizationOverride
ClearColorOption
Colorspace
CompressionQuality
CullMode
DepthClearOption
DeviceTrackingMode
EncodingType
FaceInsetRegion
FilteringMode
FrustumCullMode
GeoLocationAccuracy
HapticFeedbackType
HingeMotorType
HorizontalAlignment
HorizontalOverflow
LoadStatus
LocationProximityStatus
LyricsType
ManipulateType
MeshClassificationFormat
MeshIndexType
MeshShadowMode
MeshTopology
NativePlaneTrackingType
OS
PlaybackMode
ScreenRegionType
SortOrder
StencilClearOption
StencilFace
StencilFunction
StencilOperation
StorageScope
StretchMode
TangentType
TextFillMode
TileZone
TouchState
TrackedMeshFaceClassification
TrackedPlaneOrientation
TransformerRotation
VerticalAlignment
VerticalOverflow
VideoStatus
WeatherCondition
WeightedMode
WrapMode
Zodiac
Classes
Anchor
AnimatedTextureFileProvider
AnimationAsset
AnimationClip
AnimationCurve
AnimationCurveTrack
AnimationKeyFrame
AnimationPlayer
AnimationPlayerOnEventArgs
AnimationPropertyEventRegistration
AnimationPropertyLayer
AnimationTrack
Asset
AudioComponent
AudioEffectAsset
AudioEffectComponent
AudioEffectProvider
AudioListenerComponent
AudioOutputProvider
AudioTrackAsset
AudioTrackProvider
BackgroundSettings
Base64
BaseMeshVisual
BaseMultiplayerSessionOptions
BasePlaceholder
BasicTransform
BinAsset
Bitmoji2DOptions
Bitmoji2DResource
Bitmoji3DOptions
Bitmoji3DResource
BitmojiModule
Blob
BlurNoiseEstimation
BodyComponent
BodyDepthTextureProvider
BodyInstanceSegmentationTextureProvider
BodyNormalsTextureProvider
BodyRenderObjectProvider
BodyTrackingAsset
BoxShape
BrowsLoweredEvent
BrowsRaisedEvent
BrowsReturnedToNormalEvent
Camera
CameraBackEvent
CameraFrame
CameraFrontEvent
CameraModule
CameraTextureProvider
Canvas
CapsuleShape
ClearDepth
ClothVisual
CloudStorageListOptions
CloudStorageModule
CloudStorageOptions
CloudStorageReadOptions
CloudStorageWriteOptions
CloudStore
ColliderComponent
Collision
CollisionEnterEventArgs
CollisionExitEventArgs
CollisionMesh
CollisionStayEventArgs
ColocatedLandmarks2DRenderObjectProvider
ColocatedLandmarks3DRenderObjectProvider
ColocatedLandmarksRenderObjectProviderBase
ColocatedTrackingComponent
Component
ConeShape
ConnectedLensEnteredEvent
ConnectedLensModule
ConnectedLensSessionOptions
Constraint
ConstraintComponent
Contact
CropTextureProvider
CylinderShape
DeformingCollisionMesh
Delay
DelayBuilder
DelayedCallbackEvent
Delta
DeltaBuilder
DepthSetter
DepthStencilRenderTargetProvider
DepthTextureProvider
DeviceCamera
DeviceInfoSystem
DeviceLocationTrackingComponent
DeviceTracking
DeviceTrackingModule
DialogModule
DirectivityEffect
DirectMultiplayerSessionOptions
DistanceEffect
DomainInfo
DropshadowSettings
DynamicResource
EventRegistration
Expressions
ExternalMusicInfo
ExternalMusicModule
EyeColorVisual
FaceCropTextureProvider
FaceFoundEvent
FaceInsetVisual
FaceLostEvent
FaceMaskVisual
FaceRenderObjectProvider
FaceStretchVisual
FaceTextureProvider
FaceTrackingEvent
FileAudioTrackProvider
FileLicensedSoundProvider
FileTextureProvider
Filter
FixedCollisionMesh
FixedConstraint
FocusEndEventArgs
FocusStartEventArgs
Font
GaussianSplattingAsset
GaussianSplattingVisual
GeneralDataStore
GeoLocation
GeoPosition
GestureModule
GltfAsset
GltfSettings
HairDataAsset
HairVisual
HandSpecificData
HandTracking3DAsset
HapticFeedbackSystem
Head
Headers
HingeConstraint
HingeLimitSettings
HingeMotorSettings
HintsComponent
HitTestSession
HitTestSessionOptions
HoverEvent
IEventParameters
Image
InputBuilder
InputPlaceholder
InteractionComponent
KissFinishedEvent
KissStartedEvent
LateUpdateEvent
LayerSet
Leaderboard
LeaderboardModule
LevelsetColliderAsset
LevelsetShape
LicensedAudioTrackAsset
LightSource
LiquifyVisual
LocalizationsAsset
LocalizationSystem
LocatedAtComponent
LocationAsset
LocationCloudStorageModule
LocationCloudStorageOptions
LocationCloudStore
LocationRenderObjectProvider
LocationService
LocationTextureProvider
LookAtComponent
Lyrics
LyricsLine
LyricsSync
LyricsTracker
MachineLearning
ManipulateComponent
ManipulateEndEvent
ManipulateEndEventArgs
ManipulateFrameIntersectResult
ManipulateStartEvent
ManipulateStartEventArgs
MapModule
MappingOptions
MappingSession
MapTextureProvider
MarkerAsset
MarkerProvider
MarkerTrackingComponent
MaskingComponent
mat2
mat3
mat4
Material
MaterialMeshVisual
MathUtils
Matter
MediaPickerTextureProvider
MelSpectrogram
MelSpectrogramBuilder
MeshBuilder
MeshRenderObjectProvider
MeshShape
MeshVisual
MFCC
MFCCBuilder
MicrophoneAudioProvider
MLAsset
MLComponent
MotionController
MotionControllerModule
MouthClosedEvent
MouthOpenedEvent
MultiplayerSession
NoiseReduction
NoiseReductionBuilder
Object3DAsset
ObjectPrefab
ObjectSpecificData
ObjectTracking
ObjectTracking3D
ObjectTrackingMaskedTextureProvider
ObjectTrackingNormalsTextureProvider
ObjectTrackingTextureProvider
OnAwakeEvent
OnDestroyEvent
OnDisableEvent
OnEnableEvent
OnStartEvent
OutlineSettings
OutputBuilder
OutputPlaceholder
Overlap
OverlapEnterEventArgs
OverlapExitEventArgs
OverlapStayEventArgs
PalmTapDownArgs
PalmTapUpArgs
Pass
PassWrapper
PassWrappers
PersistentStorageSystem
Physics
PinchDownArgs
PinchStrengthArgs
PinchUpArgs
PinToMeshComponent
PitchShifter
PitchShifterBuilder
PointCloud
PointConstraint
PositionEffect
PostEffectVisual
Probe
ProceduralMeshRenderObjectProvider
ProceduralTextureProvider
ProcessedLocationModule
Properties
PropertyOnEventArgs
Provider
quat
RawLocationModule
RayCastHit
RealtimeStoreCreateOptions
Rect
RectangleSetter
RectCropTextureProvider
RemoteApiRequest
RemoteApiResponse
RemoteMediaModule
RemoteReferenceAsset
RemoteServiceHttpRequest
RemoteServiceHttpResponse
RemoteServiceModule
RenderMesh
RenderMeshVisual
RenderObjectProvider
RenderTargetProvider
Request
Response
RetouchVisual
ReverseCameraTextureProvider
RotatedRect
RotationOptions
Sampler
SamplerBuilder
SamplerWrapper
SamplerWrappers
ScanModule
SceneEvent
SceneObject
SceneObjectEvent
ScreenRegionComponent
ScreenTextureProvider
ScreenTransform
ScriptAsset
ScriptComponent
ScriptObject
ScriptScene
SegmentationModel
SegmentationTextureProvider
SelectEndEventArgs
SelectStartEventArgs
SerializableWithUID
Shape
ShoppingModule
Skin
SmileFinishedEvent
SmileStartedEvent
SnapchatFriendUserInfo
SnapchatUser
SnapchatUserBirthday
SnapcodeMarkerProvider
SnapImageCaptureEvent
SnapRecordStartEvent
SnapRecordStopEvent
SpatialAudio
SpectaclesHandSpecificData
Spectrogram
SpectrogramBuilder
SphereShape
SplineComponent
SpriteAligner
StateInfo
StencilState
StorageOptions
Studio
SurfaceOptions
SurfaceTrackingResetEvent
TapEvent
TapEventArgs
TargetingDataArgs
TensorMath
Text
Text3D
TextFill
TextInputModule
TextInputSystem
TextProvider
TextToSpeech
TextToSpeechModule
Texture
TextureFormat
TextureProvider
TouchDataProvider
TouchEndEvent
TouchEndEventArgs
TouchMoveEvent
TouchMoveEventArgs
TouchStartEvent
TouchStartEventArgs
TrackedMesh
TrackedMeshHistogramResult
TrackedMeshHitTestResult
TrackedPlane
TrackedPoint
TrackedPointComponent
Transform
Transformer
TransformerBuilder
TriangleHit
TriggerPrimaryEvent
TriggerPrimaryEventArgs
TurnOffEvent
UpdateEvent
UpperBodyRenderObjectProvider
UpperBodyTrackingAsset
UserContextSystem
vec2
vec3
vec4
vec4b
VertexCache
VertexSimulationSettings
VFXAsset
VFXComponent
VideoTextureProvider
Visual
VoiceML
VoiceMLModule
WebPageTextureProvider
WebSocket
WebSocketCloseEvent
WebSocketErrorEvent
WebSocketEvent
WebSocketMessageEvent
WebViewOptions
WebViewPolicy
WorldComponent
WorldOptions
WorldQueryHitTestResult
WorldQueryModule
WorldRenderObjectProvider
WorldTrackingCapabilities
WorldTrackingMeshesAddedEvent
WorldTrackingMeshesRemovedEvent
WorldTrackingMeshesUpdatedEvent
WorldTrackingPlanesAddedEvent
WorldTrackingPlanesRemovedEvent
WorldTrackingPlanesUpdatedEvent
WorldUnderstandingModule
Interfaces
ComponentNameMap
event0
event1
event2
event3
event4
event5
event6
event7
EventNameMap
Variables
script
Functions
failAsync
getDeltaTime
getRealTimeNanos
getTime
isNull
print
require
requireAsset
requireType
Settings
Member Visibility
Inherited
Private
Theme
OS
Light
Dark
On This Page
Namespaces
Audio
Camera
Camera
Module
Canvas
Cloth
Visual
Connected
Lens
Module
Connected
Lens
Session
Options
Dialog
Gesture
Module
global
Leaderboard
Look
At
Component
Machine
Learning
Mapping
Session
Motion
Controller
Object
Tracking3D
Physics
Pin
To
Mesh
Component
Realtime
Store
Create
Options
Remote
Service
Http
Request
Render
Target
Provider
Scan
Module
Tensor
Math
Text
Input
System
Text
To
Speech
VoiceML
VoiceMLModule
Enumerations
Animation
Layer
Blend
Mode
Animation
Layer
Scale
Mode
Attachment
Point
Type
Axis
Blend
Mode
Capitilization
Override
Clear
Color
Option
Colorspace
Compression
Quality
Cull
Mode
Depth
Clear
Option
Device
Tracking
Mode
Encoding
Type
Face
Inset
Region
Filtering
Mode
Frustum
Cull
Mode
Geo
Location
Accuracy
Haptic
Feedback
Type
Hinge
Motor
Type
Horizontal
Alignment
Horizontal
Overflow
Load
Status
Location
Proximity
Status
Lyrics
Type
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
Touch
State
Tracked
Mesh
Face
Classification
Tracked
Plane
Orientation
Transformer
Rotation
Vertical
Alignment
Vertical
Overflow
Video
Status
Weather
Condition
Weighted
Mode
Wrap
Mode
Zodiac
Classes
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
Base64
Base
Mesh
Visual
Base
Multiplayer
Session
Options
Base
Placeholder
Basic
Transform
Bin
Asset
Bitmoji2DOptions
Bitmoji2DResource
Bitmoji3DOptions
Bitmoji3DResource
Bitmoji
Module
Blob
Blur
Noise
Estimation
Body
Component
Body
Depth
Texture
Provider
Body
Instance
Segmentation
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
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
Domain
Info
Dropshadow
Settings
Dynamic
Resource
Event
Registration
Expressions
External
Music
Info
External
Music
Module
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
Headers
Hinge
Constraint
Hinge
Limit
Settings
Hinge
Motor
Settings
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
Licensed
Audio
Track
Asset
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
Lyrics
Lyrics
Line
Lyrics
Sync
Lyrics
Tracker
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
mat2
mat3
mat4
Material
Material
Mesh
Visual
Math
Utils
Matter
Media
Picker
Texture
Provider
Mel
Spectrogram
Mel
Spectrogram
Builder
Mesh
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
quat
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
Request
Response
Retouch
Visual
Reverse
Camera
Texture
Provider
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
Shopping
Module
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
Spectacles
Hand
Specific
Data
Spectrogram
Spectrogram
Builder
Sphere
Shape
Spline
Component
Sprite
Aligner
State
Info
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
Format
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
vec2
vec3
vec4
vec4b
Vertex
Cache
Vertex
Simulation
Settings
VFXAsset
VFXComponent
Video
Texture
Provider
Visual
VoiceML
VoiceMLModule
Web
Page
Texture
Provider
Web
Socket
Web
Socket
Close
Event
Web
Socket
Error
Event
Web
Socket
Event
Web
Socket
Message
Event
Web
View
Options
Web
View
Policy
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
Interfaces
Component
Name
Map
event0
event1
event2
event3
event4
event5
event6
event7
Event
Name
Map
Variables
script
Functions
fail
Async
get
Delta
Time
get
Real
Time
Nanos
get
Time
is
Null
print
require
require
Asset
require
Type
Editor Scripting API
Guide Docs
Lens Scripting API
Loading...
Version
5.6.0 For Snapchat Version: 13.26