• Preparing search index...
  • The search index is not available
SDK Documentation - v7.0.0
  • SDK Documentation - v7.0.0
  • js-runtime/apis
  • "~system/EngineApi"
  • crdtGetState

Function crdtGetState

  • crdtGetState(body: CrdtSendToRendererRequest): Promise<CrdtGetStateResponse>
  • retrieves the current full state of the entities from the renderer. This function is used to hidrate the state of the scenes when the code of the worker is stopped/resumed

    Parameters

    • body: CrdtSendToRendererRequest

    Returns Promise<CrdtGetStateResponse>

    • Defined in js-runtime/apis.d.ts:930
Documentation

Settings

Member Visibility

Theme

Modules

  • SDK Documentation - v7.0.0
    • ECS
      • AppendValueOperation
      • AvatarTexture
      • BorderRect
      • CameraTransition
      • ComponentData
      • Composite
      • CompositeComponent
      • CompositeComponent_DataEntry
      • CompositeDefinition
      • CrdtMessageProtocol
      • DeleteComponent
      • DeleteComponentNetwork
      • DeleteEntity
      • DeleteEntityNetwork
      • EntityUtils
      • Move
      • PBAnimationState
      • PBAnimator
      • PBAudioEvent
      • PBAudioSource
      • PBAudioStream
      • PBAvatarAttach
      • PBAvatarBase
      • PBAvatarEmoteCommand
      • PBAvatarEquippedData
      • PBAvatarModifierArea
      • PBAvatarShape
      • PBBillboard
      • PBCameraMode
      • PBCameraModeArea
      • PBColor3
      • PBColor4
      • PBEngineInfo
      • PBGltfContainer
      • PBGltfContainerLoadingState
      • PBInputModifier
      • PBInputModifier_StandardInput
      • PBMainCamera
      • PBMaterial
      • PBMaterial_PbrMaterial
      • PBMaterial_UnlitMaterial
      • PBMeshCollider
      • PBMeshCollider_BoxMesh
      • PBMeshCollider_CylinderMesh
      • PBMeshCollider_PlaneMesh
      • PBMeshCollider_SphereMesh
      • PBMeshRenderer
      • PBMeshRenderer_BoxMesh
      • PBMeshRenderer_CylinderMesh
      • PBMeshRenderer_PlaneMesh
      • PBMeshRenderer_SphereMesh
      • PBNftShape
      • PBPlayerIdentityData
      • PBPointerEvents
      • PBPointerEventsResult
      • PBPointerEvents_Entry
      • PBPointerEvents_Info
      • PBPointerLock
      • PBPosition
      • PBQuaternion
      • PBRaycast
      • PBRaycastResult
      • PBRealmInfo
      • PBTextShape
      • PBTween
      • PBTweenSequence
      • PBTweenState
      • PBUiBackground
      • PBUiCanvasInformation
      • PBUiDropdown
      • PBUiDropdownResult
      • PBUiInput
      • PBUiInputResult
      • PBUiText
      • PBUiTransform
      • PBVector2
      • PBVector3
      • PBVideoEvent
      • PBVideoPlayer
      • PBVirtualCamera
      • PBVisibilityComponent
      • PutComponentOperation
      • PutNetworkComponentOperation
      • RaycastHit
      • Rect
      • Rotate
      • Scale
      • Schemas
      • Texture
      • TextureMove
      • TextureUnion
      • VideoTexture
    • Etherum Provider
    • Math & Colors
      • Color3
      • Color4
      • Matrix
      • Plane
      • Quaternion
      • Scalar
      • Vector2
      • Vector3
    • ReactEcs
      • ReactEcs
        • JSX
    • js-runtime/apis
      • "~system/CommsApi"
      • "~system/CommunicationsController"
      • "~system/EngineApi"
      • "~system/EnvironmentApi"
      • "~system/EthereumController"
      • "~system/Players"
      • "~system/PortableExperiences"
      • "~system/RestrictedActions"
      • "~system/Runtime"
      • "~system/Scene"
      • "~system/SignedFetch"
      • "~system/Testing"
      • "~system/UserActionModule"
      • "~system/UserIdentity"
    • sdk/src/composite-provider
    • sdk/src/ethereum-provider/text-encoder
    • sdk/src/ethereum-provider/text-encoding
    • 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/players
  • crdtGetMessageFromRenderer
  • crdtGetState
  • crdtSendToRenderer
  • isServer
  • sendBatch
  • subscribe
  • unsubscribe
  • Area
  • AttachEntityComponentBody
  • Color3
  • Color4
  • ComponentBodyPayload
  • ComponentCreatedBody
  • ComponentDisposedBody
  • ComponentRemovedBody
  • ComponentUpdatedBody
  • CrdtGetStateRequest
  • CrdtGetStateResponse
  • CrdtMessageFromRendererRequest
  • CrdtMessageFromRendererResponse
  • CrdtSendToRendererRequest
  • CrdtSendToResponse
  • CreateEntityBody
  • ECS6Color4
  • ECS6ComponentAnimator
  • ECS6ComponentAnimator_AnimationState
  • ECS6ComponentAttachToAvatar
  • ECS6ComponentAudioClip
  • ECS6ComponentAudioSource
  • ECS6ComponentAudioStream
  • ECS6ComponentAvatarModifierArea
  • ECS6ComponentAvatarShape
  • ECS6ComponentAvatarShape_Emote
  • ECS6ComponentAvatarTexture
  • ECS6ComponentBasicMaterial
  • ECS6ComponentBillboard
  • ECS6ComponentBoxShape
  • ECS6ComponentCameraModeArea
  • ECS6ComponentCircleShape
  • ECS6ComponentConeShape
  • ECS6ComponentCylinderShape
  • ECS6ComponentFont
  • ECS6ComponentGizmos
  • ECS6ComponentGltfShape
  • ECS6ComponentMaterial
  • ECS6ComponentNftShape
  • ECS6ComponentObjShape
  • ECS6ComponentPlaneShape
  • ECS6ComponentSmartItem
  • ECS6ComponentSphereShape
  • ECS6ComponentTextShape
  • ECS6ComponentTexture
  • ECS6ComponentTransform
  • ECS6ComponentUiButton
  • ECS6ComponentUiContainerRect
  • ECS6ComponentUiContainerStack
  • ECS6ComponentUiFullScreenShape
  • ECS6ComponentUiImage
  • ECS6ComponentUiInputText
  • ECS6ComponentUiScreenSpaceShape
  • ECS6ComponentUiScrollRect
  • ECS6ComponentUiShape
  • ECS6ComponentUiText
  • ECS6ComponentUiWorldSpaceShape
  • ECS6ComponentUuidCallback
  • ECS6ComponentVideoClip
  • ECS6ComponentVideoTexture
  • EntityAction
  • EntityActionPayload
  • EventData
  • GenericPayload
  • InitMessagesFinishedBody
  • IsServerRequest
  • IsServerResponse
  • ManyEntityAction
  • OpenExternalUrlBody
  • OpenNFTDialogBody
  • Position
  • PositionChangedPayload
  • Quaternion
  • QueryBody
  • QueryBody_Ray
  • QueryBody_RayQuery
  • ReadOnlyQuaternion
  • ReadOnlyVector3
  • RemoveEntityBody
  • RotationChangedPayload
  • SendBatchResponse
  • SetEntityParentBody
  • SubscribeRequest
  • SubscribeResponse
  • UiValue
  • UnsubscribeRequest
  • UnsubscribeResponse
  • UpdateEntityComponentBody
  • Vector2
  • Vector3
  • ECS6ComponentAttachToAvatar_AttachToAvatarAnchorPointId
  • ECS6ComponentCameraModeArea_CameraMode
  • ECS6ComponentNftShape_PictureFrameStyle
  • ECS6ComponentUiContainerStack_UIStackOrientation
  • ECS6ComponentVideoTexture_VideoStatus
  • EventDataType
  • UiValue_UiValueType