@dcl/ecs 7.5.0 → 7.5.1-9235895775.commit-075ab65

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 (17) hide show
  1. package/dist/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.d.ts +43 -0
  2. package/dist/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.js +151 -1
  3. package/dist/components/generated/pb/decentraland/sdk/components/camera_mode_area.gen.d.ts +37 -1
  4. package/dist/components/generated/pb/decentraland/sdk/components/camera_mode_area.gen.js +119 -1
  5. package/dist/components/generated/pb/decentraland/sdk/components/ui_text.gen.d.ts +4 -0
  6. package/dist/components/generated/pb/decentraland/sdk/components/ui_text.gen.js +27 -1
  7. package/dist/components/generated/pb/decentraland/sdk/components/ui_transform.gen.d.ts +2 -0
  8. package/dist/components/generated/pb/decentraland/sdk/components/ui_transform.gen.js +10 -0
  9. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.d.ts +43 -0
  10. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.js +152 -2
  11. package/dist-cjs/components/generated/pb/decentraland/sdk/components/camera_mode_area.gen.d.ts +37 -1
  12. package/dist-cjs/components/generated/pb/decentraland/sdk/components/camera_mode_area.gen.js +120 -2
  13. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_text.gen.d.ts +4 -0
  14. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_text.gen.js +27 -1
  15. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_transform.gen.d.ts +2 -0
  16. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_transform.gen.js +10 -0
  17. package/package.json +2 -2
@@ -10,6 +10,17 @@ export declare const enum AvatarModifierType {
10
10
  /** AMT_DISABLE_PASSPORTS - selecting (e.g. clicking) an avatar will not bring up their profile. */
11
11
  AMT_DISABLE_PASSPORTS = 1
12
12
  }
13
+ /**
14
+ * @public
15
+ */
16
+ export declare const enum AvatarControlType {
17
+ /** CCT_NONE - avatar cannot move */
18
+ CCT_NONE = 0,
19
+ /** CCT_RELATIVE - avatar moves relative to the camera origin */
20
+ CCT_RELATIVE = 1,
21
+ /** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
22
+ CCT_TANK = 2
23
+ }
13
24
  /**
14
25
  * The AvatarModifierArea component can be attached to an Entity to define a region of space where
15
26
  * avatar behavior changes.
@@ -34,6 +45,31 @@ export interface PBAvatarModifierArea {
34
45
  excludeIds: string[];
35
46
  /** list of modifiers to apply */
36
47
  modifiers: AvatarModifierType[];
48
+ movementSettings?: AvatarMovementSettings | undefined;
49
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
50
+ useColliderRange?: boolean | undefined;
51
+ }
52
+ /**
53
+ * @public
54
+ */
55
+ export interface AvatarMovementSettings {
56
+ controlMode?: AvatarControlType | undefined;
57
+ /** if not explicitly set, the following properties default to user's preference settings */
58
+ runSpeed?: number | undefined;
59
+ /** how fast the player gets up to speed or comes to rest. higher = more responsive */
60
+ friction?: number | undefined;
61
+ /** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
62
+ gravity?: number | undefined;
63
+ /** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
64
+ jumpHeight?: number | undefined;
65
+ /** max fall speed in m/s. should normally be negative */
66
+ maxFallSpeed?: number | undefined;
67
+ /** speed the player turns in tank mode, in radians/s */
68
+ turnSpeed?: number | undefined;
69
+ /** speed the player walks at, in m/s */
70
+ walkSpeed?: number | undefined;
71
+ /** whether to allow player to move at a slower speed (e.g. with a walk-key or when using a gamepad/joystick). defaults to true */
72
+ allowWeightedMovement?: boolean | undefined;
37
73
  }
38
74
  /**
39
75
  * @public
@@ -42,3 +78,10 @@ export declare namespace PBAvatarModifierArea {
42
78
  function encode(message: PBAvatarModifierArea, writer?: _m0.Writer): _m0.Writer;
43
79
  function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
44
80
  }
81
+ /**
82
+ * @public
83
+ */
84
+ export declare namespace AvatarMovementSettings {
85
+ function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
86
+ function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
87
+ }
@@ -13,8 +13,20 @@ export var AvatarModifierType;
13
13
  /** AMT_DISABLE_PASSPORTS - selecting (e.g. clicking) an avatar will not bring up their profile. */
14
14
  AvatarModifierType[AvatarModifierType["AMT_DISABLE_PASSPORTS"] = 1] = "AMT_DISABLE_PASSPORTS";
15
15
  })(AvatarModifierType || (AvatarModifierType = {}));
16
+ /**
17
+ * @public
18
+ */
19
+ export var AvatarControlType;
20
+ (function (AvatarControlType) {
21
+ /** CCT_NONE - avatar cannot move */
22
+ AvatarControlType[AvatarControlType["CCT_NONE"] = 0] = "CCT_NONE";
23
+ /** CCT_RELATIVE - avatar moves relative to the camera origin */
24
+ AvatarControlType[AvatarControlType["CCT_RELATIVE"] = 1] = "CCT_RELATIVE";
25
+ /** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
26
+ AvatarControlType[AvatarControlType["CCT_TANK"] = 2] = "CCT_TANK";
27
+ })(AvatarControlType || (AvatarControlType = {}));
16
28
  function createBasePBAvatarModifierArea() {
17
- return { area: undefined, excludeIds: [], modifiers: [] };
29
+ return { area: undefined, excludeIds: [], modifiers: [], movementSettings: undefined, useColliderRange: undefined };
18
30
  }
19
31
  /**
20
32
  * @public
@@ -33,6 +45,12 @@ export var PBAvatarModifierArea;
33
45
  writer.int32(v);
34
46
  }
35
47
  writer.ldelim();
48
+ if (message.movementSettings !== undefined) {
49
+ AvatarMovementSettings.encode(message.movementSettings, writer.uint32(34).fork()).ldelim();
50
+ }
51
+ if (message.useColliderRange !== undefined) {
52
+ writer.uint32(40).bool(message.useColliderRange);
53
+ }
36
54
  return writer;
37
55
  }
38
56
  PBAvatarModifierArea.encode = encode;
@@ -68,6 +86,18 @@ export var PBAvatarModifierArea;
68
86
  continue;
69
87
  }
70
88
  break;
89
+ case 4:
90
+ if (tag !== 34) {
91
+ break;
92
+ }
93
+ message.movementSettings = AvatarMovementSettings.decode(reader, reader.uint32());
94
+ continue;
95
+ case 5:
96
+ if (tag !== 40) {
97
+ break;
98
+ }
99
+ message.useColliderRange = reader.bool();
100
+ continue;
71
101
  }
72
102
  if ((tag & 7) === 4 || tag === 0) {
73
103
  break;
@@ -78,3 +108,123 @@ export var PBAvatarModifierArea;
78
108
  }
79
109
  PBAvatarModifierArea.decode = decode;
80
110
  })(PBAvatarModifierArea || (PBAvatarModifierArea = {}));
111
+ function createBaseAvatarMovementSettings() {
112
+ return {
113
+ controlMode: undefined,
114
+ runSpeed: undefined,
115
+ friction: undefined,
116
+ gravity: undefined,
117
+ jumpHeight: undefined,
118
+ maxFallSpeed: undefined,
119
+ turnSpeed: undefined,
120
+ walkSpeed: undefined,
121
+ allowWeightedMovement: undefined,
122
+ };
123
+ }
124
+ /**
125
+ * @public
126
+ */
127
+ export var AvatarMovementSettings;
128
+ (function (AvatarMovementSettings) {
129
+ function encode(message, writer = _m0.Writer.create()) {
130
+ if (message.controlMode !== undefined) {
131
+ writer.uint32(8).int32(message.controlMode);
132
+ }
133
+ if (message.runSpeed !== undefined) {
134
+ writer.uint32(21).float(message.runSpeed);
135
+ }
136
+ if (message.friction !== undefined) {
137
+ writer.uint32(29).float(message.friction);
138
+ }
139
+ if (message.gravity !== undefined) {
140
+ writer.uint32(37).float(message.gravity);
141
+ }
142
+ if (message.jumpHeight !== undefined) {
143
+ writer.uint32(45).float(message.jumpHeight);
144
+ }
145
+ if (message.maxFallSpeed !== undefined) {
146
+ writer.uint32(53).float(message.maxFallSpeed);
147
+ }
148
+ if (message.turnSpeed !== undefined) {
149
+ writer.uint32(61).float(message.turnSpeed);
150
+ }
151
+ if (message.walkSpeed !== undefined) {
152
+ writer.uint32(69).float(message.walkSpeed);
153
+ }
154
+ if (message.allowWeightedMovement !== undefined) {
155
+ writer.uint32(72).bool(message.allowWeightedMovement);
156
+ }
157
+ return writer;
158
+ }
159
+ AvatarMovementSettings.encode = encode;
160
+ function decode(input, length) {
161
+ const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
162
+ let end = length === undefined ? reader.len : reader.pos + length;
163
+ const message = createBaseAvatarMovementSettings();
164
+ while (reader.pos < end) {
165
+ const tag = reader.uint32();
166
+ switch (tag >>> 3) {
167
+ case 1:
168
+ if (tag !== 8) {
169
+ break;
170
+ }
171
+ message.controlMode = reader.int32();
172
+ continue;
173
+ case 2:
174
+ if (tag !== 21) {
175
+ break;
176
+ }
177
+ message.runSpeed = reader.float();
178
+ continue;
179
+ case 3:
180
+ if (tag !== 29) {
181
+ break;
182
+ }
183
+ message.friction = reader.float();
184
+ continue;
185
+ case 4:
186
+ if (tag !== 37) {
187
+ break;
188
+ }
189
+ message.gravity = reader.float();
190
+ continue;
191
+ case 5:
192
+ if (tag !== 45) {
193
+ break;
194
+ }
195
+ message.jumpHeight = reader.float();
196
+ continue;
197
+ case 6:
198
+ if (tag !== 53) {
199
+ break;
200
+ }
201
+ message.maxFallSpeed = reader.float();
202
+ continue;
203
+ case 7:
204
+ if (tag !== 61) {
205
+ break;
206
+ }
207
+ message.turnSpeed = reader.float();
208
+ continue;
209
+ case 8:
210
+ if (tag !== 69) {
211
+ break;
212
+ }
213
+ message.walkSpeed = reader.float();
214
+ continue;
215
+ case 9:
216
+ if (tag !== 72) {
217
+ break;
218
+ }
219
+ message.allowWeightedMovement = reader.bool();
220
+ continue;
221
+ }
222
+ if ((tag & 7) === 4 || tag === 0) {
223
+ break;
224
+ }
225
+ reader.skipType(tag & 7);
226
+ }
227
+ return message;
228
+ }
229
+ AvatarMovementSettings.decode = decode;
230
+ })(AvatarMovementSettings || (AvatarMovementSettings = {}));
@@ -3,7 +3,7 @@ import { Vector3 } from "../../common/vectors.gen";
3
3
  import { CameraType } from "./common/camera_type.gen";
4
4
  /**
5
5
  * The CameraModeArea component can be attached to an Entity to define a region of space where
6
- * the player's camera mode (1st-person or 3rd-person) is overridden.
6
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
7
7
  *
8
8
  * The Entity's Transform position determines the center-point of the region, while its size is
9
9
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -13,6 +13,8 @@ import { CameraType } from "./common/camera_type.gen";
13
13
  *
14
14
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
15
15
  * is actually a 3D volume.
16
+ *
17
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
16
18
  */
17
19
  /**
18
20
  * @public
@@ -22,6 +24,33 @@ export interface PBCameraModeArea {
22
24
  area: Vector3 | undefined;
23
25
  /** the camera mode to enforce */
24
26
  mode: CameraType;
27
+ cinematicSettings?: CinematicSettings | undefined;
28
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
29
+ useColliderRange?: boolean | undefined;
30
+ }
31
+ /**
32
+ * @public
33
+ */
34
+ export interface CinematicSettings {
35
+ /** Entity that defines the cinematic camera transform. */
36
+ cameraEntity: number;
37
+ /**
38
+ * Position -> camera's position
39
+ * Rotation -> camera's direction
40
+ * scale.z -> zoom level
41
+ * scale.x and scale.y -> unused
42
+ */
43
+ allowManualRotation?: boolean | undefined;
44
+ /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
45
+ yawRange?: number | undefined;
46
+ /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
47
+ pitchRange?: number | undefined;
48
+ /** note: cameras can never look up/down further than Vec3::Y */
49
+ rollRange?: number | undefined;
50
+ /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
51
+ zoomMin?: number | undefined;
52
+ /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
53
+ zoomMax?: number | undefined;
25
54
  }
26
55
  /**
27
56
  * @public
@@ -30,3 +59,10 @@ export declare namespace PBCameraModeArea {
30
59
  function encode(message: PBCameraModeArea, writer?: _m0.Writer): _m0.Writer;
31
60
  function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraModeArea;
32
61
  }
62
+ /**
63
+ * @public
64
+ */
65
+ export declare namespace CinematicSettings {
66
+ function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
67
+ function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
68
+ }
@@ -3,7 +3,7 @@ import _m0 from "protobufjs/minimal";
3
3
  import { Vector3 } from "../../common/vectors.gen";
4
4
  const protobufPackageSarasa = "decentraland.sdk.components";
5
5
  function createBasePBCameraModeArea() {
6
- return { area: undefined, mode: 0 };
6
+ return { area: undefined, mode: 0, cinematicSettings: undefined, useColliderRange: undefined };
7
7
  }
8
8
  /**
9
9
  * @public
@@ -17,6 +17,12 @@ export var PBCameraModeArea;
17
17
  if (message.mode !== 0) {
18
18
  writer.uint32(16).int32(message.mode);
19
19
  }
20
+ if (message.cinematicSettings !== undefined) {
21
+ CinematicSettings.encode(message.cinematicSettings, writer.uint32(26).fork()).ldelim();
22
+ }
23
+ if (message.useColliderRange !== undefined) {
24
+ writer.uint32(32).bool(message.useColliderRange);
25
+ }
20
26
  return writer;
21
27
  }
22
28
  PBCameraModeArea.encode = encode;
@@ -39,6 +45,18 @@ export var PBCameraModeArea;
39
45
  }
40
46
  message.mode = reader.int32();
41
47
  continue;
48
+ case 3:
49
+ if (tag !== 26) {
50
+ break;
51
+ }
52
+ message.cinematicSettings = CinematicSettings.decode(reader, reader.uint32());
53
+ continue;
54
+ case 4:
55
+ if (tag !== 32) {
56
+ break;
57
+ }
58
+ message.useColliderRange = reader.bool();
59
+ continue;
42
60
  }
43
61
  if ((tag & 7) === 4 || tag === 0) {
44
62
  break;
@@ -49,3 +67,103 @@ export var PBCameraModeArea;
49
67
  }
50
68
  PBCameraModeArea.decode = decode;
51
69
  })(PBCameraModeArea || (PBCameraModeArea = {}));
70
+ function createBaseCinematicSettings() {
71
+ return {
72
+ cameraEntity: 0,
73
+ allowManualRotation: undefined,
74
+ yawRange: undefined,
75
+ pitchRange: undefined,
76
+ rollRange: undefined,
77
+ zoomMin: undefined,
78
+ zoomMax: undefined,
79
+ };
80
+ }
81
+ /**
82
+ * @public
83
+ */
84
+ export var CinematicSettings;
85
+ (function (CinematicSettings) {
86
+ function encode(message, writer = _m0.Writer.create()) {
87
+ if (message.cameraEntity !== 0) {
88
+ writer.uint32(8).uint32(message.cameraEntity);
89
+ }
90
+ if (message.allowManualRotation !== undefined) {
91
+ writer.uint32(16).bool(message.allowManualRotation);
92
+ }
93
+ if (message.yawRange !== undefined) {
94
+ writer.uint32(29).float(message.yawRange);
95
+ }
96
+ if (message.pitchRange !== undefined) {
97
+ writer.uint32(37).float(message.pitchRange);
98
+ }
99
+ if (message.rollRange !== undefined) {
100
+ writer.uint32(45).float(message.rollRange);
101
+ }
102
+ if (message.zoomMin !== undefined) {
103
+ writer.uint32(53).float(message.zoomMin);
104
+ }
105
+ if (message.zoomMax !== undefined) {
106
+ writer.uint32(61).float(message.zoomMax);
107
+ }
108
+ return writer;
109
+ }
110
+ CinematicSettings.encode = encode;
111
+ function decode(input, length) {
112
+ const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
113
+ let end = length === undefined ? reader.len : reader.pos + length;
114
+ const message = createBaseCinematicSettings();
115
+ while (reader.pos < end) {
116
+ const tag = reader.uint32();
117
+ switch (tag >>> 3) {
118
+ case 1:
119
+ if (tag !== 8) {
120
+ break;
121
+ }
122
+ message.cameraEntity = reader.uint32();
123
+ continue;
124
+ case 2:
125
+ if (tag !== 16) {
126
+ break;
127
+ }
128
+ message.allowManualRotation = reader.bool();
129
+ continue;
130
+ case 3:
131
+ if (tag !== 29) {
132
+ break;
133
+ }
134
+ message.yawRange = reader.float();
135
+ continue;
136
+ case 4:
137
+ if (tag !== 37) {
138
+ break;
139
+ }
140
+ message.pitchRange = reader.float();
141
+ continue;
142
+ case 5:
143
+ if (tag !== 45) {
144
+ break;
145
+ }
146
+ message.rollRange = reader.float();
147
+ continue;
148
+ case 6:
149
+ if (tag !== 53) {
150
+ break;
151
+ }
152
+ message.zoomMin = reader.float();
153
+ continue;
154
+ case 7:
155
+ if (tag !== 61) {
156
+ break;
157
+ }
158
+ message.zoomMax = reader.float();
159
+ continue;
160
+ }
161
+ if ((tag & 7) === 4 || tag === 0) {
162
+ break;
163
+ }
164
+ reader.skipType(tag & 7);
165
+ }
166
+ return message;
167
+ }
168
+ CinematicSettings.decode = decode;
169
+ })(CinematicSettings || (CinematicSettings = {}));
@@ -15,6 +15,10 @@ export interface PBUiText {
15
15
  font?: Font | undefined;
16
16
  /** size of the text (default: 10) */
17
17
  fontSize?: number | undefined;
18
+ /** width of the outline (default: 0) */
19
+ outlineWidth?: number | undefined;
20
+ /** RGBA color of the outline (default: opaque black) */
21
+ outlineColor?: Color4 | undefined;
18
22
  }
19
23
  /**
20
24
  * @public
@@ -3,7 +3,15 @@ import _m0 from "protobufjs/minimal";
3
3
  import { Color4 } from "../../common/colors.gen";
4
4
  const protobufPackageSarasa = "decentraland.sdk.components";
5
5
  function createBasePBUiText() {
6
- return { value: "", color: undefined, textAlign: undefined, font: undefined, fontSize: undefined };
6
+ return {
7
+ value: "",
8
+ color: undefined,
9
+ textAlign: undefined,
10
+ font: undefined,
11
+ fontSize: undefined,
12
+ outlineWidth: undefined,
13
+ outlineColor: undefined,
14
+ };
7
15
  }
8
16
  /**
9
17
  * @public
@@ -26,6 +34,12 @@ export var PBUiText;
26
34
  if (message.fontSize !== undefined) {
27
35
  writer.uint32(40).int32(message.fontSize);
28
36
  }
37
+ if (message.outlineWidth !== undefined) {
38
+ writer.uint32(53).float(message.outlineWidth);
39
+ }
40
+ if (message.outlineColor !== undefined) {
41
+ Color4.encode(message.outlineColor, writer.uint32(58).fork()).ldelim();
42
+ }
29
43
  return writer;
30
44
  }
31
45
  PBUiText.encode = encode;
@@ -66,6 +80,18 @@ export var PBUiText;
66
80
  }
67
81
  message.fontSize = reader.int32();
68
82
  continue;
83
+ case 6:
84
+ if (tag !== 53) {
85
+ break;
86
+ }
87
+ message.outlineWidth = reader.float();
88
+ continue;
89
+ case 7:
90
+ if (tag !== 58) {
91
+ break;
92
+ }
93
+ message.outlineColor = Color4.decode(reader, reader.uint32());
94
+ continue;
69
95
  }
70
96
  if ((tag & 7) === 4 || tag === 0) {
71
97
  break;
@@ -178,6 +178,8 @@ export interface PBUiTransform {
178
178
  paddingBottom: number;
179
179
  /** default: PointerFilterMode.PFM_NONE */
180
180
  pointerFilter?: PointerFilterMode | undefined;
181
+ /** default: 1 */
182
+ opacity?: number | undefined;
181
183
  }
182
184
  /**
183
185
  * @public
@@ -158,6 +158,7 @@ function createBasePBUiTransform() {
158
158
  paddingBottomUnit: 0,
159
159
  paddingBottom: 0,
160
160
  pointerFilter: undefined,
161
+ opacity: undefined,
161
162
  };
162
163
  }
163
164
  /**
@@ -322,6 +323,9 @@ export var PBUiTransform;
322
323
  if (message.pointerFilter !== undefined) {
323
324
  writer.uint32(416).int32(message.pointerFilter);
324
325
  }
326
+ if (message.opacity !== undefined) {
327
+ writer.uint32(429).float(message.opacity);
328
+ }
325
329
  return writer;
326
330
  }
327
331
  PBUiTransform.encode = encode;
@@ -644,6 +648,12 @@ export var PBUiTransform;
644
648
  }
645
649
  message.pointerFilter = reader.int32();
646
650
  continue;
651
+ case 53:
652
+ if (tag !== 429) {
653
+ break;
654
+ }
655
+ message.opacity = reader.float();
656
+ continue;
647
657
  }
648
658
  if ((tag & 7) === 4 || tag === 0) {
649
659
  break;
@@ -10,6 +10,17 @@ export declare const enum AvatarModifierType {
10
10
  /** AMT_DISABLE_PASSPORTS - selecting (e.g. clicking) an avatar will not bring up their profile. */
11
11
  AMT_DISABLE_PASSPORTS = 1
12
12
  }
13
+ /**
14
+ * @public
15
+ */
16
+ export declare const enum AvatarControlType {
17
+ /** CCT_NONE - avatar cannot move */
18
+ CCT_NONE = 0,
19
+ /** CCT_RELATIVE - avatar moves relative to the camera origin */
20
+ CCT_RELATIVE = 1,
21
+ /** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
22
+ CCT_TANK = 2
23
+ }
13
24
  /**
14
25
  * The AvatarModifierArea component can be attached to an Entity to define a region of space where
15
26
  * avatar behavior changes.
@@ -34,6 +45,31 @@ export interface PBAvatarModifierArea {
34
45
  excludeIds: string[];
35
46
  /** list of modifiers to apply */
36
47
  modifiers: AvatarModifierType[];
48
+ movementSettings?: AvatarMovementSettings | undefined;
49
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
50
+ useColliderRange?: boolean | undefined;
51
+ }
52
+ /**
53
+ * @public
54
+ */
55
+ export interface AvatarMovementSettings {
56
+ controlMode?: AvatarControlType | undefined;
57
+ /** if not explicitly set, the following properties default to user's preference settings */
58
+ runSpeed?: number | undefined;
59
+ /** how fast the player gets up to speed or comes to rest. higher = more responsive */
60
+ friction?: number | undefined;
61
+ /** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
62
+ gravity?: number | undefined;
63
+ /** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
64
+ jumpHeight?: number | undefined;
65
+ /** max fall speed in m/s. should normally be negative */
66
+ maxFallSpeed?: number | undefined;
67
+ /** speed the player turns in tank mode, in radians/s */
68
+ turnSpeed?: number | undefined;
69
+ /** speed the player walks at, in m/s */
70
+ walkSpeed?: number | undefined;
71
+ /** whether to allow player to move at a slower speed (e.g. with a walk-key or when using a gamepad/joystick). defaults to true */
72
+ allowWeightedMovement?: boolean | undefined;
37
73
  }
38
74
  /**
39
75
  * @public
@@ -42,3 +78,10 @@ export declare namespace PBAvatarModifierArea {
42
78
  function encode(message: PBAvatarModifierArea, writer?: _m0.Writer): _m0.Writer;
43
79
  function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
44
80
  }
81
+ /**
82
+ * @public
83
+ */
84
+ export declare namespace AvatarMovementSettings {
85
+ function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
86
+ function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
87
+ }
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.PBAvatarModifierArea = exports.AvatarModifierType = void 0;
6
+ exports.AvatarMovementSettings = exports.PBAvatarModifierArea = exports.AvatarControlType = exports.AvatarModifierType = void 0;
7
7
  /* eslint-disable */
8
8
  const minimal_1 = __importDefault(require("protobufjs/minimal"));
9
9
  const vectors_gen_1 = require("../../common/vectors.gen");
@@ -19,8 +19,20 @@ var AvatarModifierType;
19
19
  /** AMT_DISABLE_PASSPORTS - selecting (e.g. clicking) an avatar will not bring up their profile. */
20
20
  AvatarModifierType[AvatarModifierType["AMT_DISABLE_PASSPORTS"] = 1] = "AMT_DISABLE_PASSPORTS";
21
21
  })(AvatarModifierType = exports.AvatarModifierType || (exports.AvatarModifierType = {}));
22
+ /**
23
+ * @public
24
+ */
25
+ var AvatarControlType;
26
+ (function (AvatarControlType) {
27
+ /** CCT_NONE - avatar cannot move */
28
+ AvatarControlType[AvatarControlType["CCT_NONE"] = 0] = "CCT_NONE";
29
+ /** CCT_RELATIVE - avatar moves relative to the camera origin */
30
+ AvatarControlType[AvatarControlType["CCT_RELATIVE"] = 1] = "CCT_RELATIVE";
31
+ /** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
32
+ AvatarControlType[AvatarControlType["CCT_TANK"] = 2] = "CCT_TANK";
33
+ })(AvatarControlType = exports.AvatarControlType || (exports.AvatarControlType = {}));
22
34
  function createBasePBAvatarModifierArea() {
23
- return { area: undefined, excludeIds: [], modifiers: [] };
35
+ return { area: undefined, excludeIds: [], modifiers: [], movementSettings: undefined, useColliderRange: undefined };
24
36
  }
25
37
  /**
26
38
  * @public
@@ -39,6 +51,12 @@ var PBAvatarModifierArea;
39
51
  writer.int32(v);
40
52
  }
41
53
  writer.ldelim();
54
+ if (message.movementSettings !== undefined) {
55
+ AvatarMovementSettings.encode(message.movementSettings, writer.uint32(34).fork()).ldelim();
56
+ }
57
+ if (message.useColliderRange !== undefined) {
58
+ writer.uint32(40).bool(message.useColliderRange);
59
+ }
42
60
  return writer;
43
61
  }
44
62
  PBAvatarModifierArea.encode = encode;
@@ -74,6 +92,18 @@ var PBAvatarModifierArea;
74
92
  continue;
75
93
  }
76
94
  break;
95
+ case 4:
96
+ if (tag !== 34) {
97
+ break;
98
+ }
99
+ message.movementSettings = AvatarMovementSettings.decode(reader, reader.uint32());
100
+ continue;
101
+ case 5:
102
+ if (tag !== 40) {
103
+ break;
104
+ }
105
+ message.useColliderRange = reader.bool();
106
+ continue;
77
107
  }
78
108
  if ((tag & 7) === 4 || tag === 0) {
79
109
  break;
@@ -84,3 +114,123 @@ var PBAvatarModifierArea;
84
114
  }
85
115
  PBAvatarModifierArea.decode = decode;
86
116
  })(PBAvatarModifierArea = exports.PBAvatarModifierArea || (exports.PBAvatarModifierArea = {}));
117
+ function createBaseAvatarMovementSettings() {
118
+ return {
119
+ controlMode: undefined,
120
+ runSpeed: undefined,
121
+ friction: undefined,
122
+ gravity: undefined,
123
+ jumpHeight: undefined,
124
+ maxFallSpeed: undefined,
125
+ turnSpeed: undefined,
126
+ walkSpeed: undefined,
127
+ allowWeightedMovement: undefined,
128
+ };
129
+ }
130
+ /**
131
+ * @public
132
+ */
133
+ var AvatarMovementSettings;
134
+ (function (AvatarMovementSettings) {
135
+ function encode(message, writer = minimal_1.default.Writer.create()) {
136
+ if (message.controlMode !== undefined) {
137
+ writer.uint32(8).int32(message.controlMode);
138
+ }
139
+ if (message.runSpeed !== undefined) {
140
+ writer.uint32(21).float(message.runSpeed);
141
+ }
142
+ if (message.friction !== undefined) {
143
+ writer.uint32(29).float(message.friction);
144
+ }
145
+ if (message.gravity !== undefined) {
146
+ writer.uint32(37).float(message.gravity);
147
+ }
148
+ if (message.jumpHeight !== undefined) {
149
+ writer.uint32(45).float(message.jumpHeight);
150
+ }
151
+ if (message.maxFallSpeed !== undefined) {
152
+ writer.uint32(53).float(message.maxFallSpeed);
153
+ }
154
+ if (message.turnSpeed !== undefined) {
155
+ writer.uint32(61).float(message.turnSpeed);
156
+ }
157
+ if (message.walkSpeed !== undefined) {
158
+ writer.uint32(69).float(message.walkSpeed);
159
+ }
160
+ if (message.allowWeightedMovement !== undefined) {
161
+ writer.uint32(72).bool(message.allowWeightedMovement);
162
+ }
163
+ return writer;
164
+ }
165
+ AvatarMovementSettings.encode = encode;
166
+ function decode(input, length) {
167
+ const reader = input instanceof minimal_1.default.Reader ? input : minimal_1.default.Reader.create(input);
168
+ let end = length === undefined ? reader.len : reader.pos + length;
169
+ const message = createBaseAvatarMovementSettings();
170
+ while (reader.pos < end) {
171
+ const tag = reader.uint32();
172
+ switch (tag >>> 3) {
173
+ case 1:
174
+ if (tag !== 8) {
175
+ break;
176
+ }
177
+ message.controlMode = reader.int32();
178
+ continue;
179
+ case 2:
180
+ if (tag !== 21) {
181
+ break;
182
+ }
183
+ message.runSpeed = reader.float();
184
+ continue;
185
+ case 3:
186
+ if (tag !== 29) {
187
+ break;
188
+ }
189
+ message.friction = reader.float();
190
+ continue;
191
+ case 4:
192
+ if (tag !== 37) {
193
+ break;
194
+ }
195
+ message.gravity = reader.float();
196
+ continue;
197
+ case 5:
198
+ if (tag !== 45) {
199
+ break;
200
+ }
201
+ message.jumpHeight = reader.float();
202
+ continue;
203
+ case 6:
204
+ if (tag !== 53) {
205
+ break;
206
+ }
207
+ message.maxFallSpeed = reader.float();
208
+ continue;
209
+ case 7:
210
+ if (tag !== 61) {
211
+ break;
212
+ }
213
+ message.turnSpeed = reader.float();
214
+ continue;
215
+ case 8:
216
+ if (tag !== 69) {
217
+ break;
218
+ }
219
+ message.walkSpeed = reader.float();
220
+ continue;
221
+ case 9:
222
+ if (tag !== 72) {
223
+ break;
224
+ }
225
+ message.allowWeightedMovement = reader.bool();
226
+ continue;
227
+ }
228
+ if ((tag & 7) === 4 || tag === 0) {
229
+ break;
230
+ }
231
+ reader.skipType(tag & 7);
232
+ }
233
+ return message;
234
+ }
235
+ AvatarMovementSettings.decode = decode;
236
+ })(AvatarMovementSettings = exports.AvatarMovementSettings || (exports.AvatarMovementSettings = {}));
@@ -3,7 +3,7 @@ import { Vector3 } from "../../common/vectors.gen";
3
3
  import { CameraType } from "./common/camera_type.gen";
4
4
  /**
5
5
  * The CameraModeArea component can be attached to an Entity to define a region of space where
6
- * the player's camera mode (1st-person or 3rd-person) is overridden.
6
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
7
7
  *
8
8
  * The Entity's Transform position determines the center-point of the region, while its size is
9
9
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -13,6 +13,8 @@ import { CameraType } from "./common/camera_type.gen";
13
13
  *
14
14
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
15
15
  * is actually a 3D volume.
16
+ *
17
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
16
18
  */
17
19
  /**
18
20
  * @public
@@ -22,6 +24,33 @@ export interface PBCameraModeArea {
22
24
  area: Vector3 | undefined;
23
25
  /** the camera mode to enforce */
24
26
  mode: CameraType;
27
+ cinematicSettings?: CinematicSettings | undefined;
28
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
29
+ useColliderRange?: boolean | undefined;
30
+ }
31
+ /**
32
+ * @public
33
+ */
34
+ export interface CinematicSettings {
35
+ /** Entity that defines the cinematic camera transform. */
36
+ cameraEntity: number;
37
+ /**
38
+ * Position -> camera's position
39
+ * Rotation -> camera's direction
40
+ * scale.z -> zoom level
41
+ * scale.x and scale.y -> unused
42
+ */
43
+ allowManualRotation?: boolean | undefined;
44
+ /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
45
+ yawRange?: number | undefined;
46
+ /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
47
+ pitchRange?: number | undefined;
48
+ /** note: cameras can never look up/down further than Vec3::Y */
49
+ rollRange?: number | undefined;
50
+ /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
51
+ zoomMin?: number | undefined;
52
+ /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
53
+ zoomMax?: number | undefined;
25
54
  }
26
55
  /**
27
56
  * @public
@@ -30,3 +59,10 @@ export declare namespace PBCameraModeArea {
30
59
  function encode(message: PBCameraModeArea, writer?: _m0.Writer): _m0.Writer;
31
60
  function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraModeArea;
32
61
  }
62
+ /**
63
+ * @public
64
+ */
65
+ export declare namespace CinematicSettings {
66
+ function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
67
+ function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
68
+ }
@@ -3,13 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.PBCameraModeArea = void 0;
6
+ exports.CinematicSettings = exports.PBCameraModeArea = void 0;
7
7
  /* eslint-disable */
8
8
  const minimal_1 = __importDefault(require("protobufjs/minimal"));
9
9
  const vectors_gen_1 = require("../../common/vectors.gen");
10
10
  const protobufPackageSarasa = "decentraland.sdk.components";
11
11
  function createBasePBCameraModeArea() {
12
- return { area: undefined, mode: 0 };
12
+ return { area: undefined, mode: 0, cinematicSettings: undefined, useColliderRange: undefined };
13
13
  }
14
14
  /**
15
15
  * @public
@@ -23,6 +23,12 @@ var PBCameraModeArea;
23
23
  if (message.mode !== 0) {
24
24
  writer.uint32(16).int32(message.mode);
25
25
  }
26
+ if (message.cinematicSettings !== undefined) {
27
+ CinematicSettings.encode(message.cinematicSettings, writer.uint32(26).fork()).ldelim();
28
+ }
29
+ if (message.useColliderRange !== undefined) {
30
+ writer.uint32(32).bool(message.useColliderRange);
31
+ }
26
32
  return writer;
27
33
  }
28
34
  PBCameraModeArea.encode = encode;
@@ -45,6 +51,18 @@ var PBCameraModeArea;
45
51
  }
46
52
  message.mode = reader.int32();
47
53
  continue;
54
+ case 3:
55
+ if (tag !== 26) {
56
+ break;
57
+ }
58
+ message.cinematicSettings = CinematicSettings.decode(reader, reader.uint32());
59
+ continue;
60
+ case 4:
61
+ if (tag !== 32) {
62
+ break;
63
+ }
64
+ message.useColliderRange = reader.bool();
65
+ continue;
48
66
  }
49
67
  if ((tag & 7) === 4 || tag === 0) {
50
68
  break;
@@ -55,3 +73,103 @@ var PBCameraModeArea;
55
73
  }
56
74
  PBCameraModeArea.decode = decode;
57
75
  })(PBCameraModeArea = exports.PBCameraModeArea || (exports.PBCameraModeArea = {}));
76
+ function createBaseCinematicSettings() {
77
+ return {
78
+ cameraEntity: 0,
79
+ allowManualRotation: undefined,
80
+ yawRange: undefined,
81
+ pitchRange: undefined,
82
+ rollRange: undefined,
83
+ zoomMin: undefined,
84
+ zoomMax: undefined,
85
+ };
86
+ }
87
+ /**
88
+ * @public
89
+ */
90
+ var CinematicSettings;
91
+ (function (CinematicSettings) {
92
+ function encode(message, writer = minimal_1.default.Writer.create()) {
93
+ if (message.cameraEntity !== 0) {
94
+ writer.uint32(8).uint32(message.cameraEntity);
95
+ }
96
+ if (message.allowManualRotation !== undefined) {
97
+ writer.uint32(16).bool(message.allowManualRotation);
98
+ }
99
+ if (message.yawRange !== undefined) {
100
+ writer.uint32(29).float(message.yawRange);
101
+ }
102
+ if (message.pitchRange !== undefined) {
103
+ writer.uint32(37).float(message.pitchRange);
104
+ }
105
+ if (message.rollRange !== undefined) {
106
+ writer.uint32(45).float(message.rollRange);
107
+ }
108
+ if (message.zoomMin !== undefined) {
109
+ writer.uint32(53).float(message.zoomMin);
110
+ }
111
+ if (message.zoomMax !== undefined) {
112
+ writer.uint32(61).float(message.zoomMax);
113
+ }
114
+ return writer;
115
+ }
116
+ CinematicSettings.encode = encode;
117
+ function decode(input, length) {
118
+ const reader = input instanceof minimal_1.default.Reader ? input : minimal_1.default.Reader.create(input);
119
+ let end = length === undefined ? reader.len : reader.pos + length;
120
+ const message = createBaseCinematicSettings();
121
+ while (reader.pos < end) {
122
+ const tag = reader.uint32();
123
+ switch (tag >>> 3) {
124
+ case 1:
125
+ if (tag !== 8) {
126
+ break;
127
+ }
128
+ message.cameraEntity = reader.uint32();
129
+ continue;
130
+ case 2:
131
+ if (tag !== 16) {
132
+ break;
133
+ }
134
+ message.allowManualRotation = reader.bool();
135
+ continue;
136
+ case 3:
137
+ if (tag !== 29) {
138
+ break;
139
+ }
140
+ message.yawRange = reader.float();
141
+ continue;
142
+ case 4:
143
+ if (tag !== 37) {
144
+ break;
145
+ }
146
+ message.pitchRange = reader.float();
147
+ continue;
148
+ case 5:
149
+ if (tag !== 45) {
150
+ break;
151
+ }
152
+ message.rollRange = reader.float();
153
+ continue;
154
+ case 6:
155
+ if (tag !== 53) {
156
+ break;
157
+ }
158
+ message.zoomMin = reader.float();
159
+ continue;
160
+ case 7:
161
+ if (tag !== 61) {
162
+ break;
163
+ }
164
+ message.zoomMax = reader.float();
165
+ continue;
166
+ }
167
+ if ((tag & 7) === 4 || tag === 0) {
168
+ break;
169
+ }
170
+ reader.skipType(tag & 7);
171
+ }
172
+ return message;
173
+ }
174
+ CinematicSettings.decode = decode;
175
+ })(CinematicSettings = exports.CinematicSettings || (exports.CinematicSettings = {}));
@@ -15,6 +15,10 @@ export interface PBUiText {
15
15
  font?: Font | undefined;
16
16
  /** size of the text (default: 10) */
17
17
  fontSize?: number | undefined;
18
+ /** width of the outline (default: 0) */
19
+ outlineWidth?: number | undefined;
20
+ /** RGBA color of the outline (default: opaque black) */
21
+ outlineColor?: Color4 | undefined;
18
22
  }
19
23
  /**
20
24
  * @public
@@ -9,7 +9,15 @@ const minimal_1 = __importDefault(require("protobufjs/minimal"));
9
9
  const colors_gen_1 = require("../../common/colors.gen");
10
10
  const protobufPackageSarasa = "decentraland.sdk.components";
11
11
  function createBasePBUiText() {
12
- return { value: "", color: undefined, textAlign: undefined, font: undefined, fontSize: undefined };
12
+ return {
13
+ value: "",
14
+ color: undefined,
15
+ textAlign: undefined,
16
+ font: undefined,
17
+ fontSize: undefined,
18
+ outlineWidth: undefined,
19
+ outlineColor: undefined,
20
+ };
13
21
  }
14
22
  /**
15
23
  * @public
@@ -32,6 +40,12 @@ var PBUiText;
32
40
  if (message.fontSize !== undefined) {
33
41
  writer.uint32(40).int32(message.fontSize);
34
42
  }
43
+ if (message.outlineWidth !== undefined) {
44
+ writer.uint32(53).float(message.outlineWidth);
45
+ }
46
+ if (message.outlineColor !== undefined) {
47
+ colors_gen_1.Color4.encode(message.outlineColor, writer.uint32(58).fork()).ldelim();
48
+ }
35
49
  return writer;
36
50
  }
37
51
  PBUiText.encode = encode;
@@ -72,6 +86,18 @@ var PBUiText;
72
86
  }
73
87
  message.fontSize = reader.int32();
74
88
  continue;
89
+ case 6:
90
+ if (tag !== 53) {
91
+ break;
92
+ }
93
+ message.outlineWidth = reader.float();
94
+ continue;
95
+ case 7:
96
+ if (tag !== 58) {
97
+ break;
98
+ }
99
+ message.outlineColor = colors_gen_1.Color4.decode(reader, reader.uint32());
100
+ continue;
75
101
  }
76
102
  if ((tag & 7) === 4 || tag === 0) {
77
103
  break;
@@ -178,6 +178,8 @@ export interface PBUiTransform {
178
178
  paddingBottom: number;
179
179
  /** default: PointerFilterMode.PFM_NONE */
180
180
  pointerFilter?: PointerFilterMode | undefined;
181
+ /** default: 1 */
182
+ opacity?: number | undefined;
181
183
  }
182
184
  /**
183
185
  * @public
@@ -164,6 +164,7 @@ function createBasePBUiTransform() {
164
164
  paddingBottomUnit: 0,
165
165
  paddingBottom: 0,
166
166
  pointerFilter: undefined,
167
+ opacity: undefined,
167
168
  };
168
169
  }
169
170
  /**
@@ -328,6 +329,9 @@ var PBUiTransform;
328
329
  if (message.pointerFilter !== undefined) {
329
330
  writer.uint32(416).int32(message.pointerFilter);
330
331
  }
332
+ if (message.opacity !== undefined) {
333
+ writer.uint32(429).float(message.opacity);
334
+ }
331
335
  return writer;
332
336
  }
333
337
  PBUiTransform.encode = encode;
@@ -650,6 +654,12 @@ var PBUiTransform;
650
654
  }
651
655
  message.pointerFilter = reader.int32();
652
656
  continue;
657
+ case 53:
658
+ if (tag !== 429) {
659
+ break;
660
+ }
661
+ message.opacity = reader.float();
662
+ continue;
653
663
  }
654
664
  if ((tag & 7) === 4 || tag === 0) {
655
665
  break;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@dcl/ecs",
3
3
  "description": "Decentraland ECS",
4
- "version": "7.5.0",
4
+ "version": "7.5.1-9235895775.commit-075ab65",
5
5
  "author": "DCL",
6
6
  "bugs": "https://github.com/decentraland/ecs/issues",
7
7
  "files": [
@@ -33,5 +33,5 @@
33
33
  },
34
34
  "types": "./dist/index.d.ts",
35
35
  "typings": "./dist/index.d.ts",
36
- "commit": "6572a8d70e02d530a6b78fd38574e0a315f007f3"
36
+ "commit": "075ab65a8da74643a2d70ea916d4c0d9feb8b89b"
37
37
  }