@dcl/ecs 7.23.2-25521226778.commit-1828100 → 7.23.2-25802088407.commit-15e8697
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/index.d.ts +0 -5
- package/dist/components/index.js +2 -5
- package/dist/components/manual/Transform.d.ts +0 -9
- package/dist/components/manual/Transform.js +3 -3
- package/dist/components/types.d.ts +0 -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 +1 -3
- package/dist/engine/lww-element-set-component-definition.js +12 -64
- package/dist/index.d.ts +1 -2
- package/dist/index.js +0 -1
- 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/triggerArea.d.ts +5 -0
- package/dist/systems/triggerArea.js +129 -42
- package/dist-cjs/components/index.d.ts +0 -5
- package/dist-cjs/components/index.js +3 -7
- package/dist-cjs/components/manual/Transform.d.ts +0 -9
- package/dist-cjs/components/manual/Transform.js +3 -3
- package/dist-cjs/components/types.d.ts +0 -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 +1 -3
- package/dist-cjs/engine/lww-element-set-component-definition.js +13 -67
- package/dist-cjs/index.d.ts +1 -2
- package/dist-cjs/index.js +1 -2
- 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/triggerArea.d.ts +5 -0
- package/dist-cjs/systems/triggerArea.js +129 -42
- package/package.json +2 -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
|
@@ -1,20 +1,50 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
2
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.crdtSceneSystem = void 0;
|
|
26
|
+
exports.crdtSceneSystem = exports.LIVEKIT_MAX_SIZE = void 0;
|
|
4
27
|
const entity_1 = require("../../engine/entity");
|
|
5
28
|
const ByteBuffer_1 = require("../../serialization/ByteBuffer");
|
|
6
29
|
const crdt_1 = require("../../serialization/crdt");
|
|
7
30
|
const deleteComponent_1 = require("../../serialization/crdt/deleteComponent");
|
|
8
31
|
const deleteEntity_1 = require("../../serialization/crdt/deleteEntity");
|
|
9
32
|
const putComponent_1 = require("../../serialization/crdt/putComponent");
|
|
10
|
-
const authoritativePutComponent_1 = require("../../serialization/crdt/authoritativePutComponent");
|
|
11
33
|
const types_1 = require("../../serialization/crdt/types");
|
|
34
|
+
const putComponentNetwork_1 = require("../../serialization/crdt/network/putComponentNetwork");
|
|
35
|
+
const components_1 = require("../../components");
|
|
36
|
+
const networkUtils = __importStar(require("../../serialization/crdt/network/utils"));
|
|
37
|
+
// NetworkMessages can only have a MAX_SIZE of 12kb. So we need to send it in chunks.
|
|
38
|
+
exports.LIVEKIT_MAX_SIZE = 12;
|
|
12
39
|
/**
|
|
13
40
|
* @internal
|
|
14
41
|
*/
|
|
15
42
|
function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
16
43
|
const transports = [];
|
|
17
|
-
//
|
|
44
|
+
// Components that we used on this system
|
|
45
|
+
const NetworkEntity = (0, components_1.NetworkEntity)(engine);
|
|
46
|
+
const NetworkParent = (0, components_1.NetworkParent)(engine);
|
|
47
|
+
const Transform = (0, components_1.Transform)(engine);
|
|
18
48
|
// Messages that we received at transport.onMessage waiting to be processed
|
|
19
49
|
const receivedMessages = [];
|
|
20
50
|
// Messages already processed by the engine but that we need to broadcast to other transports.
|
|
@@ -39,20 +69,27 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
39
69
|
if (header.type === types_1.CrdtMessageType.DELETE_COMPONENT) {
|
|
40
70
|
message = deleteComponent_1.DeleteComponent.read(buffer);
|
|
41
71
|
}
|
|
72
|
+
else if (header.type === types_1.CrdtMessageType.DELETE_COMPONENT_NETWORK) {
|
|
73
|
+
message = crdt_1.DeleteComponentNetwork.read(buffer);
|
|
74
|
+
}
|
|
42
75
|
else if (header.type === types_1.CrdtMessageType.PUT_COMPONENT) {
|
|
43
76
|
message = putComponent_1.PutComponentOperation.read(buffer);
|
|
44
77
|
}
|
|
45
|
-
else if (header.type === types_1.CrdtMessageType.
|
|
46
|
-
message =
|
|
78
|
+
else if (header.type === types_1.CrdtMessageType.PUT_COMPONENT_NETWORK) {
|
|
79
|
+
message = putComponentNetwork_1.PutNetworkComponentOperation.read(buffer);
|
|
47
80
|
}
|
|
48
81
|
else if (header.type === types_1.CrdtMessageType.DELETE_ENTITY) {
|
|
49
82
|
message = deleteEntity_1.DeleteEntity.read(buffer);
|
|
50
83
|
}
|
|
84
|
+
else if (header.type === types_1.CrdtMessageType.DELETE_ENTITY_NETWORK) {
|
|
85
|
+
message = crdt_1.DeleteEntityNetwork.read(buffer);
|
|
86
|
+
}
|
|
51
87
|
else if (header.type === types_1.CrdtMessageType.APPEND_VALUE) {
|
|
52
88
|
message = crdt_1.AppendValueOperation.read(buffer);
|
|
89
|
+
// Unknown message, we skip it
|
|
53
90
|
}
|
|
54
91
|
else {
|
|
55
|
-
//
|
|
92
|
+
// consume the message
|
|
56
93
|
buffer.incrementReadOffset(header.length);
|
|
57
94
|
}
|
|
58
95
|
if (message) {
|
|
@@ -73,6 +110,22 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
73
110
|
const messagesToProcess = value.splice(0, value.length);
|
|
74
111
|
return messagesToProcess;
|
|
75
112
|
}
|
|
113
|
+
/**
|
|
114
|
+
* Find the local entityId associated to the network component message.
|
|
115
|
+
* It's a mapping Network -> to Local
|
|
116
|
+
* If it's not a network message, return the entityId received by the message
|
|
117
|
+
*/
|
|
118
|
+
function findNetworkId(msg) {
|
|
119
|
+
const hasNetworkId = 'networkId' in msg;
|
|
120
|
+
if (hasNetworkId) {
|
|
121
|
+
for (const [entityId, network] of engine.getEntitiesWith(NetworkEntity)) {
|
|
122
|
+
if (network.networkId === msg.networkId && network.entityId === msg.entityId) {
|
|
123
|
+
return { entityId, network };
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
return { entityId: msg.entityId };
|
|
128
|
+
}
|
|
76
129
|
/**
|
|
77
130
|
* This fn will be called on every tick.
|
|
78
131
|
* Process all the messages queue received by the transport
|
|
@@ -81,52 +134,46 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
81
134
|
const messagesToProcess = getMessages(receivedMessages);
|
|
82
135
|
const entitiesShouldBeCleaned = [];
|
|
83
136
|
for (const msg of messagesToProcess) {
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
137
|
+
let { entityId, network } = findNetworkId(msg);
|
|
138
|
+
// We receive a new Entity. Create the localEntity and map it to the NetworkEntity component
|
|
139
|
+
if (networkUtils.isNetworkMessage(msg) && !network) {
|
|
140
|
+
entityId = engine.addEntity();
|
|
141
|
+
network = { entityId: msg.entityId, networkId: msg.networkId };
|
|
142
|
+
NetworkEntity.createOrReplace(entityId, network);
|
|
143
|
+
}
|
|
144
|
+
if (msg.type === types_1.CrdtMessageType.DELETE_ENTITY || msg.type === types_1.CrdtMessageType.DELETE_ENTITY_NETWORK) {
|
|
145
|
+
entitiesShouldBeCleaned.push(entityId);
|
|
87
146
|
broadcastMessages.push(msg);
|
|
88
147
|
}
|
|
89
148
|
else {
|
|
90
|
-
const entityState = engine.entityContainer.getEntityState(
|
|
91
|
-
// Skip updates from removed
|
|
149
|
+
const entityState = engine.entityContainer.getEntityState(entityId);
|
|
150
|
+
// Skip updates from removed entityes
|
|
92
151
|
if (entityState === entity_1.EntityState.Removed)
|
|
93
152
|
continue;
|
|
94
|
-
// Entities with unknown
|
|
153
|
+
// Entities with unknown entities should update its entity state
|
|
95
154
|
if (entityState === entity_1.EntityState.Unknown) {
|
|
96
|
-
engine.entityContainer.updateUsedEntity(
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
if (
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
? component.__forceUpdateFromCrdt(msg)
|
|
107
|
-
: component.updateFromCrdt(msg);
|
|
108
|
-
}
|
|
109
|
-
catch (e) {
|
|
110
|
-
console.error('[receiveMessages] ERROR processing message', msg, e);
|
|
111
|
-
return null;
|
|
112
|
-
}
|
|
113
|
-
};
|
|
114
|
-
const result = tryUpdate();
|
|
115
|
-
if (!result)
|
|
116
|
-
continue;
|
|
117
|
-
const [conflictMessage, value] = result;
|
|
118
|
-
if (!conflictMessage) {
|
|
119
|
-
// Add message to broadcast queue when no conflict
|
|
120
|
-
broadcastMessages.push(msg);
|
|
121
|
-
onProcessEntityComponentChange && onProcessEntityComponentChange(msg.entityId, msg.type, component, value);
|
|
122
|
-
}
|
|
155
|
+
engine.entityContainer.updateUsedEntity(entityId);
|
|
156
|
+
}
|
|
157
|
+
const component = engine.getComponentOrNull(msg.componentId);
|
|
158
|
+
/* istanbul ignore else */
|
|
159
|
+
if (component) {
|
|
160
|
+
if (msg.type === types_1.CrdtMessageType.PUT_COMPONENT &&
|
|
161
|
+
component.componentId === Transform.componentId &&
|
|
162
|
+
NetworkEntity.has(entityId) &&
|
|
163
|
+
NetworkParent.has(entityId)) {
|
|
164
|
+
msg.data = networkUtils.fixTransformParent(msg);
|
|
123
165
|
}
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
166
|
+
const [conflictMessage, value] = component.updateFromCrdt({ ...msg, entityId });
|
|
167
|
+
if (!conflictMessage) {
|
|
168
|
+
// Add message to transport queue to be processed by others transports
|
|
127
169
|
broadcastMessages.push(msg);
|
|
170
|
+
onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, msg.type, component, value);
|
|
128
171
|
}
|
|
129
172
|
}
|
|
173
|
+
else {
|
|
174
|
+
// TODO: test this line, it is fundammental to make the editor work
|
|
175
|
+
broadcastMessages.push(msg);
|
|
176
|
+
}
|
|
130
177
|
}
|
|
131
178
|
}
|
|
132
179
|
// the last stage of the syncrhonization is to delete the entities
|
|
@@ -140,17 +187,16 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
140
187
|
}
|
|
141
188
|
}
|
|
142
189
|
/**
|
|
143
|
-
*
|
|
190
|
+
* Iterates the dirty map and generates crdt messages to be send
|
|
144
191
|
*/
|
|
145
192
|
async function sendMessages(entitiesDeletedThisTick) {
|
|
146
|
-
//
|
|
193
|
+
// CRDT Messages will be the merge between the recieved transport messages and the new crdt messages
|
|
147
194
|
const crdtMessages = getMessages(broadcastMessages);
|
|
148
195
|
const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
|
|
149
|
-
// Generate CRDT messages from component updates
|
|
150
196
|
for (const component of engine.componentsIter()) {
|
|
151
197
|
for (const message of component.getCrdtUpdates()) {
|
|
152
198
|
const offset = buffer.currentWriteOffset();
|
|
153
|
-
//
|
|
199
|
+
// Avoid creating messages if there is no transport that will handle it
|
|
154
200
|
if (transports.some((t) => t.filter(message))) {
|
|
155
201
|
if (message.type === types_1.CrdtMessageType.PUT_COMPONENT) {
|
|
156
202
|
putComponent_1.PutComponentOperation.write(message.entityId, message.timestamp, message.componentId, message.data, buffer);
|
|
@@ -174,7 +220,7 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
174
220
|
}
|
|
175
221
|
}
|
|
176
222
|
}
|
|
177
|
-
//
|
|
223
|
+
// After all updates, I execute the DeletedEntity messages
|
|
178
224
|
for (const entityId of entitiesDeletedThisTick) {
|
|
179
225
|
const offset = buffer.currentWriteOffset();
|
|
180
226
|
deleteEntity_1.DeleteEntity.write(entityId, buffer);
|
|
@@ -185,19 +231,87 @@ function crdtSceneSystem(engine, onProcessEntityComponentChange) {
|
|
|
185
231
|
});
|
|
186
232
|
onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, types_1.CrdtMessageType.DELETE_ENTITY);
|
|
187
233
|
}
|
|
188
|
-
//
|
|
189
|
-
|
|
190
|
-
|
|
234
|
+
// Send CRDT messages to transports
|
|
235
|
+
const transportBuffer = new ByteBuffer_1.ReadWriteByteBuffer();
|
|
236
|
+
for (const index in transports) {
|
|
237
|
+
const __NetworkMessagesBuffer = [];
|
|
238
|
+
const transportIndex = Number(index);
|
|
239
|
+
const transport = transports[transportIndex];
|
|
240
|
+
const isRendererTransport = transport.type === 'renderer';
|
|
241
|
+
const isNetworkTransport = transport.type === 'network';
|
|
242
|
+
// Reset Buffer for each Transport
|
|
243
|
+
transportBuffer.resetBuffer();
|
|
244
|
+
const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
|
|
245
|
+
// Then we send all the new crdtMessages that the transport needs to process
|
|
191
246
|
for (const message of crdtMessages) {
|
|
192
247
|
// Avoid echo messages
|
|
193
|
-
if (message.transportId ===
|
|
248
|
+
if (message.transportId === transportIndex)
|
|
249
|
+
continue;
|
|
250
|
+
// Redundant message for the transport
|
|
251
|
+
if (!transport.filter(message))
|
|
252
|
+
continue;
|
|
253
|
+
// Check if adding this message would exceed the size limit
|
|
254
|
+
const currentBufferSize = transportBuffer.toBinary().byteLength;
|
|
255
|
+
const messageSize = message.messageBuffer.byteLength;
|
|
256
|
+
if (isNetworkTransport && (currentBufferSize + messageSize) / 1024 > exports.LIVEKIT_MAX_SIZE) {
|
|
257
|
+
// If the current buffer has content, save it as a chunk
|
|
258
|
+
if (currentBufferSize > 0) {
|
|
259
|
+
__NetworkMessagesBuffer.push(transportBuffer.toCopiedBinary());
|
|
260
|
+
transportBuffer.resetBuffer();
|
|
261
|
+
}
|
|
262
|
+
// If the message itself is larger than the limit, we need to handle it specially
|
|
263
|
+
// For now, we'll skip it to prevent infinite loops
|
|
264
|
+
if (messageSize / 1024 > exports.LIVEKIT_MAX_SIZE) {
|
|
265
|
+
console.error(`Message too large (${messageSize} bytes), skipping message for entity ${message.entityId}`);
|
|
266
|
+
continue;
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
const { entityId } = findNetworkId(message);
|
|
270
|
+
const transformNeedsFix = 'componentId' in message &&
|
|
271
|
+
message.componentId === Transform.componentId &&
|
|
272
|
+
Transform.has(entityId) &&
|
|
273
|
+
NetworkParent.has(entityId) &&
|
|
274
|
+
NetworkEntity.has(entityId);
|
|
275
|
+
// If there was a LOCAL change in the transform. Add the parent to that transform
|
|
276
|
+
if (isRendererTransport && message.type === types_1.CrdtMessageType.PUT_COMPONENT && transformNeedsFix) {
|
|
277
|
+
const parent = findNetworkId(NetworkParent.get(entityId));
|
|
278
|
+
const transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
|
|
279
|
+
const offset = buffer.currentWriteOffset();
|
|
280
|
+
putComponent_1.PutComponentOperation.write(entityId, message.timestamp, message.componentId, transformData, buffer);
|
|
281
|
+
transportBuffer.writeBuffer(buffer.buffer().subarray(offset, buffer.currentWriteOffset()), false);
|
|
194
282
|
continue;
|
|
195
|
-
// Check if transport wants this message
|
|
196
|
-
if (transport.filter(message)) {
|
|
197
|
-
transportBuffer.writeBuffer(message.messageBuffer, false);
|
|
198
283
|
}
|
|
284
|
+
if (isRendererTransport && networkUtils.isNetworkMessage(message)) {
|
|
285
|
+
// If it's the renderer transport and its a NetworkMessage, we need to fix the entityId field and convert it to a known Message.
|
|
286
|
+
// PUT_NETWORK_COMPONENT -> PUT_COMPONENT
|
|
287
|
+
let transformData = 'data' in message ? message.data : new Uint8Array();
|
|
288
|
+
if (transformNeedsFix) {
|
|
289
|
+
const parent = findNetworkId(NetworkParent.get(entityId));
|
|
290
|
+
transformData = networkUtils.fixTransformParent(message, Transform.get(entityId), parent.entityId);
|
|
291
|
+
}
|
|
292
|
+
networkUtils.networkMessageToLocal({ ...message, data: transformData }, entityId, buffer, transportBuffer);
|
|
293
|
+
// Iterate the next message
|
|
294
|
+
continue;
|
|
295
|
+
}
|
|
296
|
+
// If its a network transport and its a PUT_COMPONENT that has a NetworkEntity component, we need to send this message
|
|
297
|
+
// through comms with the EntityID and NetworkID from ther NetworkEntity so everyone can recieve this message and map to their custom entityID.
|
|
298
|
+
if (isNetworkTransport && !networkUtils.isNetworkMessage(message)) {
|
|
299
|
+
const networkData = NetworkEntity.getOrNull(message.entityId);
|
|
300
|
+
// If it has networkData convert the message to PUT_NETWORK_COMPONENT.
|
|
301
|
+
if (networkData) {
|
|
302
|
+
networkUtils.localMessageToNetwork(message, networkData, buffer, transportBuffer);
|
|
303
|
+
// Iterate the next message
|
|
304
|
+
continue;
|
|
305
|
+
}
|
|
306
|
+
}
|
|
307
|
+
// Common message
|
|
308
|
+
transportBuffer.writeBuffer(message.messageBuffer, false);
|
|
309
|
+
}
|
|
310
|
+
if (isNetworkTransport && transportBuffer.currentWriteOffset()) {
|
|
311
|
+
__NetworkMessagesBuffer.push(transportBuffer.toBinary());
|
|
199
312
|
}
|
|
200
|
-
|
|
313
|
+
const message = isNetworkTransport ? __NetworkMessagesBuffer : transportBuffer.toBinary();
|
|
314
|
+
await transport.send(message);
|
|
201
315
|
}
|
|
202
316
|
}
|
|
203
317
|
/**
|
|
@@ -26,6 +26,11 @@ export interface TriggerAreaEventsSystem {
|
|
|
26
26
|
* Execute callback when an entity stays in the Trigger Area
|
|
27
27
|
* @param entity - The entity that already has the TriggerArea component
|
|
28
28
|
* @param cb - Function to execute the 'Stay' type of result is detected
|
|
29
|
+
*
|
|
30
|
+
* Note: stay callbacks are synthesized by the SDK on every tick between a wire ENTER and a wire EXIT.
|
|
31
|
+
* Wire-level TAET_STAY events (still emitted by legacy Explorers) are ignored entirely — they neither
|
|
32
|
+
* fire callbacks nor mutate state. The SDK is the sole source of onTriggerStay dispatches, driven
|
|
33
|
+
* from the ENTER/EXIT state machine.
|
|
29
34
|
*/
|
|
30
35
|
onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
|
|
31
36
|
/**
|
|
@@ -26,11 +26,58 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
26
26
|
exports.createTriggerAreaEventsSystem = void 0;
|
|
27
27
|
const components = __importStar(require("../components"));
|
|
28
28
|
const entity_1 = require("../engine/entity");
|
|
29
|
+
/**
|
|
30
|
+
* Builds a synthetic PBTriggerAreaResult for a per-tick onStay callback.
|
|
31
|
+
*
|
|
32
|
+
* Transform components are resolved at call time so that scene-owned entities report
|
|
33
|
+
* up-to-date position/rotation/scale. For player-avatar triggerers (reserved entities
|
|
34
|
+
* without a scene-side Transform), there is no scene Transform component, so the cached
|
|
35
|
+
* values from the last ENTER or wire-STAY event are used as-is. These cached values may
|
|
36
|
+
* be slightly stale for the current frame — this is expected and acceptable for the
|
|
37
|
+
* avatar case.
|
|
38
|
+
*/
|
|
39
|
+
function buildSyntheticStayResult(cached, triggerAreaEntity, triggererEntity, currentTimestamp, Transform) {
|
|
40
|
+
// Shallow-clone the trigger sub-object so we can mutate it.
|
|
41
|
+
const trigger = cached.trigger
|
|
42
|
+
? {
|
|
43
|
+
entity: cached.trigger.entity,
|
|
44
|
+
layers: cached.trigger.layers,
|
|
45
|
+
position: cached.trigger.position ? { ...cached.trigger.position } : undefined,
|
|
46
|
+
rotation: cached.trigger.rotation ? { ...cached.trigger.rotation } : undefined,
|
|
47
|
+
scale: cached.trigger.scale ? { ...cached.trigger.scale } : undefined
|
|
48
|
+
}
|
|
49
|
+
: undefined;
|
|
50
|
+
// Build the cloned result with a forced TAET_STAY eventType and refreshed timestamp.
|
|
51
|
+
const result = {
|
|
52
|
+
triggeredEntity: cached.triggeredEntity,
|
|
53
|
+
triggeredEntityPosition: cached.triggeredEntityPosition ? { ...cached.triggeredEntityPosition } : undefined,
|
|
54
|
+
triggeredEntityRotation: cached.triggeredEntityRotation ? { ...cached.triggeredEntityRotation } : undefined,
|
|
55
|
+
eventType: 1 /* TriggerAreaEventType.TAET_STAY */,
|
|
56
|
+
timestamp: currentTimestamp,
|
|
57
|
+
trigger
|
|
58
|
+
};
|
|
59
|
+
// Refresh trigger-area entity transform when it is scene-owned.
|
|
60
|
+
const triggerAreaTransform = Transform.getOrNull(triggerAreaEntity);
|
|
61
|
+
if (triggerAreaTransform !== null) {
|
|
62
|
+
result.triggeredEntityPosition = { ...triggerAreaTransform.position };
|
|
63
|
+
result.triggeredEntityRotation = { ...triggerAreaTransform.rotation };
|
|
64
|
+
}
|
|
65
|
+
// Refresh triggerer transform when it is scene-owned.
|
|
66
|
+
// For player-avatar entities (reserved, no scene-side Transform) the cached values are kept.
|
|
67
|
+
const triggererTransform = Transform.getOrNull(triggererEntity);
|
|
68
|
+
if (triggererTransform !== null && result.trigger) {
|
|
69
|
+
result.trigger.position = { ...triggererTransform.position };
|
|
70
|
+
result.trigger.rotation = { ...triggererTransform.rotation };
|
|
71
|
+
result.trigger.scale = { ...triggererTransform.scale };
|
|
72
|
+
}
|
|
73
|
+
return result;
|
|
74
|
+
}
|
|
29
75
|
/**
|
|
30
76
|
* @internal
|
|
31
77
|
*/
|
|
32
78
|
function createTriggerAreaEventsSystem(engine) {
|
|
33
79
|
const triggerAreaResultComponent = components.TriggerAreaResult(engine);
|
|
80
|
+
const Transform = components.Transform(engine);
|
|
34
81
|
const entitiesMap = new Map();
|
|
35
82
|
function hasCallbacksMap(entity) {
|
|
36
83
|
return entitiesMap.has(entity) && entitiesMap.get(entity) !== undefined;
|
|
@@ -42,7 +89,8 @@ function createTriggerAreaEventsSystem(engine) {
|
|
|
42
89
|
else {
|
|
43
90
|
entitiesMap.set(entity, {
|
|
44
91
|
triggerCallbackMap: new Map([[triggerType, callback]]),
|
|
45
|
-
lastConsumedTimestamp: -1
|
|
92
|
+
lastConsumedTimestamp: -1,
|
|
93
|
+
insideTriggerers: new Map()
|
|
46
94
|
});
|
|
47
95
|
}
|
|
48
96
|
}
|
|
@@ -51,7 +99,9 @@ function createTriggerAreaEventsSystem(engine) {
|
|
|
51
99
|
return;
|
|
52
100
|
const triggerCallbackMap = entitiesMap.get(entity).triggerCallbackMap;
|
|
53
101
|
triggerCallbackMap.delete(triggerType);
|
|
54
|
-
// Remove entity if no more trigger callbacks are registered
|
|
102
|
+
// Remove entity if no more trigger callbacks are registered.
|
|
103
|
+
// insideTriggerers is intentionally left populated so that re-subscription picks up
|
|
104
|
+
// in-flight sessions without missing the first synthesized onStay.
|
|
55
105
|
if (triggerCallbackMap.size === 0)
|
|
56
106
|
entitiesMap.delete(entity);
|
|
57
107
|
}
|
|
@@ -81,51 +131,88 @@ function createTriggerAreaEventsSystem(engine) {
|
|
|
81
131
|
continue;
|
|
82
132
|
}
|
|
83
133
|
const result = triggerAreaResultComponent.get(entity);
|
|
84
|
-
//
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
134
|
+
// -----------------------------------------------------------------------
|
|
135
|
+
// Pass 1: drain new GOVS events
|
|
136
|
+
// -----------------------------------------------------------------------
|
|
137
|
+
// The Explorer may be taking time before the result component is put.
|
|
138
|
+
if (result.size > 0) {
|
|
139
|
+
const values = Array.from(result.values());
|
|
140
|
+
// Determine starting index for new values (more than one could be added between System updates).
|
|
141
|
+
// Search backwards to find the anchor at lastConsumedTimestamp.
|
|
142
|
+
let startIndex = 0;
|
|
143
|
+
if (data.lastConsumedTimestamp >= 0) {
|
|
144
|
+
const newestTimestamp = values[values.length - 1].timestamp;
|
|
145
|
+
// If nothing new, skip processing.
|
|
146
|
+
if (newestTimestamp > data.lastConsumedTimestamp) {
|
|
147
|
+
// Find index of value with the lastConsumedTimestamp.
|
|
148
|
+
let i = values.length - 2;
|
|
149
|
+
while (i >= 0 && values[i].timestamp > data.lastConsumedTimestamp)
|
|
150
|
+
i--;
|
|
151
|
+
// Mark the following value index as the starting point to trigger all the new value callbacks.
|
|
152
|
+
startIndex = i + 1;
|
|
153
|
+
}
|
|
154
|
+
else {
|
|
155
|
+
// No new events — skip to Pass 2.
|
|
156
|
+
startIndex = values.length;
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
if (startIndex < values.length) {
|
|
160
|
+
// Process new wire events in chronological order.
|
|
161
|
+
for (let i = startIndex; i < values.length; i++) {
|
|
162
|
+
const event = values[i];
|
|
163
|
+
switch (event.eventType) {
|
|
164
|
+
case 0 /* TriggerAreaEventType.TAET_ENTER */:
|
|
165
|
+
// Update in-flight tracking before firing the callback.
|
|
166
|
+
data.insideTriggerers.set(event.trigger.entity, {
|
|
167
|
+
triggeredEntity: event.triggeredEntity,
|
|
168
|
+
triggeredEntityPosition: event.triggeredEntityPosition
|
|
169
|
+
? { ...event.triggeredEntityPosition }
|
|
170
|
+
: undefined,
|
|
171
|
+
triggeredEntityRotation: event.triggeredEntityRotation
|
|
172
|
+
? { ...event.triggeredEntityRotation }
|
|
173
|
+
: undefined,
|
|
174
|
+
eventType: event.eventType,
|
|
175
|
+
timestamp: event.timestamp,
|
|
176
|
+
trigger: event.trigger
|
|
177
|
+
? {
|
|
178
|
+
entity: event.trigger.entity,
|
|
179
|
+
layers: event.trigger.layers,
|
|
180
|
+
position: event.trigger.position ? { ...event.trigger.position } : undefined,
|
|
181
|
+
rotation: event.trigger.rotation ? { ...event.trigger.rotation } : undefined,
|
|
182
|
+
scale: event.trigger.scale ? { ...event.trigger.scale } : undefined
|
|
183
|
+
}
|
|
184
|
+
: undefined
|
|
185
|
+
});
|
|
186
|
+
if (data.triggerCallbackMap.has(0 /* TriggerAreaEventType.TAET_ENTER */)) {
|
|
187
|
+
data.triggerCallbackMap.get(0 /* TriggerAreaEventType.TAET_ENTER */)(event);
|
|
188
|
+
}
|
|
189
|
+
break;
|
|
190
|
+
case 2 /* TriggerAreaEventType.TAET_EXIT */:
|
|
191
|
+
data.insideTriggerers.delete(event.trigger.entity);
|
|
192
|
+
if (data.triggerCallbackMap.has(2 /* TriggerAreaEventType.TAET_EXIT */)) {
|
|
193
|
+
data.triggerCallbackMap.get(2 /* TriggerAreaEventType.TAET_EXIT */)(event);
|
|
194
|
+
}
|
|
195
|
+
break;
|
|
196
|
+
// Wire-level TAET_STAY and any unknown event types are ignored — no callback, no state mutation.
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
data.lastConsumedTimestamp = values[values.length - 1].timestamp;
|
|
96
200
|
}
|
|
97
|
-
// Find index of value with the lastConsumedTimestamp
|
|
98
|
-
let i = values.length - 2;
|
|
99
|
-
while (i >= 0 && values[i].timestamp > data.lastConsumedTimestamp)
|
|
100
|
-
i--;
|
|
101
|
-
// Mark the following value index as the starting point to trigger all the new value callbacks
|
|
102
|
-
startIndex = i + 1;
|
|
103
201
|
}
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
//
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
case 1 /* TriggerAreaEventType.TAET_STAY */:
|
|
115
|
-
if (!data.triggerCallbackMap.has(1 /* TriggerAreaEventType.TAET_STAY */))
|
|
116
|
-
continue;
|
|
117
|
-
data.triggerCallbackMap.get(1 /* TriggerAreaEventType.TAET_STAY */)(values[i]);
|
|
118
|
-
break;
|
|
119
|
-
case 2 /* TriggerAreaEventType.TAET_EXIT */:
|
|
120
|
-
if (!data.triggerCallbackMap.has(2 /* TriggerAreaEventType.TAET_EXIT */))
|
|
121
|
-
continue;
|
|
122
|
-
data.triggerCallbackMap.get(2 /* TriggerAreaEventType.TAET_EXIT */)(values[i]);
|
|
123
|
-
break;
|
|
202
|
+
// -----------------------------------------------------------------------
|
|
203
|
+
// Pass 2: synthesize per-tick onStay callbacks
|
|
204
|
+
// -----------------------------------------------------------------------
|
|
205
|
+
// Only run if an onStay callback is registered and there are tracked triggerers.
|
|
206
|
+
if (data.triggerCallbackMap.has(1 /* TriggerAreaEventType.TAET_STAY */) &&
|
|
207
|
+
data.insideTriggerers.size > 0) {
|
|
208
|
+
const onStay = data.triggerCallbackMap.get(1 /* TriggerAreaEventType.TAET_STAY */);
|
|
209
|
+
const currentTimestamp = Date.now();
|
|
210
|
+
for (const [triggererEntity, cachedResult] of data.insideTriggerers) {
|
|
211
|
+
onStay(buildSyntheticStayResult(cachedResult, entity, triggererEntity, currentTimestamp, Transform));
|
|
124
212
|
}
|
|
125
213
|
}
|
|
126
|
-
data.lastConsumedTimestamp = values[values.length - 1].timestamp;
|
|
127
214
|
}
|
|
128
|
-
// Clean up garbage entries
|
|
215
|
+
// Clean up garbage entries.
|
|
129
216
|
garbageEntries.forEach((garbageEntity) => entitiesMap.delete(garbageEntity));
|
|
130
217
|
});
|
|
131
218
|
return {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dcl/ecs",
|
|
3
3
|
"description": "Decentraland ECS",
|
|
4
|
-
"version": "7.23.2-
|
|
4
|
+
"version": "7.23.2-25802088407.commit-15e8697",
|
|
5
5
|
"author": "DCL",
|
|
6
6
|
"bugs": "https://github.com/decentraland/ecs/issues",
|
|
7
7
|
"files": [
|
|
@@ -34,5 +34,5 @@
|
|
|
34
34
|
"dependencies": {},
|
|
35
35
|
"types": "./dist/index.d.ts",
|
|
36
36
|
"typings": "./dist/index.d.ts",
|
|
37
|
-
"commit": "
|
|
37
|
+
"commit": "15e86977205ad099c6c1b81f6c14e1acb7b52bd7"
|
|
38
38
|
}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine/types';
|
|
2
|
-
export interface ICreatedByType {
|
|
3
|
-
address: string;
|
|
4
|
-
}
|
|
5
|
-
export type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
6
|
-
declare function defineCreatedBy(engine: Pick<IEngine, 'defineComponent'>): import("../../engine/types").MapComponentDefinition<import("../..").MapResult<{
|
|
7
|
-
address: import("../../schemas").ISchema<string>;
|
|
8
|
-
}>>;
|
|
9
|
-
export default defineCreatedBy;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { Entity } from '../../engine/entity';
|
|
2
|
-
import { ByteBuffer } from '../ByteBuffer';
|
|
3
|
-
import { AuthoritativePutComponentMessage } from './types';
|
|
4
|
-
/**
|
|
5
|
-
* @public
|
|
6
|
-
*/
|
|
7
|
-
export declare namespace AuthoritativePutComponentOperation {
|
|
8
|
-
const MESSAGE_HEADER_LENGTH = 16;
|
|
9
|
-
/**
|
|
10
|
-
* Call this function for an optimal writing data passing the ByteBuffer
|
|
11
|
-
* already allocated
|
|
12
|
-
*/
|
|
13
|
-
function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
14
|
-
function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
15
|
-
}
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import { CrdtMessageProtocol } from './crdtMessageProtocol';
|
|
2
|
-
import { CrdtMessageType, CRDT_MESSAGE_HEADER_LENGTH } from './types';
|
|
3
|
-
/**
|
|
4
|
-
* @public
|
|
5
|
-
*/
|
|
6
|
-
export var AuthoritativePutComponentOperation;
|
|
7
|
-
(function (AuthoritativePutComponentOperation) {
|
|
8
|
-
AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH = 16;
|
|
9
|
-
/**
|
|
10
|
-
* Call this function for an optimal writing data passing the ByteBuffer
|
|
11
|
-
* already allocated
|
|
12
|
-
*/
|
|
13
|
-
function write(entity, timestamp, componentId, data, buf) {
|
|
14
|
-
// reserve the beginning
|
|
15
|
-
const startMessageOffset = buf.incrementWriteOffset(CRDT_MESSAGE_HEADER_LENGTH + AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH);
|
|
16
|
-
// write body
|
|
17
|
-
buf.writeBuffer(data, false);
|
|
18
|
-
const messageLength = buf.currentWriteOffset() - startMessageOffset;
|
|
19
|
-
// Write CrdtMessage header
|
|
20
|
-
buf.setUint32(startMessageOffset, messageLength);
|
|
21
|
-
buf.setUint32(startMessageOffset + 4, CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT);
|
|
22
|
-
// Write ComponentOperation header
|
|
23
|
-
buf.setUint32(startMessageOffset + 8, entity);
|
|
24
|
-
buf.setUint32(startMessageOffset + 12, componentId);
|
|
25
|
-
buf.setUint32(startMessageOffset + 16, timestamp);
|
|
26
|
-
const newLocal = messageLength - AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH - CRDT_MESSAGE_HEADER_LENGTH;
|
|
27
|
-
buf.setUint32(startMessageOffset + 20, newLocal);
|
|
28
|
-
}
|
|
29
|
-
AuthoritativePutComponentOperation.write = write;
|
|
30
|
-
function read(buf) {
|
|
31
|
-
const header = CrdtMessageProtocol.readHeader(buf);
|
|
32
|
-
if (!header) {
|
|
33
|
-
return null;
|
|
34
|
-
}
|
|
35
|
-
if (header.type !== CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT) {
|
|
36
|
-
throw new Error('AuthoritativePutComponentOperation tried to read another message type.');
|
|
37
|
-
}
|
|
38
|
-
return {
|
|
39
|
-
...header,
|
|
40
|
-
entityId: buf.readUint32(),
|
|
41
|
-
componentId: buf.readUint32(),
|
|
42
|
-
timestamp: buf.readUint32(),
|
|
43
|
-
data: buf.readBuffer()
|
|
44
|
-
};
|
|
45
|
-
}
|
|
46
|
-
AuthoritativePutComponentOperation.read = read;
|
|
47
|
-
})(AuthoritativePutComponentOperation || (AuthoritativePutComponentOperation = {}));
|