@dcl/ecs 7.22.5-24836126953.commit-ddc8da1 → 7.22.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/extended/ParticleSystem.d.ts +24 -0
- package/dist/components/extended/ParticleSystem.js +23 -0
- package/dist/components/generated/ParticleSystem.gen.d.ts +1 -0
- package/dist/components/generated/ParticleSystem.gen.js +25 -0
- package/dist/components/generated/component-names.gen.js +1 -0
- package/dist/components/generated/global.gen.d.ts +2 -0
- package/dist/components/generated/global.gen.js +1 -0
- package/dist/components/generated/index.gen.d.ts +4 -0
- package/dist/components/generated/index.gen.js +5 -0
- package/dist/components/generated/pb/decentraland/common/colors.gen.d.ts +15 -0
- package/dist/components/generated/pb/decentraland/common/colors.gen.js +47 -0
- package/dist/components/generated/pb/decentraland/common/floats.gen.d.ts +16 -0
- package/dist/components/generated/pb/decentraland/common/floats.gen.js +50 -0
- package/dist/components/generated/pb/decentraland/sdk/components/common/input_action.gen.d.ts +10 -1
- package/dist/components/generated/pb/decentraland/sdk/components/common/input_action.gen.js +10 -0
- package/dist/components/generated/pb/decentraland/sdk/components/particle_system.gen.d.ts +241 -0
- package/dist/components/generated/pb/decentraland/sdk/components/particle_system.gen.js +717 -0
- package/dist/components/generated/pb/decentraland/sdk/components/pointer_events.gen.d.ts +5 -1
- package/dist/components/generated/pb/decentraland/sdk/components/pointer_events.gen.js +20 -1
- package/dist/components/generated/types.gen.d.ts +2 -0
- package/dist/components/generated/types.gen.js +3 -0
- package/dist/components/index.d.ts +2 -5
- package/dist/components/index.js +5 -5
- package/dist/components/manual/Transform.d.ts +13 -9
- package/dist/components/manual/Transform.js +11 -3
- package/dist/components/types.d.ts +1 -1
- package/dist/engine/component.d.ts +1 -52
- package/dist/engine/grow-only-value-set-component-definition.js +2 -45
- package/dist/engine/lww-element-set-component-definition.d.ts +3 -5
- package/dist/engine/lww-element-set-component-definition.js +35 -70
- package/dist/index.d.ts +3 -2
- package/dist/index.js +3 -1
- package/dist/runtime/helpers/index.d.ts +1 -0
- package/dist/runtime/helpers/index.js +1 -0
- package/dist/runtime/helpers/tree.d.ts +6 -0
- package/dist/runtime/helpers/tree.js +2 -2
- package/dist/runtime/helpers/vectors.d.ts +1 -0
- package/dist/runtime/helpers/vectors.js +36 -0
- package/dist/runtime/initialization/index.d.ts +7 -0
- package/dist/runtime/initialization/index.js +6 -0
- package/dist/serialization/crdt/index.d.ts +0 -1
- package/dist/serialization/crdt/index.js +0 -1
- package/dist/serialization/crdt/network/utils.d.ts +9 -0
- package/dist/serialization/crdt/network/utils.js +60 -0
- package/dist/serialization/crdt/types.d.ts +3 -25
- package/dist/serialization/crdt/types.js +1 -3
- package/dist/systems/crdt/index.d.ts +1 -0
- package/dist/systems/crdt/index.js +146 -55
- package/dist/systems/events.d.ts +65 -0
- package/dist/systems/events.js +70 -8
- package/dist/systems/physics-force.d.ts +1 -0
- package/dist/systems/physics-force.js +140 -0
- package/dist/systems/physics-impulse.d.ts +12 -0
- package/dist/systems/physics-impulse.js +85 -0
- package/dist/systems/physics.d.ts +77 -0
- package/dist/systems/physics.js +18 -0
- package/dist-cjs/components/extended/ParticleSystem.d.ts +24 -0
- package/dist-cjs/components/extended/ParticleSystem.js +28 -0
- package/dist-cjs/components/generated/ParticleSystem.gen.d.ts +1 -0
- package/dist-cjs/components/generated/ParticleSystem.gen.js +28 -0
- package/dist-cjs/components/generated/component-names.gen.js +1 -0
- package/dist-cjs/components/generated/global.gen.d.ts +2 -0
- package/dist-cjs/components/generated/global.gen.js +3 -1
- package/dist-cjs/components/generated/index.gen.d.ts +4 -0
- package/dist-cjs/components/generated/index.gen.js +8 -2
- package/dist-cjs/components/generated/pb/decentraland/common/colors.gen.d.ts +15 -0
- package/dist-cjs/components/generated/pb/decentraland/common/colors.gen.js +48 -1
- package/dist-cjs/components/generated/pb/decentraland/common/floats.gen.d.ts +16 -0
- package/dist-cjs/components/generated/pb/decentraland/common/floats.gen.js +56 -0
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/common/input_action.gen.d.ts +10 -1
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/common/input_action.gen.js +11 -1
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/particle_system.gen.d.ts +241 -0
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/particle_system.gen.js +723 -0
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/pointer_events.gen.d.ts +5 -1
- package/dist-cjs/components/generated/pb/decentraland/sdk/components/pointer_events.gen.js +20 -1
- package/dist-cjs/components/generated/types.gen.d.ts +2 -0
- package/dist-cjs/components/generated/types.gen.js +5 -0
- package/dist-cjs/components/index.d.ts +2 -5
- package/dist-cjs/components/index.js +7 -7
- package/dist-cjs/components/manual/Transform.d.ts +13 -9
- package/dist-cjs/components/manual/Transform.js +34 -3
- package/dist-cjs/components/types.d.ts +1 -1
- package/dist-cjs/engine/component.d.ts +1 -52
- package/dist-cjs/engine/grow-only-value-set-component-definition.js +1 -44
- package/dist-cjs/engine/lww-element-set-component-definition.d.ts +3 -5
- package/dist-cjs/engine/lww-element-set-component-definition.js +36 -73
- package/dist-cjs/index.d.ts +3 -2
- package/dist-cjs/index.js +4 -2
- package/dist-cjs/runtime/helpers/index.d.ts +1 -0
- package/dist-cjs/runtime/helpers/index.js +1 -0
- package/dist-cjs/runtime/helpers/tree.d.ts +6 -0
- package/dist-cjs/runtime/helpers/tree.js +3 -2
- package/dist-cjs/runtime/helpers/vectors.d.ts +1 -0
- package/dist-cjs/runtime/helpers/vectors.js +39 -0
- package/dist-cjs/runtime/initialization/index.d.ts +7 -0
- package/dist-cjs/runtime/initialization/index.js +7 -1
- package/dist-cjs/serialization/crdt/index.d.ts +0 -1
- package/dist-cjs/serialization/crdt/index.js +0 -1
- package/dist-cjs/serialization/crdt/network/utils.d.ts +9 -0
- package/dist-cjs/serialization/crdt/network/utils.js +67 -0
- package/dist-cjs/serialization/crdt/types.d.ts +3 -25
- package/dist-cjs/serialization/crdt/types.js +1 -3
- package/dist-cjs/systems/crdt/index.d.ts +1 -0
- package/dist-cjs/systems/crdt/index.js +169 -55
- package/dist-cjs/systems/events.d.ts +65 -0
- package/dist-cjs/systems/events.js +70 -8
- package/dist-cjs/systems/physics-force.d.ts +1 -0
- package/dist-cjs/systems/physics-force.js +167 -0
- package/dist-cjs/systems/physics-impulse.d.ts +12 -0
- package/dist-cjs/systems/physics-impulse.js +112 -0
- package/dist-cjs/systems/physics.d.ts +77 -0
- package/dist-cjs/systems/physics.js +23 -0
- package/package.json +3 -2
- package/dist/components/manual/CreatedBy.d.ts +0 -9
- package/dist/components/manual/CreatedBy.js +0 -8
- package/dist/serialization/crdt/authoritativePutComponent.d.ts +0 -15
- package/dist/serialization/crdt/authoritativePutComponent.js +0 -47
- package/dist-cjs/components/manual/CreatedBy.d.ts +0 -9
- package/dist-cjs/components/manual/CreatedBy.js +0 -10
- package/dist-cjs/serialization/crdt/authoritativePutComponent.d.ts +0 -15
- package/dist-cjs/serialization/crdt/authoritativePutComponent.js +0 -50
package/dist/index.js
CHANGED
|
@@ -13,6 +13,7 @@ export * from './systems/assetLoad';
|
|
|
13
13
|
export * from './systems/async-task';
|
|
14
14
|
export * from './systems/tween';
|
|
15
15
|
export * from './systems/triggerArea';
|
|
16
|
+
export * from './systems/physics';
|
|
16
17
|
export * from './engine/entity';
|
|
17
18
|
export * from './components/types';
|
|
18
19
|
// @internal
|
|
@@ -35,6 +36,8 @@ export const VirtualCamera = /* @__PURE__*/ components.VirtualCamera(engine);
|
|
|
35
36
|
export const InputModifier = /* @__PURE__*/ components.InputModifier(engine);
|
|
36
37
|
export const LightSource = /* @__PURE__*/ components.LightSource(engine);
|
|
37
38
|
export const TriggerArea = /* @__PURE__*/ components.TriggerArea(engine);
|
|
39
|
+
export const ParticleSystem =
|
|
40
|
+
/* @__PURE__*/ components.ParticleSystem(engine);
|
|
38
41
|
/**
|
|
39
42
|
* @alpha
|
|
40
43
|
* This is going to be used for sync components through a server.
|
|
@@ -51,7 +54,6 @@ export const NetworkEntity = /* @__PURE__*/ components.NetworkEntity(engine);
|
|
|
51
54
|
* Tag a entity to be syncronized through comms
|
|
52
55
|
*/
|
|
53
56
|
export const NetworkParent = /* @__PURE__*/ components.NetworkParent(engine);
|
|
54
|
-
export const CreatedBy = /* @__PURE__*/ components.CreatedBy(engine);
|
|
55
57
|
// export components for global engine
|
|
56
58
|
export * from './components/generated/global.gen';
|
|
57
59
|
export * from './components/generated/types.gen';
|
|
@@ -2,6 +2,12 @@ import { Entity } from '../../engine/entity';
|
|
|
2
2
|
import { ComponentDefinition, IEngine } from '../../engine';
|
|
3
3
|
import { Vector3Type } from '../../schemas/custom/Vector3';
|
|
4
4
|
import { QuaternionType } from '../../schemas/custom/Quaternion';
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* Rotate a vector by a quaternion
|
|
8
|
+
* Uses the formula: v' = q * v * q^(-1), optimized version
|
|
9
|
+
*/
|
|
10
|
+
export declare function rotateVectorByQuaternion(v: Vector3Type, q: QuaternionType): Vector3Type;
|
|
5
11
|
/**
|
|
6
12
|
* Get an iterator of entities that follow a tree structure for a component
|
|
7
13
|
* @public
|
|
@@ -35,11 +35,11 @@ function multiplyQuaternions(q1, q2) {
|
|
|
35
35
|
};
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* @
|
|
38
|
+
* @public
|
|
39
39
|
* Rotate a vector by a quaternion
|
|
40
40
|
* Uses the formula: v' = q * v * q^(-1), optimized version
|
|
41
41
|
*/
|
|
42
|
-
function rotateVectorByQuaternion(v, q) {
|
|
42
|
+
export function rotateVectorByQuaternion(v, q) {
|
|
43
43
|
// Extract quaternion components
|
|
44
44
|
const qx = q.x, qy = q.y, qz = q.z, qw = q.w;
|
|
45
45
|
// Calculate cross product terms (q.xyz × v) * 2
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Lightweight Vector3 math utilities for internal use.
|
|
3
|
+
* Mirrors the subset of @dcl/ecs-math Vector3 API used by the physics helpers.
|
|
4
|
+
*
|
|
5
|
+
* TEMPORARY WORKAROUND: @dcl/ecs-math ships ESM-only, which breaks the dist-cjs build.
|
|
6
|
+
* The proper fix is to add a CJS build to @dcl/ecs-math upstream, then replace this
|
|
7
|
+
* file with `import { Vector3 } from '@dcl/ecs-math'`.
|
|
8
|
+
*
|
|
9
|
+
* @internal
|
|
10
|
+
*/
|
|
11
|
+
export const Vector3 = {
|
|
12
|
+
add(a, b) {
|
|
13
|
+
return { x: a.x + b.x, y: a.y + b.y, z: a.z + b.z };
|
|
14
|
+
},
|
|
15
|
+
subtract(a, b) {
|
|
16
|
+
return { x: a.x - b.x, y: a.y - b.y, z: a.z - b.z };
|
|
17
|
+
},
|
|
18
|
+
scale(v, s) {
|
|
19
|
+
return { x: v.x * s, y: v.y * s, z: v.z * s };
|
|
20
|
+
},
|
|
21
|
+
length(v) {
|
|
22
|
+
return Math.sqrt(v.x * v.x + v.y * v.y + v.z * v.z);
|
|
23
|
+
},
|
|
24
|
+
normalize(v) {
|
|
25
|
+
const len = Vector3.length(v);
|
|
26
|
+
if (len === 0)
|
|
27
|
+
return { x: 0, y: 0, z: 0 };
|
|
28
|
+
return { x: v.x / len, y: v.y / len, z: v.z / len };
|
|
29
|
+
},
|
|
30
|
+
equals(a, b) {
|
|
31
|
+
return a.x === b.x && a.y === b.y && a.z === b.z;
|
|
32
|
+
},
|
|
33
|
+
equalsToFloats(v, x, y, z) {
|
|
34
|
+
return v.x === x && v.y === y && v.z === z;
|
|
35
|
+
}
|
|
36
|
+
};
|
|
@@ -12,6 +12,7 @@ import { AssetLoadLoadingStateSystem } from '../../systems/assetLoad';
|
|
|
12
12
|
import { TweenSystem } from '../../systems/tween';
|
|
13
13
|
import { TriggerAreaEventsSystem } from '../../systems/triggerArea';
|
|
14
14
|
import { createTimers, Timers } from '../helpers/timers';
|
|
15
|
+
import { PhysicsSystem } from '../../systems/physics';
|
|
15
16
|
/**
|
|
16
17
|
* @public
|
|
17
18
|
* The engine is the part of the scene that sits in the middle and manages all of the other parts.
|
|
@@ -77,6 +78,12 @@ export { TriggerAreaEventsSystem };
|
|
|
77
78
|
*/
|
|
78
79
|
export declare const timers: Timers;
|
|
79
80
|
export { Timers, createTimers };
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
* Physics helpers for applying impulses and forces to the player.
|
|
84
|
+
*/
|
|
85
|
+
export declare const Physics: PhysicsSystem;
|
|
86
|
+
export { PhysicsSystem };
|
|
80
87
|
/**
|
|
81
88
|
* @public
|
|
82
89
|
* Runs an async function
|
|
@@ -14,6 +14,7 @@ import { pointerEventColliderChecker } from '../../systems/pointer-event-collide
|
|
|
14
14
|
import { createTriggerAreaEventsSystem } from '../../systems/triggerArea';
|
|
15
15
|
import { createTimers } from '../helpers/timers';
|
|
16
16
|
import { setGlobalPolyfill } from '../globals';
|
|
17
|
+
import { createPhysicsSystem } from '../../systems/physics';
|
|
17
18
|
/**
|
|
18
19
|
* @public
|
|
19
20
|
* The engine is the part of the scene that sits in the middle and manages all of the other parts.
|
|
@@ -77,6 +78,11 @@ setGlobalPolyfill('setTimeout', timers.setTimeout);
|
|
|
77
78
|
setGlobalPolyfill('clearTimeout', timers.clearTimeout);
|
|
78
79
|
setGlobalPolyfill('setInterval', timers.setInterval);
|
|
79
80
|
setGlobalPolyfill('clearInterval', timers.clearInterval);
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
* Physics helpers for applying impulses and forces to the player.
|
|
84
|
+
*/
|
|
85
|
+
export const Physics = /* @__PURE__ */ createPhysicsSystem(engine);
|
|
80
86
|
/**
|
|
81
87
|
* Adds pointer event collider system only in DEV env
|
|
82
88
|
*/
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Entity } from '../../../engine';
|
|
2
|
+
import { ReceiveMessage, TransformType } from '../../../runtime/types';
|
|
3
|
+
import { ReceiveNetworkMessage } from '../../../systems/crdt/types';
|
|
4
|
+
import { ByteBuffer } from '../../ByteBuffer';
|
|
5
|
+
import { INetowrkEntityType } from '../../../components/types';
|
|
6
|
+
export declare function isNetworkMessage(message: ReceiveMessage): message is ReceiveNetworkMessage;
|
|
7
|
+
export declare function networkMessageToLocal(message: ReceiveNetworkMessage, localEntityId: Entity, buffer: ByteBuffer, destinationBuffer: ByteBuffer): void;
|
|
8
|
+
export declare function localMessageToNetwork(message: ReceiveMessage, network: INetowrkEntityType, buffer: ByteBuffer, destinationBuffer: ByteBuffer): void;
|
|
9
|
+
export declare function fixTransformParent(message: ReceiveMessage, transformValue?: TransformType, parent?: Entity): Uint8Array;
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { ReadWriteByteBuffer } from '../../ByteBuffer';
|
|
2
|
+
import { PutComponentOperation } from '../putComponent';
|
|
3
|
+
import { CrdtMessageType } from '../types';
|
|
4
|
+
import { DeleteComponent } from '../deleteComponent';
|
|
5
|
+
import { DeleteEntity } from '../deleteEntity';
|
|
6
|
+
import { PutNetworkComponentOperation } from './putComponentNetwork';
|
|
7
|
+
import { DeleteComponentNetwork } from './deleteComponentNetwork';
|
|
8
|
+
import { DeleteEntityNetwork } from './deleteEntityNetwork';
|
|
9
|
+
import { TransformSchema } from '../../../components/manual/Transform';
|
|
10
|
+
/* istanbul ignore next */
|
|
11
|
+
export function isNetworkMessage(message) {
|
|
12
|
+
return [
|
|
13
|
+
CrdtMessageType.DELETE_COMPONENT_NETWORK,
|
|
14
|
+
CrdtMessageType.DELETE_ENTITY_NETWORK,
|
|
15
|
+
CrdtMessageType.PUT_COMPONENT_NETWORK
|
|
16
|
+
].includes(message.type);
|
|
17
|
+
}
|
|
18
|
+
/* istanbul ignore next */
|
|
19
|
+
export function networkMessageToLocal(message, localEntityId, buffer, destinationBuffer) {
|
|
20
|
+
const offset = buffer.currentWriteOffset();
|
|
21
|
+
if (message.type === CrdtMessageType.PUT_COMPONENT_NETWORK) {
|
|
22
|
+
PutComponentOperation.write(localEntityId, message.timestamp, message.componentId, message.data, buffer);
|
|
23
|
+
}
|
|
24
|
+
else if (message.type === CrdtMessageType.DELETE_COMPONENT_NETWORK) {
|
|
25
|
+
DeleteComponent.write(localEntityId, message.componentId, message.timestamp, buffer);
|
|
26
|
+
}
|
|
27
|
+
else if (message.type === CrdtMessageType.DELETE_ENTITY_NETWORK) {
|
|
28
|
+
DeleteEntity.write(localEntityId, buffer);
|
|
29
|
+
}
|
|
30
|
+
destinationBuffer.writeBuffer(buffer.buffer().subarray(offset, buffer.currentWriteOffset()), false);
|
|
31
|
+
}
|
|
32
|
+
/* istanbul ignore next */
|
|
33
|
+
export function localMessageToNetwork(message, network, buffer, destinationBuffer) {
|
|
34
|
+
const offset = buffer.currentWriteOffset();
|
|
35
|
+
if (message.type === CrdtMessageType.PUT_COMPONENT) {
|
|
36
|
+
PutNetworkComponentOperation.write(network.entityId, message.timestamp, message.componentId, network.networkId, message.data, buffer);
|
|
37
|
+
}
|
|
38
|
+
else if (message.type === CrdtMessageType.DELETE_COMPONENT) {
|
|
39
|
+
DeleteComponentNetwork.write(network.entityId, message.componentId, message.timestamp, network.networkId, buffer);
|
|
40
|
+
}
|
|
41
|
+
else if (message.type === CrdtMessageType.DELETE_ENTITY) {
|
|
42
|
+
DeleteEntityNetwork.write(network.entityId, network.networkId, buffer);
|
|
43
|
+
}
|
|
44
|
+
destinationBuffer.writeBuffer(buffer.buffer().subarray(offset, buffer.currentWriteOffset()), false);
|
|
45
|
+
}
|
|
46
|
+
const buffer = new ReadWriteByteBuffer();
|
|
47
|
+
/* istanbul ignore next */
|
|
48
|
+
export function fixTransformParent(message, transformValue, parent) {
|
|
49
|
+
buffer.resetBuffer();
|
|
50
|
+
let transform = transformValue;
|
|
51
|
+
if (!transform && 'data' in message) {
|
|
52
|
+
transform = TransformSchema.deserialize(new ReadWriteByteBuffer(message.data));
|
|
53
|
+
}
|
|
54
|
+
if (!transform)
|
|
55
|
+
throw new Error('Invalid parent transform');
|
|
56
|
+
// Generate new transform raw data with the parent
|
|
57
|
+
const newTransform = { ...transform, parent };
|
|
58
|
+
TransformSchema.serialize(newTransform, buffer);
|
|
59
|
+
return buffer.toBinary();
|
|
60
|
+
}
|
|
@@ -11,8 +11,7 @@ export declare enum CrdtMessageType {
|
|
|
11
11
|
PUT_COMPONENT_NETWORK = 5,
|
|
12
12
|
DELETE_COMPONENT_NETWORK = 6,
|
|
13
13
|
DELETE_ENTITY_NETWORK = 7,
|
|
14
|
-
|
|
15
|
-
MAX_MESSAGE_TYPE = 9
|
|
14
|
+
MAX_MESSAGE_TYPE = 8
|
|
16
15
|
}
|
|
17
16
|
/**
|
|
18
17
|
* Min length = 8 bytes
|
|
@@ -49,23 +48,6 @@ export type PutNetworkComponentMessageBody = Omit<PutComponentMessageBody, 'type
|
|
|
49
48
|
type: CrdtMessageType.PUT_COMPONENT_NETWORK;
|
|
50
49
|
networkId: number;
|
|
51
50
|
};
|
|
52
|
-
/**
|
|
53
|
-
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
54
|
-
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
55
|
-
*
|
|
56
|
-
* @param entity - Uint32 number of the entity
|
|
57
|
-
* @param componentId - Uint32 number of id
|
|
58
|
-
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
59
|
-
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
60
|
-
* @public
|
|
61
|
-
*/
|
|
62
|
-
export type AuthoritativePutComponentMessageBody = {
|
|
63
|
-
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
64
|
-
entityId: Entity;
|
|
65
|
-
componentId: number;
|
|
66
|
-
timestamp: number;
|
|
67
|
-
data: Uint8Array;
|
|
68
|
-
};
|
|
69
51
|
/**
|
|
70
52
|
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
71
53
|
*
|
|
@@ -132,10 +114,6 @@ export type AppendValueMessage = CrdtMessageHeader & AppendValueMessageBody;
|
|
|
132
114
|
* @public
|
|
133
115
|
*/
|
|
134
116
|
export type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
|
|
135
|
-
/**
|
|
136
|
-
* @public
|
|
137
|
-
*/
|
|
138
|
-
export type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
139
117
|
/**
|
|
140
118
|
* @public
|
|
141
119
|
*/
|
|
@@ -159,7 +137,7 @@ export type DeleteEntityNetworkMessage = CrdtMessageHeader & DeleteEntityNetwork
|
|
|
159
137
|
/**
|
|
160
138
|
* @public
|
|
161
139
|
*/
|
|
162
|
-
export type CrdtMessage = PutComponentMessage |
|
|
140
|
+
export type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
163
141
|
/**
|
|
164
142
|
* @public
|
|
165
143
|
*/
|
|
@@ -167,7 +145,7 @@ export type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComp
|
|
|
167
145
|
/**
|
|
168
146
|
* @public
|
|
169
147
|
*/
|
|
170
|
-
export type CrdtMessageBody = PutComponentMessageBody |
|
|
148
|
+
export type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
171
149
|
export declare enum ProcessMessageResultType {
|
|
172
150
|
/**
|
|
173
151
|
* Typical message and new state set.
|
|
@@ -13,9 +13,7 @@ export var CrdtMessageType;
|
|
|
13
13
|
CrdtMessageType[CrdtMessageType["PUT_COMPONENT_NETWORK"] = 5] = "PUT_COMPONENT_NETWORK";
|
|
14
14
|
CrdtMessageType[CrdtMessageType["DELETE_COMPONENT_NETWORK"] = 6] = "DELETE_COMPONENT_NETWORK";
|
|
15
15
|
CrdtMessageType[CrdtMessageType["DELETE_ENTITY_NETWORK"] = 7] = "DELETE_ENTITY_NETWORK";
|
|
16
|
-
|
|
17
|
-
CrdtMessageType[CrdtMessageType["AUTHORITATIVE_PUT_COMPONENT"] = 8] = "AUTHORITATIVE_PUT_COMPONENT";
|
|
18
|
-
CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 9] = "MAX_MESSAGE_TYPE";
|
|
16
|
+
CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 8] = "MAX_MESSAGE_TYPE";
|
|
19
17
|
})(CrdtMessageType || (CrdtMessageType = {}));
|
|
20
18
|
/**
|
|
21
19
|
* @public
|
|
@@ -1,17 +1,24 @@
|
|
|
1
1
|
import { EntityState } from '../../engine/entity';
|
|
2
2
|
import { ReadWriteByteBuffer } from '../../serialization/ByteBuffer';
|
|
3
|
-
import { AppendValueOperation, CrdtMessageProtocol } from '../../serialization/crdt';
|
|
3
|
+
import { AppendValueOperation, CrdtMessageProtocol, DeleteComponentNetwork, DeleteEntityNetwork } from '../../serialization/crdt';
|
|
4
4
|
import { DeleteComponent } from '../../serialization/crdt/deleteComponent';
|
|
5
5
|
import { DeleteEntity } from '../../serialization/crdt/deleteEntity';
|
|
6
6
|
import { PutComponentOperation } from '../../serialization/crdt/putComponent';
|
|
7
|
-
import { AuthoritativePutComponentOperation } from '../../serialization/crdt/authoritativePutComponent';
|
|
8
7
|
import { CrdtMessageType } from '../../serialization/crdt/types';
|
|
8
|
+
import { PutNetworkComponentOperation } from '../../serialization/crdt/network/putComponentNetwork';
|
|
9
|
+
import { NetworkEntity as defineNetworkEntity, NetworkParent as defineNetworkParent, Transform as defineTransform } from '../../components';
|
|
10
|
+
import * as networkUtils from '../../serialization/crdt/network/utils';
|
|
11
|
+
// NetworkMessages can only have a MAX_SIZE of 12kb. So we need to send it in chunks.
|
|
12
|
+
export const LIVEKIT_MAX_SIZE = 12;
|
|
9
13
|
/**
|
|
10
14
|
* @internal
|
|
11
15
|
*/
|
|
12
16
|
export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
13
17
|
const transports = [];
|
|
14
|
-
//
|
|
18
|
+
// Components that we used on this system
|
|
19
|
+
const NetworkEntity = defineNetworkEntity(engine);
|
|
20
|
+
const NetworkParent = defineNetworkParent(engine);
|
|
21
|
+
const Transform = defineTransform(engine);
|
|
15
22
|
// Messages that we received at transport.onMessage waiting to be processed
|
|
16
23
|
const receivedMessages = [];
|
|
17
24
|
// Messages already processed by the engine but that we need to broadcast to other transports.
|
|
@@ -36,20 +43,27 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
36
43
|
if (header.type === CrdtMessageType.DELETE_COMPONENT) {
|
|
37
44
|
message = DeleteComponent.read(buffer);
|
|
38
45
|
}
|
|
46
|
+
else if (header.type === CrdtMessageType.DELETE_COMPONENT_NETWORK) {
|
|
47
|
+
message = DeleteComponentNetwork.read(buffer);
|
|
48
|
+
}
|
|
39
49
|
else if (header.type === CrdtMessageType.PUT_COMPONENT) {
|
|
40
50
|
message = PutComponentOperation.read(buffer);
|
|
41
51
|
}
|
|
42
|
-
else if (header.type === CrdtMessageType.
|
|
43
|
-
message =
|
|
52
|
+
else if (header.type === CrdtMessageType.PUT_COMPONENT_NETWORK) {
|
|
53
|
+
message = PutNetworkComponentOperation.read(buffer);
|
|
44
54
|
}
|
|
45
55
|
else if (header.type === CrdtMessageType.DELETE_ENTITY) {
|
|
46
56
|
message = DeleteEntity.read(buffer);
|
|
47
57
|
}
|
|
58
|
+
else if (header.type === CrdtMessageType.DELETE_ENTITY_NETWORK) {
|
|
59
|
+
message = DeleteEntityNetwork.read(buffer);
|
|
60
|
+
}
|
|
48
61
|
else if (header.type === CrdtMessageType.APPEND_VALUE) {
|
|
49
62
|
message = AppendValueOperation.read(buffer);
|
|
63
|
+
// Unknown message, we skip it
|
|
50
64
|
}
|
|
51
65
|
else {
|
|
52
|
-
//
|
|
66
|
+
// consume the message
|
|
53
67
|
buffer.incrementReadOffset(header.length);
|
|
54
68
|
}
|
|
55
69
|
if (message) {
|
|
@@ -70,6 +84,22 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
70
84
|
const messagesToProcess = value.splice(0, value.length);
|
|
71
85
|
return messagesToProcess;
|
|
72
86
|
}
|
|
87
|
+
/**
|
|
88
|
+
* Find the local entityId associated to the network component message.
|
|
89
|
+
* It's a mapping Network -> to Local
|
|
90
|
+
* If it's not a network message, return the entityId received by the message
|
|
91
|
+
*/
|
|
92
|
+
function findNetworkId(msg) {
|
|
93
|
+
const hasNetworkId = 'networkId' in msg;
|
|
94
|
+
if (hasNetworkId) {
|
|
95
|
+
for (const [entityId, network] of engine.getEntitiesWith(NetworkEntity)) {
|
|
96
|
+
if (network.networkId === msg.networkId && network.entityId === msg.entityId) {
|
|
97
|
+
return { entityId, network };
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
return { entityId: msg.entityId };
|
|
102
|
+
}
|
|
73
103
|
/**
|
|
74
104
|
* This fn will be called on every tick.
|
|
75
105
|
* Process all the messages queue received by the transport
|
|
@@ -78,52 +108,46 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
78
108
|
const messagesToProcess = getMessages(receivedMessages);
|
|
79
109
|
const entitiesShouldBeCleaned = [];
|
|
80
110
|
for (const msg of messagesToProcess) {
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
111
|
+
let { entityId, network } = findNetworkId(msg);
|
|
112
|
+
// We receive a new Entity. Create the localEntity and map it to the NetworkEntity component
|
|
113
|
+
if (networkUtils.isNetworkMessage(msg) && !network) {
|
|
114
|
+
entityId = engine.addEntity();
|
|
115
|
+
network = { entityId: msg.entityId, networkId: msg.networkId };
|
|
116
|
+
NetworkEntity.createOrReplace(entityId, network);
|
|
117
|
+
}
|
|
118
|
+
if (msg.type === CrdtMessageType.DELETE_ENTITY || msg.type === CrdtMessageType.DELETE_ENTITY_NETWORK) {
|
|
119
|
+
entitiesShouldBeCleaned.push(entityId);
|
|
84
120
|
broadcastMessages.push(msg);
|
|
85
121
|
}
|
|
86
122
|
else {
|
|
87
|
-
const entityState = engine.entityContainer.getEntityState(
|
|
88
|
-
// Skip updates from removed
|
|
123
|
+
const entityState = engine.entityContainer.getEntityState(entityId);
|
|
124
|
+
// Skip updates from removed entityes
|
|
89
125
|
if (entityState === EntityState.Removed)
|
|
90
126
|
continue;
|
|
91
|
-
// Entities with unknown
|
|
127
|
+
// Entities with unknown entities should update its entity state
|
|
92
128
|
if (entityState === EntityState.Unknown) {
|
|
93
|
-
engine.entityContainer.updateUsedEntity(
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
if (
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
? component.__forceUpdateFromCrdt(msg)
|
|
104
|
-
: component.updateFromCrdt(msg);
|
|
105
|
-
}
|
|
106
|
-
catch (e) {
|
|
107
|
-
console.error('[receiveMessages] ERROR processing message', msg, e);
|
|
108
|
-
return null;
|
|
109
|
-
}
|
|
110
|
-
};
|
|
111
|
-
const result = tryUpdate();
|
|
112
|
-
if (!result)
|
|
113
|
-
continue;
|
|
114
|
-
const [conflictMessage, value] = result;
|
|
115
|
-
if (!conflictMessage) {
|
|
116
|
-
// Add message to broadcast queue when no conflict
|
|
117
|
-
broadcastMessages.push(msg);
|
|
118
|
-
onProcessEntityComponentChange && onProcessEntityComponentChange(msg.entityId, msg.type, component, value);
|
|
119
|
-
}
|
|
129
|
+
engine.entityContainer.updateUsedEntity(entityId);
|
|
130
|
+
}
|
|
131
|
+
const component = engine.getComponentOrNull(msg.componentId);
|
|
132
|
+
/* istanbul ignore else */
|
|
133
|
+
if (component) {
|
|
134
|
+
if (msg.type === CrdtMessageType.PUT_COMPONENT &&
|
|
135
|
+
component.componentId === Transform.componentId &&
|
|
136
|
+
NetworkEntity.has(entityId) &&
|
|
137
|
+
NetworkParent.has(entityId)) {
|
|
138
|
+
msg.data = networkUtils.fixTransformParent(msg);
|
|
120
139
|
}
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
140
|
+
const [conflictMessage, value] = component.updateFromCrdt({ ...msg, entityId });
|
|
141
|
+
if (!conflictMessage) {
|
|
142
|
+
// Add message to transport queue to be processed by others transports
|
|
124
143
|
broadcastMessages.push(msg);
|
|
144
|
+
onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, msg.type, component, value);
|
|
125
145
|
}
|
|
126
146
|
}
|
|
147
|
+
else {
|
|
148
|
+
// TODO: test this line, it is fundammental to make the editor work
|
|
149
|
+
broadcastMessages.push(msg);
|
|
150
|
+
}
|
|
127
151
|
}
|
|
128
152
|
}
|
|
129
153
|
// the last stage of the syncrhonization is to delete the entities
|
|
@@ -137,17 +161,16 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
137
161
|
}
|
|
138
162
|
}
|
|
139
163
|
/**
|
|
140
|
-
*
|
|
164
|
+
* Iterates the dirty map and generates crdt messages to be send
|
|
141
165
|
*/
|
|
142
166
|
async function sendMessages(entitiesDeletedThisTick) {
|
|
143
|
-
//
|
|
167
|
+
// CRDT Messages will be the merge between the recieved transport messages and the new crdt messages
|
|
144
168
|
const crdtMessages = getMessages(broadcastMessages);
|
|
145
169
|
const buffer = new ReadWriteByteBuffer();
|
|
146
|
-
// Generate CRDT messages from component updates
|
|
147
170
|
for (const component of engine.componentsIter()) {
|
|
148
171
|
for (const message of component.getCrdtUpdates()) {
|
|
149
172
|
const offset = buffer.currentWriteOffset();
|
|
150
|
-
//
|
|
173
|
+
// Avoid creating messages if there is no transport that will handle it
|
|
151
174
|
if (transports.some((t) => t.filter(message))) {
|
|
152
175
|
if (message.type === CrdtMessageType.PUT_COMPONENT) {
|
|
153
176
|
PutComponentOperation.write(message.entityId, message.timestamp, message.componentId, message.data, buffer);
|
|
@@ -171,7 +194,7 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
171
194
|
}
|
|
172
195
|
}
|
|
173
196
|
}
|
|
174
|
-
//
|
|
197
|
+
// After all updates, I execute the DeletedEntity messages
|
|
175
198
|
for (const entityId of entitiesDeletedThisTick) {
|
|
176
199
|
const offset = buffer.currentWriteOffset();
|
|
177
200
|
DeleteEntity.write(entityId, buffer);
|
|
@@ -182,19 +205,87 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
182
205
|
});
|
|
183
206
|
onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, CrdtMessageType.DELETE_ENTITY);
|
|
184
207
|
}
|
|
185
|
-
//
|
|
186
|
-
|
|
187
|
-
|
|
208
|
+
// Send CRDT messages to transports
|
|
209
|
+
const transportBuffer = new ReadWriteByteBuffer();
|
|
210
|
+
for (const index in transports) {
|
|
211
|
+
const __NetworkMessagesBuffer = [];
|
|
212
|
+
const transportIndex = Number(index);
|
|
213
|
+
const transport = transports[transportIndex];
|
|
214
|
+
const isRendererTransport = transport.type === 'renderer';
|
|
215
|
+
const isNetworkTransport = transport.type === 'network';
|
|
216
|
+
// Reset Buffer for each Transport
|
|
217
|
+
transportBuffer.resetBuffer();
|
|
218
|
+
const buffer = new ReadWriteByteBuffer();
|
|
219
|
+
// Then we send all the new crdtMessages that the transport needs to process
|
|
188
220
|
for (const message of crdtMessages) {
|
|
189
221
|
// Avoid echo messages
|
|
190
|
-
if (message.transportId ===
|
|
222
|
+
if (message.transportId === transportIndex)
|
|
191
223
|
continue;
|
|
192
|
-
//
|
|
193
|
-
if (transport.filter(message))
|
|
194
|
-
|
|
224
|
+
// Redundant message for the transport
|
|
225
|
+
if (!transport.filter(message))
|
|
226
|
+
continue;
|
|
227
|
+
// Check if adding this message would exceed the size limit
|
|
228
|
+
const currentBufferSize = transportBuffer.toBinary().byteLength;
|
|
229
|
+
const messageSize = message.messageBuffer.byteLength;
|
|
230
|
+
if (isNetworkTransport && (currentBufferSize + messageSize) / 1024 > LIVEKIT_MAX_SIZE) {
|
|
231
|
+
// If the current buffer has content, save it as a chunk
|
|
232
|
+
if (currentBufferSize > 0) {
|
|
233
|
+
__NetworkMessagesBuffer.push(transportBuffer.toCopiedBinary());
|
|
234
|
+
transportBuffer.resetBuffer();
|
|
235
|
+
}
|
|
236
|
+
// If the message itself is larger than the limit, we need to handle it specially
|
|
237
|
+
// For now, we'll skip it to prevent infinite loops
|
|
238
|
+
if (messageSize / 1024 > LIVEKIT_MAX_SIZE) {
|
|
239
|
+
console.error(`Message too large (${messageSize} bytes), skipping message for entity ${message.entityId}`);
|
|
240
|
+
continue;
|
|
241
|
+
}
|
|
195
242
|
}
|
|
243
|
+
const { entityId } = findNetworkId(message);
|
|
244
|
+
const transformNeedsFix = 'componentId' in message &&
|
|
245
|
+
message.componentId === Transform.componentId &&
|
|
246
|
+
Transform.has(entityId) &&
|
|
247
|
+
NetworkParent.has(entityId) &&
|
|
248
|
+
NetworkEntity.has(entityId);
|
|
249
|
+
// If there was a LOCAL change in the transform. Add the parent to that transform
|
|
250
|
+
if (isRendererTransport && message.type === CrdtMessageType.PUT_COMPONENT && transformNeedsFix) {
|
|
251
|
+
const parent = findNetworkId(NetworkParent.get(entityId));
|
|
252
|
+
const transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
|
|
253
|
+
const offset = buffer.currentWriteOffset();
|
|
254
|
+
PutComponentOperation.write(entityId, message.timestamp, message.componentId, transformData, buffer);
|
|
255
|
+
transportBuffer.writeBuffer(buffer.buffer().subarray(offset, buffer.currentWriteOffset()), false);
|
|
256
|
+
continue;
|
|
257
|
+
}
|
|
258
|
+
if (isRendererTransport && networkUtils.isNetworkMessage(message)) {
|
|
259
|
+
// If it's the renderer transport and its a NetworkMessage, we need to fix the entityId field and convert it to a known Message.
|
|
260
|
+
// PUT_NETWORK_COMPONENT -> PUT_COMPONENT
|
|
261
|
+
let transformData = 'data' in message ? message.data : new Uint8Array();
|
|
262
|
+
if (transformNeedsFix) {
|
|
263
|
+
const parent = findNetworkId(NetworkParent.get(entityId));
|
|
264
|
+
transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
|
|
265
|
+
}
|
|
266
|
+
networkUtils.networkMessageToLocal({ ...message, data: transformData }, entityId, buffer, transportBuffer);
|
|
267
|
+
// Iterate the next message
|
|
268
|
+
continue;
|
|
269
|
+
}
|
|
270
|
+
// If its a network transport and its a PUT_COMPONENT that has a NetworkEntity component, we need to send this message
|
|
271
|
+
// through comms with the EntityID and NetworkID from ther NetworkEntity so everyone can recieve this message and map to their custom entityID.
|
|
272
|
+
if (isNetworkTransport && !networkUtils.isNetworkMessage(message)) {
|
|
273
|
+
const networkData = NetworkEntity.getOrNull(message.entityId);
|
|
274
|
+
// If it has networkData convert the message to PUT_NETWORK_COMPONENT.
|
|
275
|
+
if (networkData) {
|
|
276
|
+
networkUtils.localMessageToNetwork(message, networkData, buffer, transportBuffer);
|
|
277
|
+
// Iterate the next message
|
|
278
|
+
continue;
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
// Common message
|
|
282
|
+
transportBuffer.writeBuffer(message.messageBuffer, false);
|
|
283
|
+
}
|
|
284
|
+
if (isNetworkTransport && transportBuffer.currentWriteOffset()) {
|
|
285
|
+
__NetworkMessagesBuffer.push(transportBuffer.toBinary());
|
|
196
286
|
}
|
|
197
|
-
|
|
287
|
+
const message = isNetworkTransport ? __NetworkMessagesBuffer : transportBuffer.toBinary();
|
|
288
|
+
await transport.send(message);
|
|
198
289
|
}
|
|
199
290
|
}
|
|
200
291
|
/**
|