Skip to content

Docs & Tutorials

Zappar

Zapworks

Discord GitHub LinkedIn Twitter YouTube Email

Studio
Getting Started
Workflow
Project Templates
- General
- Panorama
  - Panorama
  - 360 Degree Panorama
- World Tracking
- Image Tracking
- Face Tracking
- ZapBox
- Project Templates
Tutorials
Project Breakdowns
2D
Video
3D Models
Lighting
Subsymbols
- Introduction
- Subsymbol Templates
  - Tracking
    
    Tracking
    World Tracking: Ground Placement
  - Components
    
    Components
    360 Video Player
    360 Video Player with Touch
    3D Photo Feature
    Bezier Curves
    Target Manipulator
    Video Player
  - Buttons
    
    Buttons
    Call Button
    Facebook Button
    LinkedIn Button
    Map Button
    Twitter Button
    Web Button
  - Lighting
    
    Lighting
    Gravity Environment Light
    Gravity Light
  - Subsymbol Templates
- Subsymbols
Physics
- TriggerRegions
- Raycaster
- Physics
Scripting
- Utility Functions
- Examples
- Reference
  - Z.Accelerometer
    
    Events
    
    Events
    landscape
    landscapeinverted
    portrait
    portraitinverted
    
    Functions
    
    Functions
    orientation( )
    
    Z.Accelerometer
  - Z.Ajax
    
    Interfaces
    
    Interfaces
    Parameters
    Request
    
    Types
    
    Types
    Callback
    Method
    
    Z.Ajax
  - Z.AttitudeOrient
    
    Functions
    
    Functions
    resetHeading( )
    
    Z.AttitudeOrient
  - Z.Audio
    
    Events
    
    Events
    finish
    
    Functions
    
    Functions
    pause( )
    restart( )
    source( )
    source(...)
    start( )
    volume( )
    volume(...)
    
    Z.Audio
  - Z.Base
    
    Functions
    
    Functions
    emit(...)
    hasTag(...)
    off(...)
    on(...)
    one(...)
    pushTag(...)
    removeTag(...)
    tags( )
    tags(...)
    
    Z.Base
  - Z.Bezier
    
    Functions
    
    Functions
    distance( )
    distance(...)
    points( )
    points(...)
    
    Z.Bezier
  - Z.Billboard
    
    Functions
    
    Functions
    axis( )
    axis(...)
    
    Z.Billboard
  - Z.Calendar
    
    Enumerations
    
    Enumerations
    Frequency
    Month
    WeekDay
    
    Functions
    
    Functions
    add(...)
    
    Interfaces
    
    Interfaces
    Entry
    EntryRecurrence
    
    Z.Calendar
  - Z.CameraManager
    
    Functions
    
    Functions
    enable(...)
    useDefaultCamera( )
    useFrontCamera( )
    useRearCamera( )
    
    Z.CameraManager
  - Z.CameraTexture
    
    Enumerations
    
    Enumerations
    CropMode
    
    Functions
    
    Functions
    cropMode( )
    cropMode(...)
    snapshot( )
    
    Z.CameraTexture
  - Z.CameraTransform
    
    Functions
    
    Functions
    focalLength( )
    focalLength(...)
    
    Z.CameraTransform
  - Z.Contacts
    
    Functions
    
    Functions
    add(...)
    
    Interfaces
    
    Interfaces
    Entry
    
    Z.Contacts
  - Z.Controller
    
    Functions
    
    Functions
    activeElement( )
    clearQueue( )
    defaultElement( )
    state(...)
    timeline(...)
    
    Z.Controller
  - Z.CubemapTexture
    
    Functions
    
    Functions
    back( )
    back(...)
    bottom( )
    bottom(...)
    front( )
    front(...)
    left( )
    left(...)
    right( )
    right(...)
    top( )
    top(...)
    
    Z.CubemapTexture
  - Z.DataTexture
    
    Z.DataTexture
  - Z.Device
    
    Enumerations
    
    Enumerations
    LaunchMethod
    
    Functions
    
    Functions
    appData( )
    appIdentifier( )
    deepLinkId( )
    gif(...)
    gifMessage( )
    gifMessage(...)
    hasGyro( )
    launchMethod( )
    launchUrl(...)
    messageHost(...)
    playFullscreenVideo(...)
    queryStringParameter( )
    queryStringRaw( )
    reset( )
    retrieve(...)
    saveToDevice(...)
    snapshot(...)
    snapshotToTexture(...)
    snapshotMessage( )
    snapshotMessage(...)
    socialShare( )
    socialShare(...)
    store(...)
    themeColor( )
    themeColor(...)
    userLanguage( )
    vibrate( )
    
    Interfaces
    
    Interfaces
    SocialOptions
    
    Z.Device
  - Z.DirectionalLight
    
    Z.DirectionalLight
  - Z.Element
    
    Events
    
    Events
    active
    complete
    notactive
    
    Z.Element
  - Z.EnvironmentLight
    
    Functions
    
    Functions
    irradianceCubeMap( )
    irradianceCubeMap(...)
    mipLevel( )
    mipLevel(...)
    reflectionCubeMap( )
    reflectionCubeMap(...)
    
    Z.EnvironmentLight
  - Z.FaceFinder
    
    Events
    
    Events
    newinstance
    
    Functions
    
    Functions
    trackingEnabled( )
    trackingEnabled(...)
    
    Z.FaceFinder
  - Z.FaceGroup
    
    Events
    
    Events
    lefteyeclose
    lefteyeopen
    mouthclose
    mouthopen
    notseen
    righteyeclose
    righteyeopen
    seen
    
    Functions
    
    Functions
    trackingEnabled( )
    trackingEnabled(...)
    
    Z.FaceGroup
  - Z.FaceInstance
    
    Enumerations
    
    Enumerations
    AttachmentPoint
    
    Events
    
    Events
    lefteyeclose
    lefteyeopen
    mouthclose
    mouthopen
    notseen
    righteyeclose
    righteyeopen
    seen
    
    Functions
    
    Functions
    attachmentPoint(...)
    objectType( )
    
    Z.FaceInstance
  - Z.FacePaint
    
    Events
    
    Events
    lefteyeclose
    lefteyeopen
    mouthclose
    mouthopen
    notseen
    righteyeclose
    righteyeopen
    seen
    
    Functions
    
    Functions
    trackingEnabled( )
    trackingEnabled(...)
    
    Z.FacePaint
  - Z.Font
    
    Z.Font
  - Z.GravityBillboard
    
    Z.GravityBillboard
  - Z.Group
    
    Functions
    
    Functions
    child(...)
    children( )
    clear( )
    insert(...)
    push(...)
    remove(...)
    
    Z.Group
  - Z.HeadsetManager
    
    Events
    
    Events
    headsetbutton
    headsetenter
    headsetleave
    
    Functions
    
    Functions
    useHeadset( )
    usingHeadset( )
    
    Z.HeadsetManager
  - Z.ImageTexture
    
    Functions
    
    Functions
    source( )
    source(...)
    
    Z.ImageTexture
  - Z.Keyboard
    
    Events
    
    Events
    backspace
    key
    
    Functions
    
    Functions
    hide( )
    show( )
    
    Z.Keyboard
  - Z.Light
    
    Functions
    
    Functions
    intensity( )
    intensity(...)
    lightColor( )
    lightColor(...)
    priority( )
    priority(...)
    
    Z.Light
  - Z.Material
    
    Functions
    
    Functions
    blend( )
    blend(...)
    color( )
    color(...)
    cullFaces( )
    cullFaces(...)
    mask( )
    mask(...)
    maskAlphaChannel( )
    maskAlphaChannel(...)
    skin( )
    skin(...)
    
    Z.Material
  - Z.Node
    
    Functions
    
    Functions
    blend( )
    blend(...)
    color( )
    color(...)
    cullFaces( )
    cullFaces(...)
    enabled( )
    enabled(...)
    position( )
    position(...)
    relativeTo( )
    relativeTo(...)
    relativeToProp( )
    relativeToProp(...)
    rotation( )
    rotation(...)
    scale( )
    scale(...)
    visible( )
    visible(...)
    
    Z.Node
  - Z.Object
    
    Events
    
    Events
    intersection
    intersectionenter
    intersectionleave
    pointerdown
    pointerenter
    pointerleave
    pointermove
    pointersmove
    pointerup
    triggerenter
    triggerleave
    triggermove
    
    Functions
    
    Functions
    animationFrame( )
    animationFrame(...)
    layerMode( )
    layerMode(...)
    material(...)
    material(... , ...)
    materials( )
    materials(...)
    multitouch( )
    multitouch(...)
    renderSorted( )
    renderSorted(...)
    skin( )
    skin(...)
    type( )
    type(...)
    
    Interfaces
    
    Interfaces
    PointerEvent
    PointerPresentEvent
    
    Types
    
    Types
    MultiplePointerPresentEvent
    
    Z.Object
  - Z.ObjectType
    
    Functions
    
    Functions
    materials( )
    materials(...)
    
    Z.ObjectType
  - Z.PointLight
    
    Functions
    
    Functions
    range( )
    range(...)
    
    Z.PointLight
  - Z.Prompt
    
    Events
    
    Events
    cancel
    confirm
    done
    
    Functions
    
    Functions
    defaultValue( )
    defaultValue(...)
    filterProfanity( )
    filterProfanity(...)
    maxLength( )
    maxLength(...)
    show( )
    text( )
    text(...)
    title( )
    title(...)
    
    Interfaces
    
    Interfaces
    Parameters
    
    Z.Prompt
  - Z.Raycaster
    
    Events
    
    Events
    intersectionenter
    intersectionleave
    intersections
    
    Functions
    
    Functions
    colliderTag( )
    colliderTag(...)
    
    Interfaces
    
    Interfaces
    IntersectionEvent
    
    Z.Raycaster
  - Z.ScreenSizeConstrain
    
    Functions
    
    Functions
    displaySizeMax( )
    displaySizeMax(...)
    displaySizeMin( )
    displaySizeMin(...)
    
    Z.ScreenSizeConstrain
  - Z.ScreenTransform
    
    Events
    
    Events
    resize
    
    Functions
    
    Functions
    depth( )
    depth(...)
    zoom( )
    zoom(...)
    
    Z.ScreenTransform
  - Z.SpotLight
    
    Functions
    
    Functions
    angle( )
    angle(...)
    
    Z.SpotLight
  - Z.StandardLightingMaterial
    
    Functions
    
    Functions
    ambientColor( )
    ambientColor(...)
    ambientMap( )
    ambientMap(...)
    diffuseColor( )
    diffuseColor(...)
    diffuseMap( )
    diffuseMap(...)
    emissiveMap( )
    emissiveMap(...)
    gammaCorrection( )
    gammaCorrection(...)
    gamma( )
    gamma(...)
    glossinessMap( )
    glossinessMap(...)
    normalFlipY( )
    normalFlipY(...)
    normalMap( )
    normalMap(...)
    numPixelLights( )
    numPixelLights(...)
    opacity( )
    opacityMap( )
    opacityMap(...)
    opacity(...)
    reflection( )
    reflection(...)
    rimLightColor( )
    rimLightColor(...)
    rimLightCutoff( )
    rimLightCutoff(...)
    shininess( )
    shininess(...)
    specularColor( )
    specularColor(...)
    specularMap( )
    specularMap(...)
    useRimLight( )
    useRimLight(...)
    
    Z.StandardLightingMaterial
  - Z.State
    
    Functions
    
    Functions
    activate( )
    enqueue( )
    reset( )
    
    Z.State
  - Z.Stats
    
    Functions
    
    Functions
    logEvent(...)
    
    Z.Stats
  - Z.Symbol
    
    Events
    
    Events
    close
    closed
    hidden
    
    Functions
    
    Functions
    attach( )
    close( )
    controller(...)
    detach( )
    display( )
    hide( )
    node(...)
    show( )
    
    Z.Symbol
  - Z.Target
    
    Events
    
    Events
    newinstance
    notseen
    seen
    
    Z.Target
  - Z.TargetFinder
    
    Events
    
    Events
    newinstance
    newtarget
    notseen
    seen
    
    Functions
    
    Functions
    defaultScale( )
    defaultScale(...)
    source( )
    source(...)
    
    Z.TargetFinder
  - Z.TargetGroup
    
    Events
    
    Events
    notseen
    seen
    
    Functions
    
    Functions
    defaultScale( )
    defaultScale(...)
    trackingEnabled( )
    trackingEnabled(...)
    
    Z.TargetGroup
  - Z.TargetInstance
    
    Events
    
    Events
    notseen
    seen
    
    Functions
    
    Functions
    identifier( )
    useGyro( )
    useGyro(...)
    
    Z.TargetInstance
  - Z.Text
    
    Enumerations
    
    Enumerations
    HAlign
    Layout
    VAlign
    
    Functions
    
    Functions
    ellipsis( )
    ellipsis(...)
    font( )
    font(...)
    hAlign( )
    hAlign(...)
    layerMode( )
    layerMode(...)
    layout( )
    layout(...)
    lines( )
    lines(...)
    lineScale( )
    lineScale(...)
    lineSpacing( )
    lineSpacing(...)
    renderSorted( )
    renderSorted(...)
    shadow( )
    shadow(...)
    shadowColor( )
    shadowColor(...)
    text( )
    text(...)
    textColor( )
    textColor(...)
    vAlign( )
    vAlign(...)
    
    Z.Text
  - Z.Texture
    
    Enumerations
    
    Enumerations
    Channel
    Mipmap
    Wrap
    
    Functions
    
    Functions
    mipmap( )
    mipmap(...)
    position( )
    position(...)
    rotation( )
    rotation(...)
    scale( )
    scale(...)
    size( )
    wrap( )
    wrap(...)
    
    Z.Texture
  - Z.Timeline
    
    Functions
    
    Functions
    enqueue( )
    length( )
    play(...)
    reset( )
    stop( )
    time( )
    time(...)
    
    Z.Timeline
  - Z.TimelineLabel
    
    Events
    
    Events
    pass
    passbackwards
    passforward
    
    Functions
    
    Functions
    activate( )
    name( )
    play(...)
    time( )
    
    Z.TimelineLabel
  - Z.ToonMaterial
    
    Functions
    
    Functions
    ambientColor( )
    ambientColor(...)
    ambientMap( )
    ambientMap(...)
    diffuseColor( )
    diffuseColor(...)
    diffuseMap( )
    diffuseMap(...)
    emissiveMap( )
    emissiveMap(...)
    gammaCorrection( )
    gammaCorrection(...)
    gamma( )
    gamma(...)
    glossinessMap( )
    glossinessMap(...)
    numPixelLights( )
    numPixelLights(...)
    numShades( )
    numShades(...)
    opacity( )
    opacityMap( )
    opacityMap(...)
    opacity(...)
    outlineColor( )
    outlineColor(...)
    outline( )
    outline(...)
    outlineWidth( )
    outlineWidth(...)
    rimLightColor( )
    rimLightColor(...)
    rimLightCutoff( )
    rimLightCutoff(...)
    shininess( )
    shininess(...)
    specularColor( )
    specularColor(...)
    specularMap( )
    specularMap(...)
    useRimLight( )
    useRimLight(...)
    
    Z.ToonMaterial
  - Z.TransformedTexture
    
    Functions
    
    Functions
    texture( )
    texture(...)
    
    Z.TransformedTexture
  - Z.TriggerRegion
    
    Enumerations
    
    Enumerations
    Shape
    
    Events
    
    Events
    triggerenter
    triggerleave
    triggermove
    triggers
    
    Functions
    
    Functions
    reportLocalPosition( )
    reportLocalPosition(...)
    reportParentPosition( )
    reportParentPosition(...)
    shape( )
    shape(...)
    triggerTag( )
    triggerTag(...)
    
    Interfaces
    
    Interfaces
    TriggerEvent
    TriggerPresentEvent
    
    Z.TriggerRegion
  - Z.Vec3
    
    Functions
    
    Functions
    add(... , ...)
    dot(... , ...)
    magnitude(...)
    scalarMultiply(... , ...)
    subtract(... , ...)
    
    Z.Vec3
  - Z.Video
    
    Enumerations
    
    Enumerations
    ErrorReason
    
    Events
    
    Events
    aspectratio
    buffering
    duration
    error
    finish
    pause
    playing
    resize
    time
    
    Functions
    
    Functions
    aspectRatio( )
    duration( )
    pause( )
    restart( )
    size( )
    source( )
    source(...)
    start( )
    time( )
    time(...)
    volume( )
    volume(...)
    
    Z.Video
  - Z.VideoTexture
    
    Events
    
    Events
    finish
    
    Functions
    
    Functions
    mask( )
    mask(...)
    pause( )
    restart( )
    source( )
    source(...)
    start( )
    
    Z.VideoTexture
  - Reference
  - Z.Blend
  - Z.CullFaces
  - Z.LayerMode
  - Z.LightPriority
  - Z.Orientation
- Scripting
- Activating States with Scripts
- General Principles
- Scripting Tips and Tricks
- Scripts
- TypeScript Primer
VR Headsets
ZapBox
Advanced
Audio

Discord GitHub LinkedIn Twitter YouTube Email

On this page

Overview
Description

On this page

Overview
Description

Z.State

Description

Section titled “Description”

This object represents a state as created in ZapWorks Studio. See Controllers and States for more information.

Previous
reset( ) Next
Functions