GitHubGitHub (opens in a new tab)DiscordDiscord (opens in a new tab)
  • Start
  • Script Lifecycle
  • Components
  • Behaviors
  • Animations
  • Working With Physics
  • Multiplayer
  • Prefabs And Groups
  • User Interface (JSX)
  • Builtin Libraries
    • Getting Started Course
    • Studio Guide
    • Remixing a Template
    • Remix - Flappy Bome
    • Working with GPT
  • API Reference
    • Abstractparam
      • Bindable
      • Datakey
      • Defaultvalue
      • Format
      • Group
      • Info
      • Label
      • Name
      • Skiplabel
      • Usefolder
      • Visible
    • Ai
      • Embed
      • Embedmany
      • Generateobject
      • Generatetext
      • Providers
      • Streamtext
      • Tool
      • Z
    • Aiembedoptions
      • Abortsignal
      • Headers
      • Maxretries
      • Model
      • Value
      • Values
    • Aigenoptions
      • Messages
      • Model
      • Prompt
      • Temperature
      • Topp
    • Aitool
      • Description
      • Execute
      • Parameters
    • Alert
    • Animationparam
      • Defaultvalue
      • Type
    • Arrayparam
      • Itemparam
      • Readonly
      • Type
    • Audiocomponent
      • Ambient
      • Audio
      • Autoplay
      • Changecallbacks
      • Dispose
      • Init
      • Isplaying
      • Loop
      • Pause
      • Pausetrigger
      • Play
      • Playbackrate
      • Playtrigger
      • Stop
      • Volume
    • Audiocomponentdata
      • Ambient
      • Autoplay
      • Id
      • Loop
      • Name
      • Playbackrate
      • Position
      • Rotation
      • Scale
      • Type
      • URL
      • Volume
    • Avatarcomponent
      • Activeanimations
      • Animation
      • Animationlistupdated
      • Avatarscale
      • Dispose
      • Getbboximp
      • Getbone
      • Getdimensions
      • Getrawbbox
      • Gettransformdata
      • Ignorelod
      • Init
      • Oncreatecollisionmesh
      • Onmixerupdate
      • Opacity
      • Picture
      • Play
      • Plugins
      • Rendermode
      • Stop
      • Stopall
      • Text
      • Updateanimationmode
      • Updateplugins
      • Updaterendermode
      • Updatesettings
      • Updatevrm
      • URL
      • Usemixer
      • Visible
      • Vrmurl
    • Avatarcomponentdata
      • Animation
      • Id
      • Ignorelod
      • Image
      • Name
      • Opacity
      • Picture
      • Plugins
      • Position
      • Rendermode
      • Rotation
      • Scale
      • Text
      • Type
      • URL
      • Urlcompressed
      • Usemixer
    • Backgroundcomponent
      • Setcolor
    • Baseintersectionevent
      • Frame
      • Me
      • Other
    • Baseroomstate
      • Addplayer
      • Players
      • Removeplayer
      • Settings
      • Snapshotid
      • Timestamp
    • Basiccharactercontroller
      • Accumulator
      • Castcallback
      • Castsensors
      • Constructor
      • Controlvelocity
      • Dampling
      • Disableevents
      • Firstframe
      • Forces
      • Getccstate
      • Gravity
      • Logs
      • Logvec3
      • Onfloor
      • Previousvelocity
      • Rotation
      • Update
      • Updatecollisionstate
      • Updateintersectionstate
      • Velocity
    • Behavior
    • Behavioroptions
      • Description
      • Image
      • Imagexl
      • Server
      • Tip
      • Title
    • Birdcomponent
      • Color
      • Dispose
      • Init
      • Oncreatecollisionmesh
      • Opacity
    • Birdcomponentdata
      • Color
      • Id
      • Name
      • Opacity
      • Position
      • Rotation
      • Scale
      • Type
    • Bone
    • Bones
    • Booleanparam
      • Defaultvalue
      • Type
    • Boxparamsdata
      • Depth
      • Height
      • Width
    • Bulletcomponent
    • Bulletcomponentdata
      • Direction
      • Id
      • Name
      • Position
      • Rotation
      • Scale
      • Speed
      • Type
    • Camera
    • Canvas
    • Cgameclient
      • Join
      • Leave
      • Ondisconnect
      • Onmessage
      • Onmessage1
      • Onstate
      • Onstatuschange
      • Reconnect
      • Room
      • Send
      • Send1
      • State
      • Status
      • Synced
    • Clientprovider
      • Constructor
      • Send
    • Cloudcomponent
      • Atlas
      • Getinstancewrapper
      • Init
      • Opacity
    • Cloudcomponentdata
      • Atlas
      • Id
      • Name
      • Opacity
      • Position
      • Rotation
      • Scale
      • Type
    • Collider
      • Collider
      • Colliderdesc
      • Collidertype
      • Component
      • Enabled
      • Enabledrotation
      • Enabledtranslation
      • Issensor
      • Name
      • Rigidbody
      • Rigidbodytype
    • Collidertype
    • Collisionenterevent
      • Contactpoints
    • Collisionexitevent
    • Color
    • Colorparam
      • Defaultvalue
      • Type
    • Component
    • Component3d
      • Behaviors
      • Childcomponents
      • Collider
      • Componentid
      • Componentname
      • Componenttype
      • Data
      • Datachangelistener
      • Destroy
      • Dispose
      • Duplicate
      • Geometry
      • Getbbox
      • Getbehavior
      • Getbehaviors
      • Getdimensions
      • Identifier
      • Init
      • Isbehavior
      • Isdescendantof
      • Ispersistent
      • Material
      • Off
      • On
      • Oncollisionenter
      • Oncollisionexit
      • Oncollisionstay
      • Oncreatecollisionmesh
      • Ondatachangesync
      • Onsensorenter
      • Onsensorexit
      • Onsensorstay
      • Opts
      • Parentcomponent
      • Positionworld
      • Quaternionworld
      • Rigidbody
      • Rotationworld
      • Scaleworld
      • Sessionid
      • Space
      • Tag
      • Updatedata
    • Component3ddata
      • Batchid
      • Children
      • Collider
      • Id
      • Name
      • Parentid
      • Script
      • Type
    • Componentmanager
      • Addloadtask
      • Byid
      • Byinternalid
      • Byname
      • Bytag
      • Bytype
      • Components
      • Create
      • Destroy
      • Duplicate
      • Filter
      • Find
      • Foreach
      • Isloading
      • Loaded
      • Onspaceloaded
      • Updatecomponenttag
    • Componentoptions
      • Batchdraw
      • Draggable
      • Singleton
      • Transform
    • Componentparam
      • Required
      • Type
      • Typeof
    • Components
    • Componenttypes
    • Config
    • Contactpoint
      • Depth
      • Normal
      • Position
    • Contractof
    • Controls
    • Controlsfactory
      • Get
      • Getcontrollerfor
    • Controlsfactoryopts
      • Object
      • Params
      • Target
      • Type
    • Controlsparams
    • Controlstype
    • Cylinderparamsdata
      • Height
      • Heightsegments
      • Openended
      • Radialsegments
      • Radiusbottom
      • Radiustop
    • Debugorbitcontrolswrapper
      • Active
    • Defaultcontrolparams
      • Animations
      • Autoanimate
      • Character
      • Gravity
      • Jump
      • Run
    • Defaultcontrolswrapper
      • Actions
      • Active
      • Advancedanimations
      • Animation
      • Animations
      • Animstate
      • Autoanimate
      • Autorotate
      • Autoupdate
      • Calcvelocity
      • Charactercontroller
      • Collideswith
      • Constructor
      • Controller
      • Direction
      • Dirtyjoystick
      • Gravity
      • Jump
      • Jumppromise
      • Jumpstate
      • Keyactive
      • Playanimationifnotplaying
      • Playanimationonceifnotplaying
      • Prevdirection
      • Quaternion
      • Reset
      • Restorestate
      • Run
      • Savestate
      • Seqid
      • Setforce
      • Showjoystick
      • State
      • Targetquaternion
      • Targetrot
      • Triggerjump
      • Update
      • Velocity
    • Device
      • Ismobile
      • Istouch
      • Isvr
      • Language
      • Orientation
      • Os
      • Quality
    • Dustcomponent