@dcl/ecs 7.31.1-41498712919.commit-5e4cada → 7.32.0

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 (95) hide show
  1. package/dist/components/extended/TouchScreenControls.d.ts +6 -0
  2. package/dist/components/extended/TouchScreenControls.js +36 -0
  3. package/dist/components/generated/EnvironmentFog.gen.d.ts +1 -0
  4. package/dist/components/generated/EnvironmentFog.gen.js +25 -0
  5. package/dist/components/generated/Skybox.gen.d.ts +1 -0
  6. package/dist/components/generated/Skybox.gen.js +25 -0
  7. package/dist/components/generated/Sun.gen.d.ts +1 -0
  8. package/dist/components/generated/Sun.gen.js +25 -0
  9. package/dist/components/generated/component-names.gen.js +3 -0
  10. package/dist/components/generated/global.gen.d.ts +6 -0
  11. package/dist/components/generated/global.gen.js +3 -0
  12. package/dist/components/generated/index.gen.d.ts +12 -0
  13. package/dist/components/generated/index.gen.js +15 -0
  14. package/dist/components/generated/pb/decentraland/common/gradient.gen.d.ts +36 -0
  15. package/dist/components/generated/pb/decentraland/common/gradient.gen.js +89 -0
  16. package/dist/components/generated/pb/decentraland/sdk/components/environment_fog.gen.d.ts +28 -0
  17. package/dist/components/generated/pb/decentraland/sdk/components/environment_fog.gen.js +51 -0
  18. package/dist/components/generated/pb/decentraland/sdk/components/skybox.gen.d.ts +93 -0
  19. package/dist/components/generated/pb/decentraland/sdk/components/skybox.gen.js +228 -0
  20. package/dist/components/generated/pb/decentraland/sdk/components/sun.gen.d.ts +37 -0
  21. package/dist/components/generated/pb/decentraland/sdk/components/sun.gen.js +70 -0
  22. package/dist/components/generated/types.gen.d.ts +1 -0
  23. package/dist/components/generated/types.gen.js +2 -0
  24. package/dist/components/index.d.ts +0 -5
  25. package/dist/components/index.js +2 -5
  26. package/dist/components/manual/Transform.d.ts +0 -9
  27. package/dist/components/manual/Transform.js +3 -3
  28. package/dist/components/types.d.ts +0 -1
  29. package/dist/engine/component.d.ts +1 -52
  30. package/dist/engine/grow-only-value-set-component-definition.js +2 -45
  31. package/dist/engine/lww-element-set-component-definition.d.ts +1 -3
  32. package/dist/engine/lww-element-set-component-definition.js +13 -68
  33. package/dist/index.d.ts +1 -2
  34. package/dist/index.js +0 -1
  35. package/dist/serialization/crdt/index.d.ts +0 -1
  36. package/dist/serialization/crdt/index.js +0 -1
  37. package/dist/serialization/crdt/network/utils.d.ts +9 -0
  38. package/dist/serialization/crdt/network/utils.js +60 -0
  39. package/dist/serialization/crdt/types.d.ts +3 -25
  40. package/dist/serialization/crdt/types.js +1 -3
  41. package/dist/systems/crdt/index.d.ts +1 -0
  42. package/dist/systems/crdt/index.js +143 -76
  43. package/dist/systems/crdt/types.d.ts +0 -10
  44. package/dist-cjs/components/extended/TouchScreenControls.d.ts +6 -0
  45. package/dist-cjs/components/extended/TouchScreenControls.js +36 -0
  46. package/dist-cjs/components/generated/EnvironmentFog.gen.d.ts +1 -0
  47. package/dist-cjs/components/generated/EnvironmentFog.gen.js +28 -0
  48. package/dist-cjs/components/generated/Skybox.gen.d.ts +1 -0
  49. package/dist-cjs/components/generated/Skybox.gen.js +28 -0
  50. package/dist-cjs/components/generated/Sun.gen.d.ts +1 -0
  51. package/dist-cjs/components/generated/Sun.gen.js +28 -0
  52. package/dist-cjs/components/generated/component-names.gen.js +3 -0
  53. package/dist-cjs/components/generated/global.gen.d.ts +6 -0
  54. package/dist-cjs/components/generated/global.gen.js +5 -2
  55. package/dist-cjs/components/generated/index.gen.d.ts +12 -0
  56. package/dist-cjs/components/generated/index.gen.js +20 -2
  57. package/dist-cjs/components/generated/pb/decentraland/common/gradient.gen.d.ts +36 -0
  58. package/dist-cjs/components/generated/pb/decentraland/common/gradient.gen.js +95 -0
  59. package/dist-cjs/components/generated/pb/decentraland/sdk/components/environment_fog.gen.d.ts +28 -0
  60. package/dist-cjs/components/generated/pb/decentraland/sdk/components/environment_fog.gen.js +57 -0
  61. package/dist-cjs/components/generated/pb/decentraland/sdk/components/skybox.gen.d.ts +93 -0
  62. package/dist-cjs/components/generated/pb/decentraland/sdk/components/skybox.gen.js +234 -0
  63. package/dist-cjs/components/generated/pb/decentraland/sdk/components/sun.gen.d.ts +37 -0
  64. package/dist-cjs/components/generated/pb/decentraland/sdk/components/sun.gen.js +76 -0
  65. package/dist-cjs/components/generated/types.gen.d.ts +1 -0
  66. package/dist-cjs/components/generated/types.gen.js +2 -0
  67. package/dist-cjs/components/index.d.ts +0 -5
  68. package/dist-cjs/components/index.js +3 -7
  69. package/dist-cjs/components/manual/Transform.d.ts +0 -9
  70. package/dist-cjs/components/manual/Transform.js +3 -3
  71. package/dist-cjs/components/types.d.ts +0 -1
  72. package/dist-cjs/engine/component.d.ts +1 -52
  73. package/dist-cjs/engine/grow-only-value-set-component-definition.js +1 -44
  74. package/dist-cjs/engine/lww-element-set-component-definition.d.ts +1 -3
  75. package/dist-cjs/engine/lww-element-set-component-definition.js +14 -71
  76. package/dist-cjs/index.d.ts +1 -2
  77. package/dist-cjs/index.js +1 -2
  78. package/dist-cjs/serialization/crdt/index.d.ts +0 -1
  79. package/dist-cjs/serialization/crdt/index.js +0 -1
  80. package/dist-cjs/serialization/crdt/network/utils.d.ts +9 -0
  81. package/dist-cjs/serialization/crdt/network/utils.js +67 -0
  82. package/dist-cjs/serialization/crdt/types.d.ts +3 -25
  83. package/dist-cjs/serialization/crdt/types.js +1 -3
  84. package/dist-cjs/systems/crdt/index.d.ts +1 -0
  85. package/dist-cjs/systems/crdt/index.js +166 -76
  86. package/dist-cjs/systems/crdt/types.d.ts +0 -10
  87. package/package.json +2 -2
  88. package/dist/components/manual/CreatedBy.d.ts +0 -9
  89. package/dist/components/manual/CreatedBy.js +0 -8
  90. package/dist/serialization/crdt/authoritativePutComponent.d.ts +0 -15
  91. package/dist/serialization/crdt/authoritativePutComponent.js +0 -47
  92. package/dist-cjs/components/manual/CreatedBy.d.ts +0 -9
  93. package/dist-cjs/components/manual/CreatedBy.js +0 -10
  94. package/dist-cjs/serialization/crdt/authoritativePutComponent.d.ts +0 -15
  95. package/dist-cjs/serialization/crdt/authoritativePutComponent.js +0 -50
@@ -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
- // No network components needed - pure CRDT processing only
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.AUTHORITATIVE_PUT_COMPONENT) {
43
- message = AuthoritativePutComponentOperation.read(buffer);
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
- // Unknown message, we skip it (including NETWORK messages)
66
+ // consume the message
53
67
  buffer.incrementReadOffset(header.length);
54
68
  }
55
69
  if (message) {
@@ -71,12 +85,20 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
71
85
  return messagesToProcess;
72
86
  }
73
87
  /**
74
- * Reserved-range entities (root/player/camera + avatars, entity number <
75
- * RESERVED_STATIC_ENTITIES) are host-owned: only a transport flagged with
76
- * `allowReservedEntities` (the host/renderer) may mutate or delete them.
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
77
91
  */
78
- function isTrustedForReservedEntities(transportId) {
79
- return transportId !== undefined && !!transports[transportId]?.allowReservedEntities;
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 };
80
102
  }
81
103
  /**
82
104
  * This fn will be called on every tick.
@@ -86,68 +108,46 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
86
108
  const messagesToProcess = getMessages(receivedMessages);
87
109
  const entitiesShouldBeCleaned = [];
88
110
  for (const msg of messagesToProcess) {
89
- // Simple CRDT processing - no network logic
90
- if (msg.type === CrdtMessageType.DELETE_ENTITY) {
91
- // Reject an inbound DELETE_ENTITY on a reserved entity from an untrusted
92
- // transport (a comms peer, or a scene-added transport). The allocator half
93
- // is already guarded (engine.removeEntity is a no-op on this range); this
94
- // closes the receive-side half.
95
- const isReserved = engine.entityContainer.getEntityState(msg.entityId) === EntityState.Reserved;
96
- if (isReserved && !isTrustedForReservedEntities(msg.transportId)) {
97
- continue;
98
- }
99
- entitiesShouldBeCleaned.push(msg.entityId);
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);
100
120
  broadcastMessages.push(msg);
101
121
  }
102
122
  else {
103
- const entityState = engine.entityContainer.getEntityState(msg.entityId);
104
- // Skip updates from removed entities
123
+ const entityState = engine.entityContainer.getEntityState(entityId);
124
+ // Skip updates from removed entityes
105
125
  if (entityState === EntityState.Removed)
106
126
  continue;
107
- // Reject component operations (PUT/DELETE/APPEND, including AUTHORITATIVE_PUT
108
- // which bypasses timestamps entirely) on reserved entities from untrusted
109
- // transports. Dropping before updateFromCrdt keeps local LWW timestamps
110
- // unpoisoned by forged high timestamps, and also prevents the
111
- // unknown-component rebroadcast below from relaying forged reserved-entity
112
- // data to other transports (including the renderer).
113
- if (entityState === EntityState.Reserved && !isTrustedForReservedEntities(msg.transportId))
114
- continue;
115
- // Entities with unknown state should update its entity state
127
+ // Entities with unknown entities should update its entity state
116
128
  if (entityState === EntityState.Unknown) {
117
- engine.entityContainer.updateUsedEntity(msg.entityId);
118
- }
119
- // Only process component-related messages (not DELETE_ENTITY)
120
- if ('componentId' in msg) {
121
- const component = engine.getComponentOrNull(msg.componentId);
122
- if (component) {
123
- // Handle authoritative messages differently - they force the state regardless of timestamp
124
- const tryUpdate = () => {
125
- try {
126
- return msg.type === CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT
127
- ? component.__forceUpdateFromCrdt(msg)
128
- : component.updateFromCrdt(msg);
129
- }
130
- catch (e) {
131
- console.error('[receiveMessages] ERROR processing message', msg, e);
132
- return null;
133
- }
134
- };
135
- const result = tryUpdate();
136
- if (!result)
137
- continue;
138
- const [conflictMessage, value] = result;
139
- if (!conflictMessage) {
140
- // Add message to broadcast queue when no conflict
141
- broadcastMessages.push(msg);
142
- onProcessEntityComponentChange && onProcessEntityComponentChange(msg.entityId, msg.type, component, value);
143
- }
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);
144
139
  }
145
- else {
146
- // Component not found - still broadcast for editor compatibility
147
- /* istanbul ignore next */
140
+ const [conflictMessage, value] = component.updateFromCrdt({ ...msg, entityId });
141
+ if (!conflictMessage) {
142
+ // Add message to transport queue to be processed by others transports
148
143
  broadcastMessages.push(msg);
144
+ onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, msg.type, component, value);
149
145
  }
150
146
  }
147
+ else {
148
+ // TODO: test this line, it is fundammental to make the editor work
149
+ broadcastMessages.push(msg);
150
+ }
151
151
  }
152
152
  }
153
153
  // the last stage of the syncrhonization is to delete the entities
@@ -161,17 +161,16 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
161
161
  }
162
162
  }
163
163
  /**
164
- * Simple CRDT message broadcasting - no network-specific logic
164
+ * Iterates the dirty map and generates crdt messages to be send
165
165
  */
166
166
  async function sendMessages(entitiesDeletedThisTick) {
167
- // Get messages from broadcast queue and component updates
167
+ // CRDT Messages will be the merge between the recieved transport messages and the new crdt messages
168
168
  const crdtMessages = getMessages(broadcastMessages);
169
169
  const buffer = new ReadWriteByteBuffer();
170
- // Generate CRDT messages from component updates
171
170
  for (const component of engine.componentsIter()) {
172
171
  for (const message of component.getCrdtUpdates()) {
173
172
  const offset = buffer.currentWriteOffset();
174
- // Only create messages if there's a transport that will handle it
173
+ // Avoid creating messages if there is no transport that will handle it
175
174
  if (transports.some((t) => t.filter(message))) {
176
175
  if (message.type === CrdtMessageType.PUT_COMPONENT) {
177
176
  PutComponentOperation.write(message.entityId, message.timestamp, message.componentId, message.data, buffer);
@@ -195,7 +194,7 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
195
194
  }
196
195
  }
197
196
  }
198
- // Handle deleted entities
197
+ // After all updates, I execute the DeletedEntity messages
199
198
  for (const entityId of entitiesDeletedThisTick) {
200
199
  const offset = buffer.currentWriteOffset();
201
200
  DeleteEntity.write(entityId, buffer);
@@ -206,19 +205,87 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
206
205
  });
207
206
  onProcessEntityComponentChange && onProcessEntityComponentChange(entityId, CrdtMessageType.DELETE_ENTITY);
208
207
  }
209
- // Simple transport broadcasting - no network-specific transforms
210
- for (const transport of transports) {
211
- const transportBuffer = new ReadWriteByteBuffer();
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
212
220
  for (const message of crdtMessages) {
213
221
  // Avoid echo messages
214
- if (message.transportId === transports.indexOf(transport))
222
+ if (message.transportId === transportIndex)
215
223
  continue;
216
- // Check if transport wants this message
217
- if (transport.filter(message)) {
218
- transportBuffer.writeBuffer(message.messageBuffer, false);
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
+ }
219
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());
220
286
  }
221
- await transport.send(transportBuffer.toBinary());
287
+ const message = isNetworkTransport ? __NetworkMessagesBuffer : transportBuffer.toBinary();
288
+ await transport.send(message);
222
289
  }
223
290
  }
224
291
  /**
@@ -29,14 +29,4 @@ export type Transport = {
29
29
  onmessage?(message: Uint8Array): void;
30
30
  filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
31
31
  type?: string;
32
- /**
33
- * Whether this transport is allowed to mutate reserved-range entities
34
- * (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
35
- * Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
36
- * or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
37
- * AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
38
- * this flag (a comms peer, or any scene-added transport) is rejected — see
39
- * `receiveMessages`.
40
- */
41
- allowReservedEntities?: boolean;
42
32
  };
@@ -14,6 +14,12 @@ export interface TouchScreenControlsComponentDefinitionExtended extends LastWrit
14
14
  * Does NOT change the joystick/crosshair — use `showJoystick()` / `showCrosshair()` for those.
15
15
  */
16
16
  showAll(): void;
17
+ /**
18
+ * Show the default button set: jump, pointer and primary visible, secondary and
19
+ * actions 3-6 hidden. This is the state every scene starts in.
20
+ * Does NOT change the joystick/crosshair, the main action or custom icons.
21
+ */
22
+ showDefault(): void;
17
23
  /** Hide the given on-screen buttons (merged into the current config). */
18
24
  hide(actions: InputAction[]): void;
19
25
  /** Set which action the large central button triggers. */
@@ -14,6 +14,17 @@ const ALL_BUTTONS = [
14
14
  12 /* InputAction.IA_ACTION_5 */,
15
15
  13 /* InputAction.IA_ACTION_6 */
16
16
  ];
17
+ // Buttons hidden in the default set; the rest of ALL_BUTTONS stay visible.
18
+ const DEFAULT_HIDDEN_BUTTONS = [
19
+ 2 /* InputAction.IA_SECONDARY */,
20
+ 10 /* InputAction.IA_ACTION_3 */,
21
+ 11 /* InputAction.IA_ACTION_4 */,
22
+ 12 /* InputAction.IA_ACTION_5 */,
23
+ 13 /* InputAction.IA_ACTION_6 */
24
+ ];
25
+ // Component definitions on which a button-visibility helper ran. Keyed by the definition, which is
26
+ // shared by every wrapper built for the same engine.
27
+ const visibilityExpressed = new WeakSet();
17
28
  function defineTouchScreenControlsComponent(engine) {
18
29
  const theComponent = (0, index_gen_1.TouchScreenControls)(engine);
19
30
  // A mutable copy of the current RootEntity value (or a fresh default).
@@ -29,6 +40,7 @@ function defineTouchScreenControlsComponent(engine) {
29
40
  };
30
41
  }
31
42
  function setHidden(actions) {
43
+ visibilityExpressed.add(theComponent);
32
44
  const value = current();
33
45
  const byAction = new Map();
34
46
  for (const input of value.touchInputs)
@@ -38,16 +50,40 @@ function defineTouchScreenControlsComponent(engine) {
38
50
  value.touchInputs = [...byAction.values()];
39
51
  theComponent.createOrReplace(ROOT_ENTITY, value);
40
52
  }
53
+ // Every button visible except DEFAULT_HIDDEN_BUTTONS; existing entries keep their position and icon.
54
+ function writeDefault() {
55
+ const value = current();
56
+ const byAction = new Map();
57
+ for (const input of value.touchInputs)
58
+ byAction.set(input.inputAction, { ...input, hide: false });
59
+ for (const action of DEFAULT_HIDDEN_BUTTONS) {
60
+ byAction.set(action, { ...byAction.get(action), inputAction: action, hide: true });
61
+ }
62
+ value.touchInputs = [...byAction.values()];
63
+ theComponent.createOrReplace(ROOT_ENTITY, value);
64
+ }
41
65
  return {
42
66
  ...theComponent,
43
67
  hideAll() {
44
68
  setHidden(ALL_BUTTONS);
45
69
  },
46
70
  showAll() {
71
+ visibilityExpressed.add(theComponent);
47
72
  const value = current();
48
73
  value.touchInputs = [];
49
74
  theComponent.createOrReplace(ROOT_ENTITY, value);
50
75
  },
76
+ showDefault() {
77
+ visibilityExpressed.add(theComponent);
78
+ writeDefault();
79
+ },
80
+ applyDefaultIfUnset() {
81
+ if (visibilityExpressed.has(theComponent))
82
+ return;
83
+ if (theComponent.getOrNull(ROOT_ENTITY)?.touchInputs.length)
84
+ return;
85
+ writeDefault();
86
+ },
51
87
  hide(actions) {
52
88
  setHidden(actions);
53
89
  },
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EnvironmentFogSchema = void 0;
4
+ const environment_fog_gen_1 = require("./pb/decentraland/sdk/components/environment_fog.gen");
5
+ /**
6
+ * @internal
7
+ */
8
+ exports.EnvironmentFogSchema = {
9
+ COMPONENT_ID: 1225,
10
+ serialize(value, builder) {
11
+ const writer = environment_fog_gen_1.PBEnvironmentFog.encode(value);
12
+ const buffer = new Uint8Array(writer.finish(), 0, writer.len);
13
+ builder.writeBuffer(buffer, false);
14
+ },
15
+ deserialize(reader) {
16
+ return environment_fog_gen_1.PBEnvironmentFog.decode(reader.buffer(), reader.remainingBytes());
17
+ },
18
+ create() {
19
+ // TODO: this is a hack.
20
+ return environment_fog_gen_1.PBEnvironmentFog.decode(new Uint8Array());
21
+ },
22
+ jsonSchema: {
23
+ type: "object",
24
+ properties: {},
25
+ serializationType: "protocol-buffer",
26
+ protocolBuffer: "PBEnvironmentFog"
27
+ }
28
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SkyboxSchema = void 0;
4
+ const skybox_gen_1 = require("./pb/decentraland/sdk/components/skybox.gen");
5
+ /**
6
+ * @internal
7
+ */
8
+ exports.SkyboxSchema = {
9
+ COMPONENT_ID: 1223,
10
+ serialize(value, builder) {
11
+ const writer = skybox_gen_1.PBSkybox.encode(value);
12
+ const buffer = new Uint8Array(writer.finish(), 0, writer.len);
13
+ builder.writeBuffer(buffer, false);
14
+ },
15
+ deserialize(reader) {
16
+ return skybox_gen_1.PBSkybox.decode(reader.buffer(), reader.remainingBytes());
17
+ },
18
+ create() {
19
+ // TODO: this is a hack.
20
+ return skybox_gen_1.PBSkybox.decode(new Uint8Array());
21
+ },
22
+ jsonSchema: {
23
+ type: "object",
24
+ properties: {},
25
+ serializationType: "protocol-buffer",
26
+ protocolBuffer: "PBSkybox"
27
+ }
28
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SunSchema = void 0;
4
+ const sun_gen_1 = require("./pb/decentraland/sdk/components/sun.gen");
5
+ /**
6
+ * @internal
7
+ */
8
+ exports.SunSchema = {
9
+ COMPONENT_ID: 1224,
10
+ serialize(value, builder) {
11
+ const writer = sun_gen_1.PBSun.encode(value);
12
+ const buffer = new Uint8Array(writer.finish(), 0, writer.len);
13
+ builder.writeBuffer(buffer, false);
14
+ },
15
+ deserialize(reader) {
16
+ return sun_gen_1.PBSun.decode(reader.buffer(), reader.remainingBytes());
17
+ },
18
+ create() {
19
+ // TODO: this is a hack.
20
+ return sun_gen_1.PBSun.decode(new Uint8Array());
21
+ },
22
+ jsonSchema: {
23
+ type: "object",
24
+ properties: {},
25
+ serializationType: "protocol-buffer",
26
+ protocolBuffer: "PBSun"
27
+ }
28
+ };
@@ -25,6 +25,7 @@ exports.coreComponentMappings = {
25
25
  "core::CameraMode": 1072,
26
26
  "core::CameraModeArea": 1071,
27
27
  "core::EngineInfo": 1048,
28
+ "core::EnvironmentFog": 1225,
28
29
  "core::ExplorerItemPurchaseResult": 1222,
29
30
  "core::ExplorerUiEventsResult": 1220,
30
31
  "core::GltfContainer": 1041,
@@ -49,7 +50,9 @@ exports.coreComponentMappings = {
49
50
  "core::Raycast": 1067,
50
51
  "core::RaycastResult": 1068,
51
52
  "core::RealmInfo": 1106,
53
+ "core::Skybox": 1223,
52
54
  "core::SkyboxTime": 1210,
55
+ "core::Sun": 1224,
53
56
  "core::TextShape": 1030,
54
57
  "core::TouchScreenControls": 1218,
55
58
  "core::TriggerArea": 1060,
@@ -18,6 +18,7 @@ import { PBBillboard } from './pb/decentraland/sdk/components/billboard.gen';
18
18
  import { PBCameraMode } from './pb/decentraland/sdk/components/camera_mode.gen';
19
19
  import { PBCameraModeArea } from './pb/decentraland/sdk/components/camera_mode_area.gen';
20
20
  import { PBEngineInfo } from './pb/decentraland/sdk/components/engine_info.gen';
21
+ import { PBEnvironmentFog } from './pb/decentraland/sdk/components/environment_fog.gen';
21
22
  import { PBExplorerItemPurchaseResult } from './pb/decentraland/sdk/components/explorer_item_purchase_result.gen';
22
23
  import { PBExplorerUiEventsResult } from './pb/decentraland/sdk/components/explorer_ui_events_result.gen';
23
24
  import { PBGltfContainer } from './pb/decentraland/sdk/components/gltf_container.gen';
@@ -38,7 +39,9 @@ import { PBPrimaryPointerInfo } from './pb/decentraland/sdk/components/primary_p
38
39
  import { PBRaycast } from './pb/decentraland/sdk/components/raycast.gen';
39
40
  import { PBRaycastResult } from './pb/decentraland/sdk/components/raycast_result.gen';
40
41
  import { PBRealmInfo } from './pb/decentraland/sdk/components/realm_info.gen';
42
+ import { PBSkybox } from './pb/decentraland/sdk/components/skybox.gen';
41
43
  import { PBSkyboxTime } from './pb/decentraland/sdk/components/skybox_time.gen';
44
+ import { PBSun } from './pb/decentraland/sdk/components/sun.gen';
42
45
  import { PBTextShape } from './pb/decentraland/sdk/components/text_shape.gen';
43
46
  import { PBTouchScreenControls } from './pb/decentraland/sdk/components/touch_screen_controls.gen';
44
47
  import { PBTriggerArea } from './pb/decentraland/sdk/components/trigger_area.gen';
@@ -76,6 +79,7 @@ import { PBVisibilityComponent } from './pb/decentraland/sdk/components/visibili
76
79
  /** @public */ export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
77
80
  /** @public */ export declare const CameraModeArea: LastWriteWinElementSetComponentDefinition<PBCameraModeArea>;
78
81
  /** @public */ export declare const EngineInfo: LastWriteWinElementSetComponentDefinition<PBEngineInfo>;
82
+ /** @public */ export declare const EnvironmentFog: LastWriteWinElementSetComponentDefinition<PBEnvironmentFog>;
79
83
  /** @public */ export declare const ExplorerItemPurchaseResult: GrowOnlyValueSetComponentDefinition<PBExplorerItemPurchaseResult>;
80
84
  /** @public */ export declare const ExplorerUiEventsResult: GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>;
81
85
  /** @public */ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PBGltfContainer>;
@@ -96,7 +100,9 @@ import { PBVisibilityComponent } from './pb/decentraland/sdk/components/visibili
96
100
  /** @public */ export declare const Raycast: LastWriteWinElementSetComponentDefinition<PBRaycast>;
97
101
  /** @public */ export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
98
102
  /** @public */ export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;
103
+ /** @public */ export declare const Skybox: LastWriteWinElementSetComponentDefinition<PBSkybox>;
99
104
  /** @public */ export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
105
+ /** @public */ export declare const Sun: LastWriteWinElementSetComponentDefinition<PBSun>;
100
106
  /** @public */ export declare const TextShape: LastWriteWinElementSetComponentDefinition<PBTextShape>;
101
107
  /** @public */ export declare const TouchScreenControls: LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>;
102
108
  /** @public */ export declare const TriggerArea: LastWriteWinElementSetComponentDefinition<PBTriggerArea>;
@@ -26,8 +26,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
26
26
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.UiInput = exports.UiDropdownResult = exports.UiDropdown = exports.UiCanvasInformation = exports.UiBackground = exports.TweenState = exports.TweenSequence = exports.TriggerAreaResult = exports.TriggerArea = exports.TouchScreenControls = exports.TextShape = exports.SkyboxTime = exports.RealmInfo = exports.RaycastResult = exports.Raycast = exports.PrimaryPointerInfo = exports.PointerLock = exports.PointerEventsResult = exports.PointerEvents = exports.PlayerIdentityData = exports.PhysicsCombinedImpulse = exports.PhysicsCombinedForce = exports.ParticleSystem = exports.NftShape = exports.MainCamera = exports.LightSource = exports.InputModifier = exports.GltfNodeModifiers = exports.GltfContainerLoadingState = exports.GltfContainer = exports.ExplorerUiEventsResult = exports.ExplorerItemPurchaseResult = exports.EngineInfo = exports.CameraModeArea = exports.CameraMode = exports.Billboard = exports.AvatarShape = exports.AvatarNametag = exports.AvatarModifierArea = exports.AvatarLocomotionSettings = exports.AvatarEquippedData = exports.AvatarEmoteCommand = exports.AvatarBase = exports.AvatarAttach = exports.AudioStream = exports.AudioSource = exports.AudioEvent = exports.AudioAnalysis = exports.AssetLoadLoadingState = exports.AssetLoad = void 0;
30
- exports.VisibilityComponent = exports.VirtualCamera = exports.VideoPlayer = exports.VideoEvent = exports.UiTransform = exports.UiText = exports.UiInputResult = exports.UiInputBinding = void 0;
29
+ exports.UiCanvasInformation = exports.UiBackground = exports.TweenState = exports.TweenSequence = exports.TriggerAreaResult = exports.TriggerArea = exports.TouchScreenControls = exports.TextShape = exports.Sun = exports.SkyboxTime = exports.Skybox = exports.RealmInfo = exports.RaycastResult = exports.Raycast = exports.PrimaryPointerInfo = exports.PointerLock = exports.PointerEventsResult = exports.PointerEvents = exports.PlayerIdentityData = exports.PhysicsCombinedImpulse = exports.PhysicsCombinedForce = exports.ParticleSystem = exports.NftShape = exports.MainCamera = exports.LightSource = exports.InputModifier = exports.GltfNodeModifiers = exports.GltfContainerLoadingState = exports.GltfContainer = exports.ExplorerUiEventsResult = exports.ExplorerItemPurchaseResult = exports.EnvironmentFog = exports.EngineInfo = exports.CameraModeArea = exports.CameraMode = exports.Billboard = exports.AvatarShape = exports.AvatarNametag = exports.AvatarModifierArea = exports.AvatarLocomotionSettings = exports.AvatarEquippedData = exports.AvatarEmoteCommand = exports.AvatarBase = exports.AvatarAttach = exports.AudioStream = exports.AudioSource = exports.AudioEvent = exports.AudioAnalysis = exports.AssetLoadLoadingState = exports.AssetLoad = void 0;
30
+ exports.VisibilityComponent = exports.VirtualCamera = exports.VideoPlayer = exports.VideoEvent = exports.UiTransform = exports.UiText = exports.UiInputResult = exports.UiInputBinding = exports.UiInput = exports.UiDropdownResult = exports.UiDropdown = void 0;
31
31
  const initialization_1 = require("../../runtime/initialization");
32
32
  const components = __importStar(require("./index.gen"));
33
33
  __exportStar(require("./index.gen"), exports);
@@ -49,6 +49,7 @@ __exportStar(require("./index.gen"), exports);
49
49
  /** @public */ exports.CameraMode = components.CameraMode(initialization_1.engine);
50
50
  /** @public */ exports.CameraModeArea = components.CameraModeArea(initialization_1.engine);
51
51
  /** @public */ exports.EngineInfo = components.EngineInfo(initialization_1.engine);
52
+ /** @public */ exports.EnvironmentFog = components.EnvironmentFog(initialization_1.engine);
52
53
  /** @public */ exports.ExplorerItemPurchaseResult = components.ExplorerItemPurchaseResult(initialization_1.engine);
53
54
  /** @public */ exports.ExplorerUiEventsResult = components.ExplorerUiEventsResult(initialization_1.engine);
54
55
  /** @public */ exports.GltfContainer = components.GltfContainer(initialization_1.engine);
@@ -69,7 +70,9 @@ __exportStar(require("./index.gen"), exports);
69
70
  /** @public */ exports.Raycast = components.Raycast(initialization_1.engine);
70
71
  /** @public */ exports.RaycastResult = components.RaycastResult(initialization_1.engine);
71
72
  /** @public */ exports.RealmInfo = components.RealmInfo(initialization_1.engine);
73
+ /** @public */ exports.Skybox = components.Skybox(initialization_1.engine);
72
74
  /** @public */ exports.SkyboxTime = components.SkyboxTime(initialization_1.engine);
75
+ /** @public */ exports.Sun = components.Sun(initialization_1.engine);
73
76
  /** @public */ exports.TextShape = components.TextShape(initialization_1.engine);
74
77
  /** @public */ exports.TouchScreenControls = components.TouchScreenControls(initialization_1.engine);
75
78
  /** @public */ exports.TriggerArea = components.TriggerArea(initialization_1.engine);