SDK7 feature parity with SDK6

[nearnshaw]

Full Feature parity checklist

These are all the features currently available in SDK 6, that we should support on SDK7

Definitions

• Discussion: Ordering entities for UI Hierarchy (Flexbox) #397
• Semantics of entity parenting where some parents have no transform component #394
• Discussion: center of coordinates for UITransform #388
• Definition: Teleport is now handled viaTransform.getMutable(PlayerEntity).position #356
• Discussion: Component serialization of default values #340
• Definition: new UI components for ECS 7 #304
• Definition: pointer events for entities #305

Base components

• Feature Parity: Component AUDIO_SOURCE #405
• Feature Parity: Component AUDIO_STREAM #406
• Feature Parity: Component NFT_SHAPE #415
• Feature Parity: Component TEXT_SHAPE #414
• Feature Parity: Component BOX_SHAPE #411
• Feature Parity: Component CYLINDER_SHAPE #410
• Feature Parity: Component SPHERE_SHAPE #412
• Feature Parity: Component PLANE_SHAPE #413
• Feature Parity: Component CONE_SHAPE #416
• Feature Parity: Component ANIMATOR & ANIMATION #404
• Feature Parity: Component AVATAR_ATTACH #407
• Feature Parity: Component AVATAR_MODIFIER_AREA #408
• Feature Parity: Component CAMERA_MODE_AREA #418
• Feature Parity: Component BASIC_MATERIAL & PBR_MATERIAL #420
• Feature Parity: Component BILLBOARD #409
• Prevent cyclic parenting in entities #399
• Send CameraMode and PointerLocked state as components to scene #395
• Explicit system execution priority #361
• Feature Parity: Component TRANSFORM #403
• MeshRenderer and MeshCollider components #366
  • Feature Parity: Component MESH_RENDERER #426
  • Feature Parity: Component MESH_COLLIDER #435
• Feature Parity: Component GLTF_CONTAINER #417 and GltfContainer component #367
• Visibilitycomponent #353
• PointerEvents component (Replaces PointerDown & PointerUp) #352
• Feature Parity: Component AVATAR_SHAPE #421
• Feature Parity: Component AVATAR_TEXTURE #419
• VideoTextureState #360
• AvatarAnimationComponent #357
• RaycastComponent #359
• Textures

Special components

• CameraEntity
  • PointerLocked component
    • Send CameraMode and PointerLocked state as components to scene #395
  • CameraMode component (first, third, distance to player)
    • Send CameraMode and PointerLocked state as components to scene #395

Entities

• CameraEntity and PlayerEntity in ECS and Renderer #339
• Root entity

Observables

player connected observable (other players) player disconnected observable (other players)

• Feature parity: Temporary keep onPlayerDisconnectedObservable and onPlayerConnectedObservable (ECS6)

player entered scene observable (any player) ### player left scene observable (any player)

• Feature parity: Temporary keep onEnterSceneObservable and onLeaveSceneObservable (ECS6)

player changes camera mode observable (current player)

• Feature parity:
  • Component of the CameraEntity

player plays animation observable (current player)

• Feature parity: onPlayerExpressionObservable (ECS6)

Current player clicks on another player observable (includes userId, & ray data)

• Feature parity: onPlayerClickedObservable (ECS6)

player locks/unlocks cursor observable (current player)

• Feature parity:
  • RootEntity.PointerLocked component present

player goes idle/returns from idle observable (current player)

• Feature parity:
  • Component of the CameraEntity

player changes profile observable (any player) (includes name, wearables list, etc)

• Feature parity: onProfileChanged (ECS6)

scene finished loading observable

• Feature parity: onSceneReadyObservable (ECS6)

videoTexture changed state observable (playing/paused/etc)

• Feature parity: onVideoEvent (ECS6)

player changes realm or island observable

• Feature parity: onRealmChangedObservable (ECS6)

use message bus

• Feature parity: MessageBus Message Bus #454

Data: player, scene, environment, and others

get a full list of connected players

• Feature parity: import getConnectedPlayers() from '~system/Players' from kernel-api-rpc

get a full list of players currently in the scene

• Feature parity: import getPlayersInScene() from '~system/Players' from kernel-api-rpc

player position / feetPosition / worldPosition & rotation in eurler & quaternion

• Feature parity: PlayerEntity.Transform

player data: name, id, publicKey, hasConnectedWeb3, avatar (wearables, bodyshape, skin color, snapshots, etc), version

• Feature parity: import { getPlayerData } from '~system/Players' from kernel-api-rpc

same data for any nearby player by ID (from renderer)

• Feature parity: import { getPlayerData } from '~system/Players' // with { userId } as param from kernel-api-rpc

same data for any player by ID (from catalysts) (use fetch)

• Ok

get decentraland time

• Feature parity: import { getDecentralandTime } from '~system/EnvironmentAPI' from kernel-api-rpc

get player realm, server URL, server name

• Feature parity: import { getCurrentRealm } from '~system/EnvironmentAPI' from kernel-api-rpc

get player platform (desktop / browser)

• Feature parity: import { getPlatform } from '~system/EnvironmentAPI' from kernel-api-rpc

get active portable experience

• Feature parity: import { getPortableExperiencesLoaded } from '~system/PortableExperiences' from kernel-api-rpc

get player's current camera mode

• Feature parity CameraEntity.CameraMode component

Scene data:

• Fetch full metadata, including parcels, spawnpoints, title, tags, etc
  • Feature parity: import { getParcel } from '~system/ParcelIdentity' from kernel-api-rpc

Events

All these events were found in the repositories js-sdk-toolchain@6.x.x, unity-renderer, kernel and posix.
The ones used by the ECS6 are the actually that need to have a fallback for the feature parity.

Used by ECS6 (js-sdk-toolchain branch 6.x.x)

Ticked means it's tracked.

• positionChanged:
  • PlayerEntity.Transform.position
• rotationChanged :
  • PlayerEntity.Transform.position
• cameraModeChanged
  • CameraEntity.CameraMode
• onEnterScene: See point Observables 3)
• onLeaveScene: See point Observables 4)
• idleStateChanged: See point Observables 10)
• sceneStart: See point Observables 11)
• playerExpression: See point Observables 6)
• videoEvent: See point Observables 12)
• onPointerLock: See point Observables 8)
• playerConnected: See point Observables 1)
• playerDisconnected: See point Observables 2)
• profileChanged: See point Observables 10)
• onRealmChanged: See point Observables 13)
• playerClicked: See point Observables 7)
• comms
• uuidEvent
• raycastResponse
• actionButtonEvent
• pointerUp
• pointerDown

Other functionalities:

• movePlayerTo() - inside scene
  Definition: Teleport is now handled viaTransform.getMutable(PlayerEntity).position #356
• teleportTo() - to other scenes (keep it as it is✅)
• openExternalLink() (keep it as it is✅)
• fetch() (keep it as it is✅)
• signedFetch() (keep it as it is✅)
• websockets events, socket.onmessage (keep it as it is✅)
• EventConstructor() events.fireEvent() / events.addListener()
  remove events entirely?
• Global button events

Helpers:

• Set rotation w Euler
• Vector3 & its functions
• Quaternion & its functions
• System explicit execution order Explicit system execution priority #361

UI Support #424

• UiText
• UiImages

Docs

• Documentation and examples for ECS7 #327

[gonpombo8]

pending features are tracked here #442