Preparing search index...
The search index is not available
SDK Documentation - v7.0.0
SDK Documentation - v7.0.0
ECS
ReadonlyPrimitive
Type alias ReadonlyPrimitive
Readonly
Primitive
:
number
|
string
|
boolean
Documentation
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
SDK
Documentation -
v7.0.0
ECS
Append
Value
Operation
Avatar
Texture
Border
Rect
Camera
Transition
Color
Range
Component
Data
Composite
Composite
Component
Composite
Component_
Data
Entry
Composite
Definition
Crdt
Message
Protocol
Delete
Component
Delete
Component
Network
Delete
Entity
Delete
Entity
Network
Entity
Utils
Float
Range
Move
Move
Continuous
Move
Rotate
Scale
PBAnimation
State
PBAnimator
PBAsset
Load
PBAsset
Load
Loading
State
PBAudio
Analysis
PBAudio
Event
PBAudio
Source
PBAudio
Stream
PBAvatar
Attach
PBAvatar
Base
PBAvatar
Emote
Command
PBAvatar
Equipped
Data
PBAvatar
Locomotion
Settings
PBAvatar
Modifier
Area
PBAvatar
Nametag
PBAvatar
Shape
PBBillboard
PBCamera
Mode
PBCamera
Mode
Area
PBColor3
PBColor4
PBEngine
Info
PBExplorer
Ui
Events
Result
PBExplorer
Ui
Events
Result_
Ui
Closed
PBExplorer
Ui
Events
Result_
Ui
Opened
PBGltf
Container
PBGltf
Container
Loading
State
PBGltf
Node
Modifiers
PBGltf
Node
Modifiers_
Gltf
Node
Modifier
PBInput
Modifier
PBInput
Modifier_
Standard
Input
PBLight
Source
PBLight
Source_
Point
PBLight
Source_
Spot
PBMain
Camera
PBMaterial
PBMaterial_
Pbr
Material
PBMaterial_
Unlit
Material
PBMesh
Collider
PBMesh
Collider_
Box
Mesh
PBMesh
Collider_
Cylinder
Mesh
PBMesh
Collider_
Plane
Mesh
PBMesh
Collider_
Sphere
Mesh
PBMesh
Renderer
PBMesh
Renderer_
Box
Mesh
PBMesh
Renderer_
Cylinder
Mesh
PBMesh
Renderer_
Plane
Mesh
PBMesh
Renderer_
Sphere
Mesh
PBNft
Shape
PBParticle
System
PBParticle
System_
Box
PBParticle
System_
Burst
PBParticle
System_
Burst
Configuration
PBParticle
System_
Cone
PBParticle
System_
Limit
Velocity
PBParticle
System_
Point
PBParticle
System_
Sphere
PBParticle
System_
Sprite
Sheet
Animation
PBPhysics
Combined
Force
PBPhysics
Combined
Impulse
PBPlayer
Identity
Data
PBPointer
Events
PBPointer
Events
Result
PBPointer
Events_
Entry
PBPointer
Events_
Info
PBPointer
Lock
PBPosition
PBPrimary
Pointer
Info
PBQuaternion
PBRaycast
PBRaycast
Result
PBRealm
Info
PBSkybox
Time
PBText
Shape
PBTouch
Screen
Controls
PBTouch
Screen
Controls_
Touch
Input
PBTrigger
Area
PBTrigger
Area
Result
PBTrigger
Area
Result_
Trigger
PBTween
PBTween
Sequence
PBTween
State
PBUi
Background
PBUi
Canvas
Information
PBUi
Dropdown
PBUi
Dropdown
Result
PBUi
Input
PBUi
Input
Binding
PBUi
Input
Result
PBUi
Text
PBUi
Transform
PBVector2
PBVector3
PBVideo
Event
PBVideo
Player
PBVirtual
Camera
PBVisibility
Component
Put
Component
Operation
Put
Network
Component
Operation
Raycast
Hit
Rect
Rotate
Rotate
Continuous
Scale
Schemas
Texture
Texture
Move
Texture
Move
Continuous
Texture
Union
Video
Texture
Etherum
Provider
Math &
Colors
Color3
Color4
Matrix
Plane
Quaternion
Scalar
Vector2
Vector3
React
Ecs
React
Ecs
JSX
js-
runtime/apis
"~system/
Comms
Api"
"~system/
Communications
Controller"
"~system/
Engine
Api"
"~system/
Environment
Api"
"~system/
Ethereum
Controller"
"~system/
Players"
"~system/
Portable
Experiences"
"~system/
Restricted
Actions"
"~system/
Runtime"
"~system/
Scene"
"~system/
Signed
Fetch"
"~system/
Testing"
"~system/
User
Action
Module"
"~system/
User
Identity"
sdk/src/composite-
provider
sdk/src/ethereum-
provider/text-
encoder
sdk/src/network
sdk/src/network/binary-
message-
bus
sdk/src/network/entities
sdk/src/network/filter
sdk/src/network/message-
bus-
sync
sdk/src/network/state
sdk/src/network/utils
sdk/src/platform
sdk/src/players
sdk/src/text-
codec
Engine
are
Connected
create
Entity
Container
create
Input
System
create
Pointer
Events
System
create
Timers
create
Tween
System
cyclic
Parenting
Checker
execute
Task
get
Component
Entity
Tree
get
Composite
Provider
get
Composite
Root
Component
get
Default
Opts
get
Entities
With
Parent
get
Global
get
World
Position
get
World
Rotation
is
Equal
remove
Entity
With
Children
rotate
Vector
By
Quaternion
set
Composite
Provider
set
Global
Polyfill
Animator
Asset
Load
Asset
Load
Loading
State
Audio
Analysis
Audio
Event
Audio
Source
Audio
Stream
Avatar
Attach
Avatar
Base
Avatar
Emote
Command
Avatar
Equipped
Data
Avatar
Locomotion
Settings
Avatar
Modifier
Area
Avatar
Nametag
Avatar
Shape
Billboard
CRDT_
MESSAGE_
HEADER_
LENGTH
Camera
Mode
Camera
Mode
Area
Engine
Info
Explorer
Ui
Events
Result
Gltf
Container
Gltf
Container
Loading
State
Gltf
Node
Modifiers
Input
Modifier
Light
Source
Main
Camera
Material
Mesh
Collider
Mesh
Renderer
Name
Network
Entity
Network
Parent
Nft
Shape
Particle
System
Physics
Physics
Combined
Force
Physics
Combined
Impulse
Player
Identity
Data
Pointer
Events
Pointer
Events
Result
Pointer
Lock
Primary
Pointer
Info
RESERVED_
STATIC_
ENTITIES
Raycast
Raycast
Result
Realm
Info
SYSTEMS_
REGULAR_
PRIORITY
Skybox
Time
Sync
Components
Tags
Text
Shape
Touch
Screen
Controls
Transform
Trigger
Area
Trigger
Area
Result
Tween
Tween
Sequence
Tween
State
Ui
Background
Ui
Canvas
Information
Ui
Dropdown
Ui
Dropdown
Result
Ui
Input
Ui
Input
Binding
Ui
Input
Result
Ui
Text
Ui
Transform
Video
Event
Video
Player
Virtual
Camera
Visibility
Component
asset
Load
Loading
State
System
audio
Events
System
component
Definition
By
Name
engine
input
System
pointer
Events
System
raycast
System
timers
trigger
Area
Events
System
tween
System
video
Events
System
Animator
Component
Definition
Extended
Asset
Load
Loading
State
System
Audio
Analysis
Component
Definition
Extended
Audio
Events
System
Audio
Source
Component
Definition
Extended
Audio
Stream
Component
Definition
Extended
Avatar
Texture
Base
Component
Border
Rect
Byte
Buffer
Camera
Transition
Camera
Transition
Helper
Color
Range
Component
Data
Composite
Component
Composite
Component_
Data
Entry
Composite
Definition
Flat
Material
Flat
Texture
Float
Range
Grow
Only
Value
Set
Component
Definition
IEngine
IEngine
Options
INetowrk
Entity
Type
INetowrk
Parent
Type
ISchema
ISync
Components
Type
Input
Modifier
Component
Definition
Extended
Input
Modifier
Helper
Last
Write
Win
Element
Set
Component
Definition
Light
Source
Component
Definition
Extended
Light
Source
Helper
Map
Component
Definition
Material
Component
Definition
Extended
Mesh
Collider
Component
Definition
Extended
Mesh
Renderer
Component
Definition
Extended
Move
Move
Continuous
Move
Rotate
Scale
Move
Rotate
Scale
Mode
Params
Name
Type
PBAnimation
State
PBAnimator
PBAsset
Load
PBAsset
Load
Loading
State
PBAudio
Analysis
PBAudio
Event
PBAudio
Source
PBAudio
Stream
PBAvatar
Attach
PBAvatar
Base
PBAvatar
Emote
Command
PBAvatar
Equipped
Data
PBAvatar
Locomotion
Settings
PBAvatar
Modifier
Area
PBAvatar
Nametag
PBAvatar
Shape
PBBillboard
PBCamera
Mode
PBCamera
Mode
Area
PBColor3
PBColor4
PBEngine
Info
PBExplorer
Ui
Events
Result
PBExplorer
Ui
Events
Result_
Ui
Closed
PBExplorer
Ui
Events
Result_
Ui
Opened
PBGltf
Container
PBGltf
Container
Loading
State
PBGltf
Node
Modifiers
PBGltf
Node
Modifiers_
Gltf
Node
Modifier
PBInput
Modifier
PBInput
Modifier_
Standard
Input
PBLight
Source
PBLight
Source_
Point
PBLight
Source_
Spot
PBMain
Camera
PBMaterial
PBMaterial_
Pbr
Material
PBMaterial_
Unlit
Material
PBMesh
Collider
PBMesh
Collider_
Box
Mesh
PBMesh
Collider_
Cylinder
Mesh
PBMesh
Collider_
Plane
Mesh
PBMesh
Collider_
Sphere
Mesh
PBMesh
Renderer
PBMesh
Renderer_
Box
Mesh
PBMesh
Renderer_
Cylinder
Mesh
PBMesh
Renderer_
Plane
Mesh
PBMesh
Renderer_
Sphere
Mesh
PBNft
Shape
PBParticle
System
PBParticle
System_
Box
PBParticle
System_
Burst
PBParticle
System_
Burst
Configuration
PBParticle
System_
Cone
PBParticle
System_
Limit
Velocity
PBParticle
System_
Point
PBParticle
System_
Sphere
PBParticle
System_
Sprite
Sheet
Animation
PBPhysics
Combined
Force
PBPhysics
Combined
Impulse
PBPlayer
Identity
Data
PBPointer
Events
PBPointer
Events
Result
PBPointer
Events_
Entry
PBPointer
Events_
Info
PBPointer
Lock
PBPosition
PBPrimary
Pointer
Info
PBQuaternion
PBRaycast
PBRaycast
Result
PBRealm
Info
PBSkybox
Time
PBText
Shape
PBTouch
Screen
Controls
PBTouch
Screen
Controls_
Touch
Input
PBTrigger
Area
PBTrigger
Area
Result
PBTrigger
Area
Result_
Trigger
PBTween
PBTween
Sequence
PBTween
State
PBUi
Background
PBUi
Canvas
Information
PBUi
Dropdown
PBUi
Dropdown
Result
PBUi
Input
PBUi
Input
Binding
PBUi
Input
Result
PBUi
Text
PBUi
Transform
PBVector2
PBVector3
PBVideo
Event
PBVideo
Player
PBVirtual
Camera
PBVisibility
Component
Particle
System
Component
Definition
Extended
Particle
System
Helper
Physics
System
Pointer
Events
System
Raycast
Hit
Raycast
System
Readonly
Flat
Material
Readonly
Flat
Texture
Rect
Rotate
Rotate
Continuous
Scale
Set
Move
Rotate
Scale
Params
Spec
Tags
Component
Definition
Extended
Tags
Type
Texture
Texture
Helper
Texture
Move
Texture
Move
Continuous
Texture
Union
Touch
Screen
Controls
Component
Definition
Extended
Transform
Component
Extended
Trigger
Area
Component
Definition
Extended
Trigger
Area
Events
System
Tween
Component
Definition
Extended
Tween
Helper
Video
Events
System
Video
Texture
Virtual
Camera
Component
Definition
Extended
Append
Value
Message
Append
Value
Message
Body
Asset
Load
Loading
State
System
Callback
Audio
Analysis
View
Audio
Events
System
Callback
Color3
Type
Color4
Type
Component
Definition
Composite
Composite
Provider
Composite
Resource
Composite
Root
Type
Conflict
Resolution
Message
Coords
Crdt
Message
Crdt
Message
Body
Crdt
Message
Header
Crdt
Network
Message
Body
Deep
Readonly
Deep
Readonly
Map
Deep
Readonly
Object
Deep
Readonly
Set
Delete
Component
Message
Delete
Component
Message
Body
Delete
Component
Network
Message
Delete
Component
Network
Message
Body
Delete
Entity
Message
Delete
Entity
Message
Body
Delete
Entity
Network
Message
Delete
Entity
Network
Message
Body
Entity
Event
System
Callback
Event
System
Options
Exclude
Undefined
GSet
Component
Getter
Global
Direction
Raycast
Options
Global
Direction
Raycast
System
Options
Global
Target
Raycast
Options
Global
Target
Raycast
System
Options
IEntity
Container
IInput
System
INetowrk
Entity
INetowrk
Parent
ISync
Components
Include
Undefined
Instance
Composite
Options
Json
Array
Json
Map
Json
Primitive
Json
Schema
Extended
Local
Direction
Raycast
Options
Local
Direction
Raycast
System
Options
Lww
Component
Getter
Map
Result
Name
Component
On
Change
Function
Only
Non
Undefined
Types
Only
Optional
Undefined
Types
Put
Component
Message
Put
Component
Message
Body
Put
Network
Component
Message
Put
Network
Component
Message
Body
Quaternion
Type
Raycast
System
Callback
Raycast
System
Options
Read
Only
Grow
Only
Value
Set
Component
Definition
Read
Only
Last
Write
Win
Element
Set
Component
Definition
Readonly
Component
Schema
Readonly
Primitive
Receive
Message
System
Fn
System
Item
Target
Entity
Raycast
Options
Target
Entity
Raycast
System
Options
Task
Timer
Callback
Timer
Id
Timers
To
Optional
Transform
Component
Transform
Type
Transform
Type
With
Optionals
Transport
Transport
Message
Trigger
Area
Event
System
Callback
Tween
System
Unpacked
Value
Set
Options
Vector3
Type
Video
Events
System
Callback
World
Transform
Engine
uint32
Avatar
Anchor
Point
Type
Avatar
Mask
Avatar
Modifier
Type
Background
Texture
Mode
Billboard
Mode
Camera
Type
Collider
Layer
Component
Type
Crdt
Message
Type
Easing
Function
Emote
State
Entity
Mapping
Mode
Entity
State
Explorer
Ui
Font
Input
Action
Interaction
Type
Knockback
Falloff
Loading
State
Material
Transparency
Mode
Media
State
Nft
Frame
Type
PBAudio
Analysis
Mode
PBParticle
System_
Simulation
Space
Particle
System
Blend
Mode
Particle
System
Playback
State
Pointer
Event
Type
Pointer
Filter
Mode
Pointer
Type
Process
Message
Result
Type
Raycast
Query
Type
Text
Align
Mode
Text
Wrap
Texture
Filter
Mode
Texture
Movement
Type
Texture
Wrap
Mode
Transition
Mode
Trigger
Area
Event
Type
Trigger
Area
Mesh
Type
Tween
Loop
Tween
State
Status
Video
State
YGAlign
YGDisplay
YGEdge
YGFlex
Direction
YGJustify
YGOverflow
YGPosition
Type
YGUnit
YGWrap
PBParticle
System_
Blend
Mode
PBParticle
System_
Playback
State