@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.
Files changed (121) hide show
  1. package/dist/components/extended/ParticleSystem.d.ts +24 -0
  2. package/dist/components/extended/ParticleSystem.js +23 -0
  3. package/dist/components/generated/ParticleSystem.gen.d.ts +1 -0
  4. package/dist/components/generated/ParticleSystem.gen.js +25 -0
  5. package/dist/components/generated/component-names.gen.js +1 -0
  6. package/dist/components/generated/global.gen.d.ts +2 -0
  7. package/dist/components/generated/global.gen.js +1 -0
  8. package/dist/components/generated/index.gen.d.ts +4 -0
  9. package/dist/components/generated/index.gen.js +5 -0
  10. package/dist/components/generated/pb/decentraland/common/colors.gen.d.ts +15 -0
  11. package/dist/components/generated/pb/decentraland/common/colors.gen.js +47 -0
  12. package/dist/components/generated/pb/decentraland/common/floats.gen.d.ts +16 -0
  13. package/dist/components/generated/pb/decentraland/common/floats.gen.js +50 -0
  14. package/dist/components/generated/pb/decentraland/sdk/components/common/input_action.gen.d.ts +10 -1
  15. package/dist/components/generated/pb/decentraland/sdk/components/common/input_action.gen.js +10 -0
  16. package/dist/components/generated/pb/decentraland/sdk/components/particle_system.gen.d.ts +241 -0
  17. package/dist/components/generated/pb/decentraland/sdk/components/particle_system.gen.js +717 -0
  18. package/dist/components/generated/pb/decentraland/sdk/components/pointer_events.gen.d.ts +5 -1
  19. package/dist/components/generated/pb/decentraland/sdk/components/pointer_events.gen.js +20 -1
  20. package/dist/components/generated/types.gen.d.ts +2 -0
  21. package/dist/components/generated/types.gen.js +3 -0
  22. package/dist/components/index.d.ts +2 -5
  23. package/dist/components/index.js +5 -5
  24. package/dist/components/manual/Transform.d.ts +13 -9
  25. package/dist/components/manual/Transform.js +11 -3
  26. package/dist/components/types.d.ts +1 -1
  27. package/dist/engine/component.d.ts +1 -52
  28. package/dist/engine/grow-only-value-set-component-definition.js +2 -45
  29. package/dist/engine/lww-element-set-component-definition.d.ts +3 -5
  30. package/dist/engine/lww-element-set-component-definition.js +35 -70
  31. package/dist/index.d.ts +3 -2
  32. package/dist/index.js +3 -1
  33. package/dist/runtime/helpers/index.d.ts +1 -0
  34. package/dist/runtime/helpers/index.js +1 -0
  35. package/dist/runtime/helpers/tree.d.ts +6 -0
  36. package/dist/runtime/helpers/tree.js +2 -2
  37. package/dist/runtime/helpers/vectors.d.ts +1 -0
  38. package/dist/runtime/helpers/vectors.js +36 -0
  39. package/dist/runtime/initialization/index.d.ts +7 -0
  40. package/dist/runtime/initialization/index.js +6 -0
  41. package/dist/serialization/crdt/index.d.ts +0 -1
  42. package/dist/serialization/crdt/index.js +0 -1
  43. package/dist/serialization/crdt/network/utils.d.ts +9 -0
  44. package/dist/serialization/crdt/network/utils.js +60 -0
  45. package/dist/serialization/crdt/types.d.ts +3 -25
  46. package/dist/serialization/crdt/types.js +1 -3
  47. package/dist/systems/crdt/index.d.ts +1 -0
  48. package/dist/systems/crdt/index.js +146 -55
  49. package/dist/systems/events.d.ts +65 -0
  50. package/dist/systems/events.js +70 -8
  51. package/dist/systems/physics-force.d.ts +1 -0
  52. package/dist/systems/physics-force.js +140 -0
  53. package/dist/systems/physics-impulse.d.ts +12 -0
  54. package/dist/systems/physics-impulse.js +85 -0
  55. package/dist/systems/physics.d.ts +77 -0
  56. package/dist/systems/physics.js +18 -0
  57. package/dist-cjs/components/extended/ParticleSystem.d.ts +24 -0
  58. package/dist-cjs/components/extended/ParticleSystem.js +28 -0
  59. package/dist-cjs/components/generated/ParticleSystem.gen.d.ts +1 -0
  60. package/dist-cjs/components/generated/ParticleSystem.gen.js +28 -0
  61. package/dist-cjs/components/generated/component-names.gen.js +1 -0
  62. package/dist-cjs/components/generated/global.gen.d.ts +2 -0
  63. package/dist-cjs/components/generated/global.gen.js +3 -1
  64. package/dist-cjs/components/generated/index.gen.d.ts +4 -0
  65. package/dist-cjs/components/generated/index.gen.js +8 -2
  66. package/dist-cjs/components/generated/pb/decentraland/common/colors.gen.d.ts +15 -0
  67. package/dist-cjs/components/generated/pb/decentraland/common/colors.gen.js +48 -1
  68. package/dist-cjs/components/generated/pb/decentraland/common/floats.gen.d.ts +16 -0
  69. package/dist-cjs/components/generated/pb/decentraland/common/floats.gen.js +56 -0
  70. package/dist-cjs/components/generated/pb/decentraland/sdk/components/common/input_action.gen.d.ts +10 -1
  71. package/dist-cjs/components/generated/pb/decentraland/sdk/components/common/input_action.gen.js +11 -1
  72. package/dist-cjs/components/generated/pb/decentraland/sdk/components/particle_system.gen.d.ts +241 -0
  73. package/dist-cjs/components/generated/pb/decentraland/sdk/components/particle_system.gen.js +723 -0
  74. package/dist-cjs/components/generated/pb/decentraland/sdk/components/pointer_events.gen.d.ts +5 -1
  75. package/dist-cjs/components/generated/pb/decentraland/sdk/components/pointer_events.gen.js +20 -1
  76. package/dist-cjs/components/generated/types.gen.d.ts +2 -0
  77. package/dist-cjs/components/generated/types.gen.js +5 -0
  78. package/dist-cjs/components/index.d.ts +2 -5
  79. package/dist-cjs/components/index.js +7 -7
  80. package/dist-cjs/components/manual/Transform.d.ts +13 -9
  81. package/dist-cjs/components/manual/Transform.js +34 -3
  82. package/dist-cjs/components/types.d.ts +1 -1
  83. package/dist-cjs/engine/component.d.ts +1 -52
  84. package/dist-cjs/engine/grow-only-value-set-component-definition.js +1 -44
  85. package/dist-cjs/engine/lww-element-set-component-definition.d.ts +3 -5
  86. package/dist-cjs/engine/lww-element-set-component-definition.js +36 -73
  87. package/dist-cjs/index.d.ts +3 -2
  88. package/dist-cjs/index.js +4 -2
  89. package/dist-cjs/runtime/helpers/index.d.ts +1 -0
  90. package/dist-cjs/runtime/helpers/index.js +1 -0
  91. package/dist-cjs/runtime/helpers/tree.d.ts +6 -0
  92. package/dist-cjs/runtime/helpers/tree.js +3 -2
  93. package/dist-cjs/runtime/helpers/vectors.d.ts +1 -0
  94. package/dist-cjs/runtime/helpers/vectors.js +39 -0
  95. package/dist-cjs/runtime/initialization/index.d.ts +7 -0
  96. package/dist-cjs/runtime/initialization/index.js +7 -1
  97. package/dist-cjs/serialization/crdt/index.d.ts +0 -1
  98. package/dist-cjs/serialization/crdt/index.js +0 -1
  99. package/dist-cjs/serialization/crdt/network/utils.d.ts +9 -0
  100. package/dist-cjs/serialization/crdt/network/utils.js +67 -0
  101. package/dist-cjs/serialization/crdt/types.d.ts +3 -25
  102. package/dist-cjs/serialization/crdt/types.js +1 -3
  103. package/dist-cjs/systems/crdt/index.d.ts +1 -0
  104. package/dist-cjs/systems/crdt/index.js +169 -55
  105. package/dist-cjs/systems/events.d.ts +65 -0
  106. package/dist-cjs/systems/events.js +70 -8
  107. package/dist-cjs/systems/physics-force.d.ts +1 -0
  108. package/dist-cjs/systems/physics-force.js +167 -0
  109. package/dist-cjs/systems/physics-impulse.d.ts +12 -0
  110. package/dist-cjs/systems/physics-impulse.js +112 -0
  111. package/dist-cjs/systems/physics.d.ts +77 -0
  112. package/dist-cjs/systems/physics.js +23 -0
  113. package/package.json +3 -2
  114. package/dist/components/manual/CreatedBy.d.ts +0 -9
  115. package/dist/components/manual/CreatedBy.js +0 -8
  116. package/dist/serialization/crdt/authoritativePutComponent.d.ts +0 -15
  117. package/dist/serialization/crdt/authoritativePutComponent.js +0 -47
  118. package/dist-cjs/components/manual/CreatedBy.d.ts +0 -9
  119. package/dist-cjs/components/manual/CreatedBy.js +0 -10
  120. package/dist-cjs/serialization/crdt/authoritativePutComponent.d.ts +0 -15
  121. 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
- // No network components needed - pure CRDT processing only
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.AUTHORITATIVE_PUT_COMPONENT) {
46
- message = authoritativePutComponent_1.AuthoritativePutComponentOperation.read(buffer);
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
- // Unknown message, we skip it (including NETWORK messages)
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
- // Simple CRDT processing - no network logic
85
- if (msg.type === types_1.CrdtMessageType.DELETE_ENTITY) {
86
- entitiesShouldBeCleaned.push(msg.entityId);
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(msg.entityId);
91
- // Skip updates from removed entities
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 state should update its entity state
153
+ // Entities with unknown entities should update its entity state
95
154
  if (entityState === entity_1.EntityState.Unknown) {
96
- engine.entityContainer.updateUsedEntity(msg.entityId);
97
- }
98
- // Only process component-related messages (not DELETE_ENTITY)
99
- if ('componentId' in msg) {
100
- const component = engine.getComponentOrNull(msg.componentId);
101
- if (component) {
102
- // Handle authoritative messages differently - they force the state regardless of timestamp
103
- const tryUpdate = () => {
104
- try {
105
- return msg.type === types_1.CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT
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
- else {
125
- // Component not found - still broadcast for editor compatibility
126
- /* istanbul ignore next */
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
- * Simple CRDT message broadcasting - no network-specific logic
190
+ * Iterates the dirty map and generates crdt messages to be send
144
191
  */
145
192
  async function sendMessages(entitiesDeletedThisTick) {
146
- // Get messages from broadcast queue and component updates
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
- // Only create messages if there's a transport that will handle it
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
- // Handle deleted entities
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
- // Simple transport broadcasting - no network-specific transforms
189
- for (const transport of transports) {
190
- const transportBuffer = new ByteBuffer_1.ReadWriteByteBuffer();
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 === transports.indexOf(transport))
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
- await transport.send(transportBuffer.toBinary());
313
+ const message = isNetworkTransport ? __NetworkMessagesBuffer : transportBuffer.toBinary();
314
+ await transport.send(message);
201
315
  }
202
316
  }
203
317
  /**
@@ -17,6 +17,7 @@ export type EventSystemOptions = {
17
17
  showFeedback?: boolean;
18
18
  showHighlight?: boolean;
19
19
  maxPlayerDistance?: number;
20
+ priority?: number;
20
21
  };
21
22
  export declare const getDefaultOpts: (opts?: Partial<EventSystemOptions>) => EventSystemOptions;
22
23
  /**
@@ -47,6 +48,30 @@ export interface PointerEventsSystem {
47
48
  * @param entity - Entity where the callback was attached
48
49
  */
49
50
  removeOnPointerHoverLeave(entity: Entity): void;
51
+ /**
52
+ * @public
53
+ * Remove the callback for onProximityDown event
54
+ * @param entity - Entity where the callback was attached
55
+ */
56
+ removeOnProximityDown(entity: Entity): void;
57
+ /**
58
+ * @public
59
+ * Remove the callback for onProximityUp event
60
+ * @param entity - Entity where the callback was attached
61
+ */
62
+ removeOnProximityUp(entity: Entity): void;
63
+ /**
64
+ * @public
65
+ * Remove the callback for onProximityEnter event
66
+ * @param entity - Entity where the callback was attached
67
+ */
68
+ removeOnProximityEnter(entity: Entity): void;
69
+ /**
70
+ * @public
71
+ * Remove the callback for onProximityLeave event
72
+ * @param entity - Entity where the callback was attached
73
+ */
74
+ removeOnProximityLeave(entity: Entity): void;
50
75
  /**
51
76
  * @public
52
77
  * Execute callback when the user press the InputButton pointing at the entity
@@ -101,6 +126,46 @@ export interface PointerEventsSystem {
101
126
  entity: Entity;
102
127
  opts?: Partial<EventSystemOptions>;
103
128
  }, cb: EventSystemCallback): void;
129
+ /**
130
+ * @public
131
+ * Execute callback when the user presses the proximity button on the entity
132
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
133
+ * @param cb - Function to execute when click fires
134
+ */
135
+ onProximityDown(pointerData: {
136
+ entity: Entity;
137
+ opts?: Partial<EventSystemOptions>;
138
+ }, cb: EventSystemCallback): void;
139
+ /**
140
+ * @public
141
+ * Execute callback when the user releases the proximity button on the entity
142
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
143
+ * @param cb - Function to execute when event fires
144
+ */
145
+ onProximityUp(pointerData: {
146
+ entity: Entity;
147
+ opts?: Partial<EventSystemOptions>;
148
+ }, cb: EventSystemCallback): void;
149
+ /**
150
+ * @public
151
+ * Execute callback when the entity enters the proximity zone of the user
152
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
153
+ * @param cb - Function to execute when event fires
154
+ */
155
+ onProximityEnter(pointerData: {
156
+ entity: Entity;
157
+ opts?: Partial<EventSystemOptions>;
158
+ }, cb: EventSystemCallback): void;
159
+ /**
160
+ * @public
161
+ * Execute callback when the entity leaves the proximity zone of the user
162
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
163
+ * @param cb - Function to execute when event fires
164
+ */
165
+ onProximityLeave(pointerData: {
166
+ entity: Entity;
167
+ opts?: Partial<EventSystemOptions>;
168
+ }, cb: EventSystemCallback): void;
104
169
  }
105
170
  /**
106
171
  * @public
@@ -45,12 +45,14 @@ function createPointerEventsSystem(engine, inputSystem) {
45
45
  EventType[EventType["Up"] = 2] = "Up";
46
46
  EventType[EventType["HoverEnter"] = 3] = "HoverEnter";
47
47
  EventType[EventType["HoverLeave"] = 4] = "HoverLeave";
48
+ EventType[EventType["ProximityEnter"] = 5] = "ProximityEnter";
49
+ EventType[EventType["ProximityLeave"] = 6] = "ProximityLeave";
48
50
  })(EventType || (EventType = {}));
49
51
  const eventsMap = new Map();
50
52
  function getEvent(entity) {
51
53
  return eventsMap.get(entity) || eventsMap.set(entity, new Map()).get(entity);
52
54
  }
53
- function setPointerEvent(entity, type, opts) {
55
+ function setPointerEvent(entity, type, opts, interactionType = 0 /* InteractionType.CURSOR */) {
54
56
  const pointerEvent = PointerEvents.getMutableOrNull(entity) || PointerEvents.create(entity);
55
57
  pointerEvent.pointerEvents.push({
56
58
  eventType: type,
@@ -60,15 +62,19 @@ function createPointerEventsSystem(engine, inputSystem) {
60
62
  showHighlight: opts.showHighlight,
61
63
  hoverText: opts.hoverText,
62
64
  maxDistance: opts.maxDistance,
63
- maxPlayerDistance: opts.maxPlayerDistance
64
- }
65
+ maxPlayerDistance: opts.maxPlayerDistance,
66
+ priority: opts.priority
67
+ },
68
+ interactionType: interactionType ?? 0 /* InteractionType.CURSOR */
65
69
  });
66
70
  }
67
- function removePointerEvent(entity, type, button) {
71
+ function removePointerEvent(entity, type, button, interactionType = 0 /* InteractionType.CURSOR */) {
68
72
  const pointerEvent = PointerEvents.getMutableOrNull(entity);
69
73
  if (!pointerEvent)
70
74
  return;
71
- pointerEvent.pointerEvents = pointerEvent.pointerEvents.filter((pointer) => !(pointer.eventInfo?.button === button && pointer.eventType === type));
75
+ pointerEvent.pointerEvents = pointerEvent.pointerEvents.filter((pointer) => !(pointer.eventInfo?.button === button &&
76
+ pointer.eventType === type &&
77
+ pointer.interactionType === interactionType));
72
78
  }
73
79
  function getPointerEvent(eventType) {
74
80
  if (eventType === EventType.Up) {
@@ -80,9 +86,15 @@ function createPointerEventsSystem(engine, inputSystem) {
80
86
  else if (eventType === EventType.HoverEnter) {
81
87
  return 2 /* PointerEventType.PET_HOVER_ENTER */;
82
88
  }
89
+ else if (eventType === EventType.ProximityEnter) {
90
+ return 4 /* PointerEventType.PET_PROXIMITY_ENTER */;
91
+ }
92
+ else if (eventType === EventType.ProximityLeave) {
93
+ return 5 /* PointerEventType.PET_PROXIMITY_LEAVE */;
94
+ }
83
95
  return 1 /* PointerEventType.PET_DOWN */;
84
96
  }
85
- function removeEvent(entity, type) {
97
+ function removeEvent(entity, type, interactionType = 0 /* InteractionType.CURSOR */) {
86
98
  const event = getEvent(entity);
87
99
  const pointerEvent = event.get(type);
88
100
  if (pointerEvent?.opts.hoverText) {
@@ -105,7 +117,9 @@ function createPointerEventsSystem(engine, inputSystem) {
105
117
  if (eventType === EventType.Down ||
106
118
  eventType === EventType.Up ||
107
119
  eventType === EventType.HoverEnter ||
108
- eventType === EventType.HoverLeave) {
120
+ eventType === EventType.HoverLeave ||
121
+ eventType === EventType.ProximityEnter ||
122
+ eventType === EventType.ProximityLeave) {
109
123
  const command = inputSystem.getInputCommand(opts.button, getPointerEvent(eventType), entity);
110
124
  if (command) {
111
125
  (0, invariant_1.checkNotThenable)(cb(command), 'Event handler returned a thenable. Only synchronous functions are allowed');
@@ -152,6 +166,38 @@ function createPointerEventsSystem(engine, inputSystem) {
152
166
  getEvent(entity).set(EventType.HoverLeave, { cb, opts: options });
153
167
  setPointerEvent(entity, 3 /* PointerEventType.PET_HOVER_LEAVE */, options);
154
168
  };
169
+ const onProximityDown = (...args) => {
170
+ const [data, cb] = args;
171
+ const { entity, opts } = data;
172
+ const options = (0, exports.getDefaultOpts)(opts);
173
+ removeEvent(entity, EventType.Down, 1 /* InteractionType.PROXIMITY */);
174
+ getEvent(entity).set(EventType.Down, { cb, opts: options });
175
+ setPointerEvent(entity, 1 /* PointerEventType.PET_DOWN */, options, 1 /* InteractionType.PROXIMITY */);
176
+ };
177
+ const onProximityUp = (...args) => {
178
+ const [data, cb] = args;
179
+ const { entity, opts } = data;
180
+ const options = (0, exports.getDefaultOpts)(opts);
181
+ removeEvent(entity, EventType.Up, 1 /* InteractionType.PROXIMITY */);
182
+ getEvent(entity).set(EventType.Up, { cb, opts: options });
183
+ setPointerEvent(entity, 0 /* PointerEventType.PET_UP */, options, 1 /* InteractionType.PROXIMITY */);
184
+ };
185
+ const onProximityEnter = (...args) => {
186
+ const [data, cb] = args;
187
+ const { entity, opts } = data;
188
+ const options = (0, exports.getDefaultOpts)(opts);
189
+ removeEvent(entity, EventType.ProximityEnter, 1 /* InteractionType.PROXIMITY */);
190
+ getEvent(entity).set(EventType.ProximityEnter, { cb, opts: options });
191
+ setPointerEvent(entity, 4 /* PointerEventType.PET_PROXIMITY_ENTER */, options, 1 /* InteractionType.PROXIMITY */);
192
+ };
193
+ const onProximityLeave = (...args) => {
194
+ const [data, cb] = args;
195
+ const { entity, opts } = data;
196
+ const options = (0, exports.getDefaultOpts)(opts);
197
+ removeEvent(entity, EventType.ProximityLeave, 1 /* InteractionType.PROXIMITY */);
198
+ getEvent(entity).set(EventType.ProximityLeave, { cb, opts: options });
199
+ setPointerEvent(entity, 5 /* PointerEventType.PET_PROXIMITY_LEAVE */, options, 1 /* InteractionType.PROXIMITY */);
200
+ };
155
201
  return {
156
202
  removeOnClick(entity) {
157
203
  removeEvent(entity, EventType.Click);
@@ -168,6 +214,18 @@ function createPointerEventsSystem(engine, inputSystem) {
168
214
  removeOnPointerHoverLeave(entity) {
169
215
  removeEvent(entity, EventType.HoverLeave);
170
216
  },
217
+ removeOnProximityDown(entity) {
218
+ removeEvent(entity, EventType.Down, 1 /* InteractionType.PROXIMITY */);
219
+ },
220
+ removeOnProximityUp(entity) {
221
+ removeEvent(entity, EventType.Up, 1 /* InteractionType.PROXIMITY */);
222
+ },
223
+ removeOnProximityEnter(entity) {
224
+ removeEvent(entity, EventType.ProximityEnter, 1 /* InteractionType.PROXIMITY */);
225
+ },
226
+ removeOnProximityLeave(entity) {
227
+ removeEvent(entity, EventType.ProximityLeave, 1 /* InteractionType.PROXIMITY */);
228
+ },
171
229
  onClick(value, cb) {
172
230
  const { entity } = value;
173
231
  const options = (0, exports.getDefaultOpts)(value.opts);
@@ -180,7 +238,11 @@ function createPointerEventsSystem(engine, inputSystem) {
180
238
  onPointerDown,
181
239
  onPointerUp,
182
240
  onPointerHoverEnter,
183
- onPointerHoverLeave
241
+ onPointerHoverLeave,
242
+ onProximityDown,
243
+ onProximityUp,
244
+ onProximityEnter,
245
+ onProximityLeave
184
246
  };
185
247
  }
186
248
  exports.createPointerEventsSystem = createPointerEventsSystem;
@@ -0,0 +1 @@
1
+ export {};