GitHubGitHub (opens in a new tab)DiscordDiscord (opens in a new tab)
  • Ask AI
  • Welcome
    • Getting Started Course
    • Studio Guide
    • Remixing a Template
    • Remix - Flappy Bome
    • Working with GPT
  • Scripts Lifecycle
  • Using Components
  • Playing Animations
  • Behaviors
  • Custom Components
    • Introduction
    • Control From Code
    • Custom Controls
  • Prefabs And Groups
  • Working With Physics
  • Rendering UI
  • Multiplayer
  • Custom Server
  • Builtin Libraries
  • API Reference
    • Abstractparam
      • Bindable
      • Datakey
      • Format
      • Info
      • Name
      • Visible
    • Alert
    • Animationparam
      • Defaultvalue
      • Type
    • Audiocomponent
      • Ambient
      • 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
      • Getdimensions
      • Getrawbbox
      • Gettransformdata
      • Ignorelod
      • Init
      • Oncreatecollisionmesh
      • Opacity
      • Picture
      • Play
      • Plugins
      • Rendermode
      • Stop
      • 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
      • Snapshotid
      • Timestamp
    • Basiccharactercontroller
      • Accumulator
      • Castcallback
      • Castsensors
      • Constructor
      • Controlvelocity
      • Dampling
      • Firstframe
      • Forces
      • Getccstate
      • Gravity
      • Onfloor
      • Previousvelocity
      • Rotation
      • Update
      • Updatecollisionstate
      • Updateintersectionstate
      • Velocity
    • Behavior
    • Behavioroptions
      • Description
      • Image
      • Imagexl
      • Tip
      • Title
    • Birdcomponent
      • Color
      • Dispose
      • Init
      • Oncreatecollisionmesh
      • Opacity
    • Birdcomponentdata
      • Color
      • Id
      • Name
      • Opacity
      • Position
      • Rotation
      • Scale
      • Type
    • Booleanparam
      • Defaultvalue
      • Type
    • Boxparamsdata
      • Depth
      • Height
      • Width
    • Bulletcomponent
    • Bulletcomponentdata
      • Direction
      • Id
      • Name
      • Position
      • Rotation
      • Scale
      • Speed
      • Type
    • Camera
    • Canvas
    • Cgameclient
      • Join
    • 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
      • Isdescendantof
      • Ispersistent
      • Material
      • Off
      • On
      • Oncollisionenter
      • Oncollisionexit
      • Oncollisionstay
      • Oncreatecollisionmesh
      • Ondatachangesync
      • Onsensorenter
      • Onsensorexit
      • Onsensorstay
      • Opts
      • Parentcomponent
      • Positionworld
      • Quaternionworld
      • Rigidbody
      • Rotationworld
      • Scaleworld
      • Tag
    • Component3ddata
      • Batchid
      • Children
      • Collider
      • Id
      • Name
      • Parentid
      • Script
      • Type
    • Componentmanager
      • Addloadtask
      • Byid
      • Byinternalid
      • Byname
      • Bytag
      • Bytype
      • Components
      • Create
      • Destroy
      • Duplicate
      • Filter
      • Find
      • Foreach
      • 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
    • Device
      • Ismobile
      • Istouch
      • Isvr
      • Language
      • Orientation
      • Os
      • Quality
    • Dustcomponent
    • Dustcomponentdata
      • Condition
      • Decayspeed
      • Id
      • Name
      • Randomxz
      • Scale
      • Spawndistance
      • Spawnsource
      • Target
      • Type
    • Emitter
    • Env
    • Envmapcomponent
      • Dispose
      • Init
    • Events
    • Firstpersoncameracontrolswrapper
      • Active
    • Flycameracontrolswrapper
      • Active
    • Fogcomponent
      • Dispose
      • Far
      • Init
      • Near
    • Folder
    • Formats
    • Gameclient
    • Gameroom
      • Getplayerstatesync
      • Host
      • Interpolator
      • Isgameloop
      • Ishost
      • Lasterror
      • Leave
      • Onconnect
      • Ondisconnect
      • Onmessage
      • Onplayerjoined
      • Onplayerleft
      • Onstart
      • Onstate
      • Onstop
      • Onsync
      • Players
      • Ready
      • Remoteplayeropts
      • Requeststart
      • Roomid
      • Send
      • Sessionid
      • State
      • Status
      • Synced
      • Tickrate
    • Gamestorage
    • Gamestorageapi
      • Get
      • Getall
      • Getplayerdata
      • Set
      • Setplayerdata
    • Getter
    • Godraycomponent
      • Color
      • Dispose
      • Init
      • Opacity
    • Godraycomponentdata
      • Color
      • Id
      • Name
      • Opacity
      • Position
      • Rotation
      • Scale
      • Type
    • Groupparam
      • Type
    • Imagecomponent
      • Changecallbacks
      • Dispose
      • Getbboximp
      • Init
      • Oncreatecollisionmesh
      • Opacity
    • Imagecomponentdata
      • Id
      • Name
      • Opacity
      • Position
      • Rotation
      • Scale
      • Type
      • URL
    • Imageparam
      • Accept
      • Acceptlabel
      • Action
      • Type
    • Joinroomopts
      • Disablesnapshots
      • Host
      • Multiroom
      • Remoteplayeropts
      • Roomid
    • Kitbashcomponent
      • Getplugins
      • Setplugins
    • Kitbashcomponentdata
      • Id
      • Kittype
      • Name
      • Position
      • Rotation
      • Scale
      • Type
    • Lightingcomponent
      • Dispose
      • Init
    • Magneticfieldcomponent
      • Changecallbacks
      • Color
      • Dispose
      • Init
      • Radius
    • Magneticfieldcomponentdata
      • Color
      • Id
      • Name
      • Position
      • Radius
      • Rotation
      • Type
    • Maincamera
      • Controls
      • Disablecollision
      • Disablewheelzoom
      • Heightoffset
      • Maxzoomout
      • Mode
      • Target
      • Usecontrols
      • Usepointerlock
    • Materials
      • Basic
      • Lambert
      • Standard
      • Toon
    • Meshcomponent
      • Color
      • Dispose
      • Geometrydata
      • Getcollisionmesh
      • Init
      • Mesh
      • Opacity
      • Updaterendermode
    • Meshcomponentdata
      • Color
      • Display
      • Displayineditor
      • Displayinworld
      • Geometry
      • Id
      • Name
      • Opacity
      • Position
      • Rendermode
      • Rotation
      • Scale
      • Type
    • Meshgeometrydata
      • Boxparams
      • Cylinderparams
      • Sphereparams
      • Type
    • Modelcomponent
      • Dispose
      • Enableanimation
      • Getanimationdata
      • Getinstancewrapper
      • Init
      • Mixer
      • Opacity
      • Play
      • Rendermode
      • Setanimationattime
      • Stop
      • Stopall
      • Updatefromsource
      • Updaterendermode
    • Modelcomponentdata
      • Animations
      • Enableanimation
      • Enablerealtimeshadow
      • Id
      • Name
      • Opacity
      • Position
      • Rendermode
      • Rotation
      • Scale
      • Type
      • URL
      • Usetransparency
    • Numberparam
      • Defaultvalue
      • Max
      • Min
      • Step
      • Type
    • Ooobjects
    • Ooui
    • Page
    • Param
    • Param1
    • Paramkey
    • Paramoptions
    • Pcactions
      • Backward
      • Forward
      • Jump
      • Left
      • Right
      • Run
    • Pcjumpparams
      • Height
    • Pcrunparams
      • Boost
      • Maxspeed
    • Physics
    • Physicsdata
      • Collidertype
      • Dynamicprops
      • Enabled
      • Enabledrotation
      • Enabledtranslation
      • Groups
      • Rigidbodytype
      • Rotationlock
      • Sensor
      • Translationlock
    • Physicsrapierwrapper
      • Active
      • Eventqueue
      • Frame
      • Narrowphase
      • Raycast
      • Update
      • World
    • Platformcomponent
      • Dispose
      • Init
      • Oncreatecollisionmesh
      • Update3d
    • Platformcomponentdata
      • Id
      • Name
      • Position
      • Rotation
      • Scale
      • Type
    • Platformercontrolswrapper
      • Actions
      • Active
      • Autorotate
      • Collideswith
      • Controller
      • Dispose
      • Isjumping
      • Ismoving
      • Onfloor
    • Platformercontrolswrapperparams
      • Autoanimate
      • Jump
      • Run
    • Platformerinputcontroller
      • Active
      • Oninput
      • Showjoystick
    • Player
    • Playeravataropts
      • Avatarscale
      • Collision
      • Spawndata
      • Usemixer
    • Playerdata
      • Animation
      • Avatarurl
      • Isanonymous
      • Jitter
      • Latency
      • Main
      • Name
      • Plugins
      • Position
      • Role
      • Rotation
      • Sessionid
      • Userid
      • Vrmurl
    • Playermanager
      • Main
      • Opts
      • Players
    • Players
    • Playerwrapper
      • Avatar
      • Avatardata
      • Avatarready
      • Data
      • Events
      • Getavatardata
      • Isanonymous
      • Ishost
      • Name
      • Onuserchange
      • Onuserdatachange
      • Sessionid
      • Setavatardata
      • Setotheravatardata
      • Userid
    • Plugins
      • Generative
      • Materials
      • Physics
      • Sorters
      • Visuals
    • Postprocessingcomponent
      • Dispose
      • Init
    • Prefabresource
      • Addchild
      • Attachinstance
      • Base
      • Children
      • Constructor
      • Create
      • Datawrapper
      • Dependson
      • Detachinstance
      • Directextends
      • Dispose
      • Extends
      • Getdirectvariants
      • Getvariants
      • Hascomponentfactory
      • Hasdependentcomponents
      • Instantiate
      • Ischildaddoverride
      • Iscomponent
      • Isdirecttypeof
      • Istypeof
      • Meta
      • Opts
      • Parent
      • Removechild
    • Prefabresourcedata
      • Children
      • Index
      • Meta
      • Parentid
      • Template
      • Type
    • Presetoptions
      • Data
      • Image
      • Name
    • Presets
    • Proxyemitter
      • Emit
      • On
    • Raincomponent
      • Dispose
      • Init
      • Intensity
    • Receiver
    • Receiveroptions
    • Reflectorcomponent
      • Blur
      • Color
      • Dispose
      • Init
      • Oncreatecollisionmesh
      • Opacity
    • Resource
      • Base
      • Constructor
      • Data
      • Dependson
      • Destroy
      • Dispose
      • Getdependentresources
      • Getdirectinstances
      • Getinstances
      • Getrequiredresources
      • Hascomponentfactory
      • Hasdependentcomponents
      • Hasdependentresources
      • Hasreferences
      • Id
      • Iscomponent
      • Isdirecttypeof
      • Isprefab
      • Isrefbycomponent
      • Isrefbyresource
      • Isscript
      • Istypeof
      • Ondispose
      • Parent
      • Resourcefactory
      • Space
      • State
    • Resourcedata
      • Id
      • Image
      • Kit
      • Name
      • Type
    • Resourceparam
      • Required
      • Type
      • Typeof
    • Rigidbodytype
    • Rigidbodywrapper
      • Addcollider
      • Addcolliderfromoptions
      • Addforce
      • Addtorque
      • Applyimpulse
      • Colliders
      • Component
      • Constructor
      • Currentrbposition
      • Dispose
      • Enabled
      • Isdynamic
      • Isfixed
      • Iskinematic
      • Options
      • Position
      • Preinterpolate
      • Prevrbposition
      • Quaternion
      • Raw
      • Rbposition
      • Removecollider
      • Reset
      • Resetforces
      • Resettorques
      • Resetvelocities
      • Rotationlock
      • Teleport
      • Translationlock
      • Updateactiveevents
      • Updatecolliders
    • Scriptbehavior
      • Host
    • Scriptcomponent
      • Config
      • Create
      • Geometry
      • Getinstances
      • Getmain
      • Handlecollisionenter
      • Handlecollisionexit
      • Handlecollisionstay
      • Handlesensorenter
      • Handlesensorexit
      • Handlesensorstay
      • Host
      • Instances
      • Main
      • Material
      • Ondispose
      • Oneditordetailmeshclicked
      • Oneditordetailmeshmouseenter
      • Oneditordetailmeshmouseleave
      • Oneditorgetdetailmeshes
      • Oneditorgetmeshes
      • Oneditormeshclicked
      • Oneditormeshmouseenter
      • Oneditormeshmouseleave
      • Onend
      • Onfixedupdate
      • Onframe
      • Ongetcollisionmesh
      • Onload
      • Onpause
      • Onpreload
      • Onready
      • Onrenderdispose
      • Onrenderinit
      • Onrenderupdate
      • Onresume
      • Onstart
      • Onupdate
    • Scriptdata
      • Identifier
      • Tag
    • Scriptparam
    • Seconds
    • Selectparam
      • Defaultvalue
      • Mode
      • Options
      • Type
    • Sensorevent
    • Shadowfloorcomponent
      • Collision
      • Dispose
      • Init
      • Oncollisioncallback
      • Oncreatecollisionmesh
    • Shared
    • Signal
    • Signaloptions
    • Space
      • Camera
      • Captureframe
      • Components
      • Options
      • Pause
      • Physics
      • Registry
      • Resources
      • Resume
      • Start
      • Stop
    • Spawncomponent
      • Dispose
      • Getavatarrotation
      • Init
      • Tmpeuler
    • Sphereparamsdata
      • Heightsegments
      • Radius
      • Widthsegments
    • Store
      • Constructor
      • Getstate
      • Notify
      • State
      • Subscribe
      • Update
    • Stringparam
      • Defaultvalue
      • Type
    • Terraincomponent
      • Dispose
      • Getbboximp
      • Init
      • Oncreatecollisionmesh
    • Textcomponent
      • Align
      • Color
      • Dispose
      • Font
      • Init
      • Lineheight
      • Opacity
      • Text
      • Textcolor
      • Texttransform
      • Update
      • Width
    • Textcomponentdata
      • Align
      • Font
      • Id
      • Instanced
      • Instancedbillboard
      • Lineheight
      • Name
      • Opacity
      • Position
      • Rotation
      • Scale
      • Text
      • Textcolor
      • Texttransform
      • Type
      • Width
    • Thirdpersoncameracontrolswrapper
      • Active
      • Cameraaltitudemaxdistance
      • Cameraaltitudesmoothing
      • Cameravirtualtarget
      • Controller
      • Disablecollision
      • Disablewheelzoom
      • Getidealdata
      • Heightoffset
      • Lerp
      • Lerpspherical
      • Lockaxis
      • Maxzoomout
      • Smoothfactor
      • Smoothmethod
      • Usepointerlock
    • Thirdpersoncameracontrolswrapperparams
      • Cameraaltitudemaxdistance
      • Cameraaltitudesmoothing
      • Heightoffset
      • Maxzoomout
      • Sensitivity
    • Transformconfigopts
    • Transformconfigxyzopt
    • Trigger
    • Triggeroptions
    • UI
    • Uiapis
    • Usestore
    • Utils
      • Default
    • Vec2param
      • Defaultvalue
      • Type
    • Vec3param
      • Defaultvalue
      • Type
    • Videocomponent
      • Autoplay
      • Curvedangle
      • Displaymode
      • Dispose
      • Getbboximp
      • Init
      • Isplaying
      • Muted
      • Opacity
      • Pause
      • Play
      • Volume
    • Videocomponentdata
      • Autoplay
      • Curvedangle
      • Displaymode
      • Id
      • Muted
      • Name
      • Opacity
      • Position
      • Preview
      • Rotation
      • Scale
      • Type
      • URL
      • Volume
    • Watercomponent
      • Dispose
      • Init
    • Wavecomponent
      • Color
      • Direction
      • Linewidth
      • Radius
    • Wavecomponentdata
      • Color
      • Direction
      • Divisions
      • Height
      • Id
      • Lines
      • Linewidth
      • Name
      • Position
      • Radius
      • Rotation
      • Type
    • Web3
    • Web3api
      • Abi
      • Contract
      • Emit
      • Ethtogwei
      • Ethtowei
      • Gweitoeth
      • Gweitowei
      • Requestaddress
      • Requestbalance
      • Signmessage
      • Weitoeth
      • Weitogwei
    • Windcomponent
      • Regenerate
      • Wind
    • Windcomponentdata
      • Divisions
      • Height
      • Id
      • Lineheight
      • Linewidth
      • Name
      • Position
      • Radius
      • Type
    • World
    • Xyz
      • X
      • Y
      • Z

On This Page

  • PlayerData.role property
Question? Give us feedback → (opens in a new tab)Edit this page
API Reference
Playerdata
Role

PlayerData.role property

Signature:

role?: PlayerRole;