@dcl/playground-assets 7.25.1-30365680769.commit-9c1b99d → 7.25.1-30447792919.commit-c06a494
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/alpha.d.ts +123 -2
- package/dist/beta.d.ts +123 -2
- package/dist/index.bundled.d.ts +123 -2
- package/dist/index.js +6 -6
- package/dist/playground/sdk/apis.d.ts +37 -0
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +123 -2
- package/etc/playground-assets.api.json +1165 -207
- package/etc/playground-assets.api.md +62 -0
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -263,6 +263,15 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
263
263
|
/** @public */
|
|
264
264
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
265
265
|
|
|
266
|
+
/** Mask for which bones an animation applies to. */
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export declare const enum AvatarEmoteMask {
|
|
271
|
+
AEM_FULL_BODY = 0,
|
|
272
|
+
AEM_UPPER_BODY = 1
|
|
273
|
+
}
|
|
274
|
+
|
|
266
275
|
/** @public */
|
|
267
276
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
268
277
|
|
|
@@ -1447,6 +1456,7 @@ export declare const componentDefinitionByName: {
|
|
|
1447
1456
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1448
1457
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1449
1458
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1459
|
+
"core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
|
|
1450
1460
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1451
1461
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
1452
1462
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
|
@@ -1457,6 +1467,7 @@ export declare const componentDefinitionByName: {
|
|
|
1457
1467
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1458
1468
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1459
1469
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1470
|
+
"core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
|
|
1460
1471
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1461
1472
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1462
1473
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
@@ -4821,8 +4832,9 @@ export declare namespace PBAvatarBase {
|
|
|
4821
4832
|
}
|
|
4822
4833
|
|
|
4823
4834
|
/**
|
|
4824
|
-
* AvatarEmoteCommand is a grow only value set,
|
|
4825
|
-
* avatar
|
|
4835
|
+
* AvatarEmoteCommand is a grow only value set, written by the explorer to report
|
|
4836
|
+
* avatar emote playback to the scene. It is appended to every player entity in the
|
|
4837
|
+
* scene (the local player and remote avatars alike).
|
|
4826
4838
|
*/
|
|
4827
4839
|
/**
|
|
4828
4840
|
* @public
|
|
@@ -6433,6 +6445,70 @@ export declare namespace PBTextShape {
|
|
|
6433
6445
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
6434
6446
|
}
|
|
6435
6447
|
|
|
6448
|
+
/**
|
|
6449
|
+
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
6450
|
+
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
6451
|
+
*
|
|
6452
|
+
* By default every on-screen button is shown; list a button in `touch_inputs` with
|
|
6453
|
+
* `hide = true` to remove it (declutter). `main_action` picks which action the large
|
|
6454
|
+
* central button triggers, and `hide_joystick` removes the native virtual joystick. It is
|
|
6455
|
+
* a no-op on platforms without native on-screen controls (e.g. desktop).
|
|
6456
|
+
*
|
|
6457
|
+
* Accepted actions: only the on-screen gamepad actions map to a button — `IA_POINTER`,
|
|
6458
|
+
* `IA_PRIMARY`, `IA_SECONDARY`, `IA_JUMP`, and `IA_ACTION_3`..`IA_ACTION_6`. Any other
|
|
6459
|
+
* `InputAction` (movement actions, `IA_ANY`, `IA_MODIFIER`, or unknown/future values) is
|
|
6460
|
+
* ignored: a `TouchInput` entry naming a non-button action has no effect, and a `main_action`
|
|
6461
|
+
* that isn't a valid gamepad action falls back to the default central button (`IA_JUMP`).
|
|
6462
|
+
*/
|
|
6463
|
+
/**
|
|
6464
|
+
* @public
|
|
6465
|
+
*/
|
|
6466
|
+
export declare interface PBTouchScreenControls {
|
|
6467
|
+
touchInputs: PBTouchScreenControls_TouchInput[];
|
|
6468
|
+
/**
|
|
6469
|
+
* The large central button's action. Only the gamepad actions are valid:
|
|
6470
|
+
* jump / pointer / primary (E) / secondary (F) / action_3..action_6 (1/2/3/4).
|
|
6471
|
+
* When unset, the default central button (jump) is kept.
|
|
6472
|
+
*/
|
|
6473
|
+
mainAction?: InputAction | undefined;
|
|
6474
|
+
/** hide the native virtual joystick */
|
|
6475
|
+
hideJoystick: boolean;
|
|
6476
|
+
/** hide the on-screen crosshair / reticle */
|
|
6477
|
+
hideCrosshair: boolean;
|
|
6478
|
+
}
|
|
6479
|
+
|
|
6480
|
+
/**
|
|
6481
|
+
* @public
|
|
6482
|
+
*/
|
|
6483
|
+
export declare namespace PBTouchScreenControls {
|
|
6484
|
+
export function encode(message: PBTouchScreenControls, writer?: _m0.Writer): _m0.Writer;
|
|
6485
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls;
|
|
6486
|
+
}
|
|
6487
|
+
|
|
6488
|
+
/** Per-button configuration. A button not listed here keeps its default (shown). */
|
|
6489
|
+
/**
|
|
6490
|
+
* @public
|
|
6491
|
+
*/
|
|
6492
|
+
export declare interface PBTouchScreenControls_TouchInput {
|
|
6493
|
+
/** which on-screen button this configures */
|
|
6494
|
+
inputAction: InputAction;
|
|
6495
|
+
/** hide this button (default: shown) */
|
|
6496
|
+
hide: boolean;
|
|
6497
|
+
/**
|
|
6498
|
+
* Override the button glyph with this texture. For the jump button it replaces all
|
|
6499
|
+
* of its dynamic states (jump / double-jump / glide).
|
|
6500
|
+
*/
|
|
6501
|
+
icon?: TextureUnion | undefined;
|
|
6502
|
+
}
|
|
6503
|
+
|
|
6504
|
+
/**
|
|
6505
|
+
* @public
|
|
6506
|
+
*/
|
|
6507
|
+
export declare namespace PBTouchScreenControls_TouchInput {
|
|
6508
|
+
export function encode(message: PBTouchScreenControls_TouchInput, writer?: _m0.Writer): _m0.Writer;
|
|
6509
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls_TouchInput;
|
|
6510
|
+
}
|
|
6511
|
+
|
|
6436
6512
|
/**
|
|
6437
6513
|
* The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
|
|
6438
6514
|
* when entities enter this component's defined area.
|
|
@@ -6721,6 +6797,42 @@ export declare namespace PBUiInput {
|
|
|
6721
6797
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInput;
|
|
6722
6798
|
}
|
|
6723
6799
|
|
|
6800
|
+
/**
|
|
6801
|
+
* The UiInputBinding component binds a UI entity to one or more InputActions. While the
|
|
6802
|
+
* element is pressed (touch or pointer) the listed actions are held down, driving both
|
|
6803
|
+
* the local player input and scene InputAction listeners, just like the native on-screen
|
|
6804
|
+
* buttons. It is typically combined with PBTouchScreenControls to replace the native
|
|
6805
|
+
* controls with a custom touch UI.
|
|
6806
|
+
*
|
|
6807
|
+
* Release semantics: the held actions are released as soon as the press that started them
|
|
6808
|
+
* ends. A renderer MUST release all actions held by this binding when any of the following
|
|
6809
|
+
* happens: the press/touch is lifted or cancelled, the pointer/touch leaves the element
|
|
6810
|
+
* (loses press ownership), the actions list changes (the previous set is released before
|
|
6811
|
+
* the new set is applied), the component is removed or its actions list becomes empty, the
|
|
6812
|
+
* UI element is hidden, disabled or removed from the tree, or the scene unloads. In short,
|
|
6813
|
+
* no action may remain held once the element is no longer both present and actively pressed.
|
|
6814
|
+
*
|
|
6815
|
+
* Multi-touch: the binding is a single held state, not reference-counted per pointer. The
|
|
6816
|
+
* actions are held while the element is pressed and released when that press ends; a second
|
|
6817
|
+
* simultaneous press on the same element does not stack, and does not extend the hold past
|
|
6818
|
+
* the first release.
|
|
6819
|
+
*/
|
|
6820
|
+
/**
|
|
6821
|
+
* @public
|
|
6822
|
+
*/
|
|
6823
|
+
export declare interface PBUiInputBinding {
|
|
6824
|
+
/** the input actions fired while this element is pressed */
|
|
6825
|
+
actions: InputAction[];
|
|
6826
|
+
}
|
|
6827
|
+
|
|
6828
|
+
/**
|
|
6829
|
+
* @public
|
|
6830
|
+
*/
|
|
6831
|
+
export declare namespace PBUiInputBinding {
|
|
6832
|
+
export function encode(message: PBUiInputBinding, writer?: _m0.Writer): _m0.Writer;
|
|
6833
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputBinding;
|
|
6834
|
+
}
|
|
6835
|
+
|
|
6724
6836
|
/**
|
|
6725
6837
|
* @public
|
|
6726
6838
|
*/
|
|
@@ -6989,6 +7101,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6989
7101
|
* an 'instant' transition (like using speed/time = 0)
|
|
6990
7102
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6991
7103
|
* the holding entity transform).
|
|
7104
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6992
7105
|
*/
|
|
6993
7106
|
/**
|
|
6994
7107
|
* @public
|
|
@@ -6996,6 +7109,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6996
7109
|
export declare interface PBVirtualCamera {
|
|
6997
7110
|
defaultTransition?: CameraTransition | undefined;
|
|
6998
7111
|
lookAtEntity?: number | undefined;
|
|
7112
|
+
/** default: 60 */
|
|
7113
|
+
fov?: number | undefined;
|
|
6999
7114
|
}
|
|
7000
7115
|
|
|
7001
7116
|
/**
|
|
@@ -9021,6 +9136,9 @@ export declare const ToLinearSpace = 2.2;
|
|
|
9021
9136
|
*/
|
|
9022
9137
|
export declare type ToOptional<T> = OnlyOptionalUndefinedTypes<T> & OnlyNonUndefinedTypes<T>;
|
|
9023
9138
|
|
|
9139
|
+
/** @public */
|
|
9140
|
+
export declare const TouchScreenControls: LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>;
|
|
9141
|
+
|
|
9024
9142
|
export declare const Transform: TransformComponentExtended;
|
|
9025
9143
|
|
|
9026
9144
|
/**
|
|
@@ -9467,6 +9585,9 @@ export declare type UiFontType = 'sans-serif' | 'serif' | 'monospace';
|
|
|
9467
9585
|
/** @public */
|
|
9468
9586
|
export declare const UiInput: LastWriteWinElementSetComponentDefinition<PBUiInput>;
|
|
9469
9587
|
|
|
9588
|
+
/** @public */
|
|
9589
|
+
export declare const UiInputBinding: LastWriteWinElementSetComponentDefinition<PBUiInputBinding>;
|
|
9590
|
+
|
|
9470
9591
|
/**
|
|
9471
9592
|
* @public
|
|
9472
9593
|
*/
|
package/dist/beta.d.ts
CHANGED
|
@@ -263,6 +263,15 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
263
263
|
/** @public */
|
|
264
264
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
265
265
|
|
|
266
|
+
/** Mask for which bones an animation applies to. */
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export declare const enum AvatarEmoteMask {
|
|
271
|
+
AEM_FULL_BODY = 0,
|
|
272
|
+
AEM_UPPER_BODY = 1
|
|
273
|
+
}
|
|
274
|
+
|
|
266
275
|
/** @public */
|
|
267
276
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
268
277
|
|
|
@@ -1447,6 +1456,7 @@ export declare const componentDefinitionByName: {
|
|
|
1447
1456
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1448
1457
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1449
1458
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1459
|
+
"core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
|
|
1450
1460
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1451
1461
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
1452
1462
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
|
@@ -1457,6 +1467,7 @@ export declare const componentDefinitionByName: {
|
|
|
1457
1467
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1458
1468
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1459
1469
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1470
|
+
"core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
|
|
1460
1471
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1461
1472
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1462
1473
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
@@ -4793,8 +4804,9 @@ export declare namespace PBAvatarBase {
|
|
|
4793
4804
|
}
|
|
4794
4805
|
|
|
4795
4806
|
/**
|
|
4796
|
-
* AvatarEmoteCommand is a grow only value set,
|
|
4797
|
-
* avatar
|
|
4807
|
+
* AvatarEmoteCommand is a grow only value set, written by the explorer to report
|
|
4808
|
+
* avatar emote playback to the scene. It is appended to every player entity in the
|
|
4809
|
+
* scene (the local player and remote avatars alike).
|
|
4798
4810
|
*/
|
|
4799
4811
|
/**
|
|
4800
4812
|
* @public
|
|
@@ -6405,6 +6417,70 @@ export declare namespace PBTextShape {
|
|
|
6405
6417
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
6406
6418
|
}
|
|
6407
6419
|
|
|
6420
|
+
/**
|
|
6421
|
+
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
6422
|
+
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
6423
|
+
*
|
|
6424
|
+
* By default every on-screen button is shown; list a button in `touch_inputs` with
|
|
6425
|
+
* `hide = true` to remove it (declutter). `main_action` picks which action the large
|
|
6426
|
+
* central button triggers, and `hide_joystick` removes the native virtual joystick. It is
|
|
6427
|
+
* a no-op on platforms without native on-screen controls (e.g. desktop).
|
|
6428
|
+
*
|
|
6429
|
+
* Accepted actions: only the on-screen gamepad actions map to a button — `IA_POINTER`,
|
|
6430
|
+
* `IA_PRIMARY`, `IA_SECONDARY`, `IA_JUMP`, and `IA_ACTION_3`..`IA_ACTION_6`. Any other
|
|
6431
|
+
* `InputAction` (movement actions, `IA_ANY`, `IA_MODIFIER`, or unknown/future values) is
|
|
6432
|
+
* ignored: a `TouchInput` entry naming a non-button action has no effect, and a `main_action`
|
|
6433
|
+
* that isn't a valid gamepad action falls back to the default central button (`IA_JUMP`).
|
|
6434
|
+
*/
|
|
6435
|
+
/**
|
|
6436
|
+
* @public
|
|
6437
|
+
*/
|
|
6438
|
+
export declare interface PBTouchScreenControls {
|
|
6439
|
+
touchInputs: PBTouchScreenControls_TouchInput[];
|
|
6440
|
+
/**
|
|
6441
|
+
* The large central button's action. Only the gamepad actions are valid:
|
|
6442
|
+
* jump / pointer / primary (E) / secondary (F) / action_3..action_6 (1/2/3/4).
|
|
6443
|
+
* When unset, the default central button (jump) is kept.
|
|
6444
|
+
*/
|
|
6445
|
+
mainAction?: InputAction | undefined;
|
|
6446
|
+
/** hide the native virtual joystick */
|
|
6447
|
+
hideJoystick: boolean;
|
|
6448
|
+
/** hide the on-screen crosshair / reticle */
|
|
6449
|
+
hideCrosshair: boolean;
|
|
6450
|
+
}
|
|
6451
|
+
|
|
6452
|
+
/**
|
|
6453
|
+
* @public
|
|
6454
|
+
*/
|
|
6455
|
+
export declare namespace PBTouchScreenControls {
|
|
6456
|
+
export function encode(message: PBTouchScreenControls, writer?: _m0.Writer): _m0.Writer;
|
|
6457
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls;
|
|
6458
|
+
}
|
|
6459
|
+
|
|
6460
|
+
/** Per-button configuration. A button not listed here keeps its default (shown). */
|
|
6461
|
+
/**
|
|
6462
|
+
* @public
|
|
6463
|
+
*/
|
|
6464
|
+
export declare interface PBTouchScreenControls_TouchInput {
|
|
6465
|
+
/** which on-screen button this configures */
|
|
6466
|
+
inputAction: InputAction;
|
|
6467
|
+
/** hide this button (default: shown) */
|
|
6468
|
+
hide: boolean;
|
|
6469
|
+
/**
|
|
6470
|
+
* Override the button glyph with this texture. For the jump button it replaces all
|
|
6471
|
+
* of its dynamic states (jump / double-jump / glide).
|
|
6472
|
+
*/
|
|
6473
|
+
icon?: TextureUnion | undefined;
|
|
6474
|
+
}
|
|
6475
|
+
|
|
6476
|
+
/**
|
|
6477
|
+
* @public
|
|
6478
|
+
*/
|
|
6479
|
+
export declare namespace PBTouchScreenControls_TouchInput {
|
|
6480
|
+
export function encode(message: PBTouchScreenControls_TouchInput, writer?: _m0.Writer): _m0.Writer;
|
|
6481
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls_TouchInput;
|
|
6482
|
+
}
|
|
6483
|
+
|
|
6408
6484
|
/**
|
|
6409
6485
|
* The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
|
|
6410
6486
|
* when entities enter this component's defined area.
|
|
@@ -6693,6 +6769,42 @@ export declare namespace PBUiInput {
|
|
|
6693
6769
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInput;
|
|
6694
6770
|
}
|
|
6695
6771
|
|
|
6772
|
+
/**
|
|
6773
|
+
* The UiInputBinding component binds a UI entity to one or more InputActions. While the
|
|
6774
|
+
* element is pressed (touch or pointer) the listed actions are held down, driving both
|
|
6775
|
+
* the local player input and scene InputAction listeners, just like the native on-screen
|
|
6776
|
+
* buttons. It is typically combined with PBTouchScreenControls to replace the native
|
|
6777
|
+
* controls with a custom touch UI.
|
|
6778
|
+
*
|
|
6779
|
+
* Release semantics: the held actions are released as soon as the press that started them
|
|
6780
|
+
* ends. A renderer MUST release all actions held by this binding when any of the following
|
|
6781
|
+
* happens: the press/touch is lifted or cancelled, the pointer/touch leaves the element
|
|
6782
|
+
* (loses press ownership), the actions list changes (the previous set is released before
|
|
6783
|
+
* the new set is applied), the component is removed or its actions list becomes empty, the
|
|
6784
|
+
* UI element is hidden, disabled or removed from the tree, or the scene unloads. In short,
|
|
6785
|
+
* no action may remain held once the element is no longer both present and actively pressed.
|
|
6786
|
+
*
|
|
6787
|
+
* Multi-touch: the binding is a single held state, not reference-counted per pointer. The
|
|
6788
|
+
* actions are held while the element is pressed and released when that press ends; a second
|
|
6789
|
+
* simultaneous press on the same element does not stack, and does not extend the hold past
|
|
6790
|
+
* the first release.
|
|
6791
|
+
*/
|
|
6792
|
+
/**
|
|
6793
|
+
* @public
|
|
6794
|
+
*/
|
|
6795
|
+
export declare interface PBUiInputBinding {
|
|
6796
|
+
/** the input actions fired while this element is pressed */
|
|
6797
|
+
actions: InputAction[];
|
|
6798
|
+
}
|
|
6799
|
+
|
|
6800
|
+
/**
|
|
6801
|
+
* @public
|
|
6802
|
+
*/
|
|
6803
|
+
export declare namespace PBUiInputBinding {
|
|
6804
|
+
export function encode(message: PBUiInputBinding, writer?: _m0.Writer): _m0.Writer;
|
|
6805
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputBinding;
|
|
6806
|
+
}
|
|
6807
|
+
|
|
6696
6808
|
/**
|
|
6697
6809
|
* @public
|
|
6698
6810
|
*/
|
|
@@ -6961,6 +7073,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6961
7073
|
* an 'instant' transition (like using speed/time = 0)
|
|
6962
7074
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6963
7075
|
* the holding entity transform).
|
|
7076
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6964
7077
|
*/
|
|
6965
7078
|
/**
|
|
6966
7079
|
* @public
|
|
@@ -6968,6 +7081,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6968
7081
|
export declare interface PBVirtualCamera {
|
|
6969
7082
|
defaultTransition?: CameraTransition | undefined;
|
|
6970
7083
|
lookAtEntity?: number | undefined;
|
|
7084
|
+
/** default: 60 */
|
|
7085
|
+
fov?: number | undefined;
|
|
6971
7086
|
}
|
|
6972
7087
|
|
|
6973
7088
|
/**
|
|
@@ -8988,6 +9103,9 @@ export declare const ToLinearSpace = 2.2;
|
|
|
8988
9103
|
*/
|
|
8989
9104
|
export declare type ToOptional<T> = OnlyOptionalUndefinedTypes<T> & OnlyNonUndefinedTypes<T>;
|
|
8990
9105
|
|
|
9106
|
+
/** @public */
|
|
9107
|
+
export declare const TouchScreenControls: LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>;
|
|
9108
|
+
|
|
8991
9109
|
export declare const Transform: TransformComponentExtended;
|
|
8992
9110
|
|
|
8993
9111
|
/**
|
|
@@ -9434,6 +9552,9 @@ export declare type UiFontType = 'sans-serif' | 'serif' | 'monospace';
|
|
|
9434
9552
|
/** @public */
|
|
9435
9553
|
export declare const UiInput: LastWriteWinElementSetComponentDefinition<PBUiInput>;
|
|
9436
9554
|
|
|
9555
|
+
/** @public */
|
|
9556
|
+
export declare const UiInputBinding: LastWriteWinElementSetComponentDefinition<PBUiInputBinding>;
|
|
9557
|
+
|
|
9437
9558
|
/**
|
|
9438
9559
|
* @public
|
|
9439
9560
|
*/
|
package/dist/index.bundled.d.ts
CHANGED
|
@@ -263,6 +263,15 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
263
263
|
/** @public */
|
|
264
264
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
265
265
|
|
|
266
|
+
/** Mask for which bones an animation applies to. */
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export declare const enum AvatarEmoteMask {
|
|
271
|
+
AEM_FULL_BODY = 0,
|
|
272
|
+
AEM_UPPER_BODY = 1
|
|
273
|
+
}
|
|
274
|
+
|
|
266
275
|
/** @public */
|
|
267
276
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
268
277
|
|
|
@@ -1447,6 +1456,7 @@ export declare const componentDefinitionByName: {
|
|
|
1447
1456
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1448
1457
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1449
1458
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1459
|
+
"core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
|
|
1450
1460
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1451
1461
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
1452
1462
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
|
@@ -1457,6 +1467,7 @@ export declare const componentDefinitionByName: {
|
|
|
1457
1467
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1458
1468
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1459
1469
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1470
|
+
"core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
|
|
1460
1471
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1461
1472
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1462
1473
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
@@ -4793,8 +4804,9 @@ export declare namespace PBAvatarBase {
|
|
|
4793
4804
|
}
|
|
4794
4805
|
|
|
4795
4806
|
/**
|
|
4796
|
-
* AvatarEmoteCommand is a grow only value set,
|
|
4797
|
-
* avatar
|
|
4807
|
+
* AvatarEmoteCommand is a grow only value set, written by the explorer to report
|
|
4808
|
+
* avatar emote playback to the scene. It is appended to every player entity in the
|
|
4809
|
+
* scene (the local player and remote avatars alike).
|
|
4798
4810
|
*/
|
|
4799
4811
|
/**
|
|
4800
4812
|
* @public
|
|
@@ -6405,6 +6417,70 @@ export declare namespace PBTextShape {
|
|
|
6405
6417
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
6406
6418
|
}
|
|
6407
6419
|
|
|
6420
|
+
/**
|
|
6421
|
+
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
6422
|
+
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
6423
|
+
*
|
|
6424
|
+
* By default every on-screen button is shown; list a button in `touch_inputs` with
|
|
6425
|
+
* `hide = true` to remove it (declutter). `main_action` picks which action the large
|
|
6426
|
+
* central button triggers, and `hide_joystick` removes the native virtual joystick. It is
|
|
6427
|
+
* a no-op on platforms without native on-screen controls (e.g. desktop).
|
|
6428
|
+
*
|
|
6429
|
+
* Accepted actions: only the on-screen gamepad actions map to a button — `IA_POINTER`,
|
|
6430
|
+
* `IA_PRIMARY`, `IA_SECONDARY`, `IA_JUMP`, and `IA_ACTION_3`..`IA_ACTION_6`. Any other
|
|
6431
|
+
* `InputAction` (movement actions, `IA_ANY`, `IA_MODIFIER`, or unknown/future values) is
|
|
6432
|
+
* ignored: a `TouchInput` entry naming a non-button action has no effect, and a `main_action`
|
|
6433
|
+
* that isn't a valid gamepad action falls back to the default central button (`IA_JUMP`).
|
|
6434
|
+
*/
|
|
6435
|
+
/**
|
|
6436
|
+
* @public
|
|
6437
|
+
*/
|
|
6438
|
+
export declare interface PBTouchScreenControls {
|
|
6439
|
+
touchInputs: PBTouchScreenControls_TouchInput[];
|
|
6440
|
+
/**
|
|
6441
|
+
* The large central button's action. Only the gamepad actions are valid:
|
|
6442
|
+
* jump / pointer / primary (E) / secondary (F) / action_3..action_6 (1/2/3/4).
|
|
6443
|
+
* When unset, the default central button (jump) is kept.
|
|
6444
|
+
*/
|
|
6445
|
+
mainAction?: InputAction | undefined;
|
|
6446
|
+
/** hide the native virtual joystick */
|
|
6447
|
+
hideJoystick: boolean;
|
|
6448
|
+
/** hide the on-screen crosshair / reticle */
|
|
6449
|
+
hideCrosshair: boolean;
|
|
6450
|
+
}
|
|
6451
|
+
|
|
6452
|
+
/**
|
|
6453
|
+
* @public
|
|
6454
|
+
*/
|
|
6455
|
+
export declare namespace PBTouchScreenControls {
|
|
6456
|
+
export function encode(message: PBTouchScreenControls, writer?: _m0.Writer): _m0.Writer;
|
|
6457
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls;
|
|
6458
|
+
}
|
|
6459
|
+
|
|
6460
|
+
/** Per-button configuration. A button not listed here keeps its default (shown). */
|
|
6461
|
+
/**
|
|
6462
|
+
* @public
|
|
6463
|
+
*/
|
|
6464
|
+
export declare interface PBTouchScreenControls_TouchInput {
|
|
6465
|
+
/** which on-screen button this configures */
|
|
6466
|
+
inputAction: InputAction;
|
|
6467
|
+
/** hide this button (default: shown) */
|
|
6468
|
+
hide: boolean;
|
|
6469
|
+
/**
|
|
6470
|
+
* Override the button glyph with this texture. For the jump button it replaces all
|
|
6471
|
+
* of its dynamic states (jump / double-jump / glide).
|
|
6472
|
+
*/
|
|
6473
|
+
icon?: TextureUnion | undefined;
|
|
6474
|
+
}
|
|
6475
|
+
|
|
6476
|
+
/**
|
|
6477
|
+
* @public
|
|
6478
|
+
*/
|
|
6479
|
+
export declare namespace PBTouchScreenControls_TouchInput {
|
|
6480
|
+
export function encode(message: PBTouchScreenControls_TouchInput, writer?: _m0.Writer): _m0.Writer;
|
|
6481
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTouchScreenControls_TouchInput;
|
|
6482
|
+
}
|
|
6483
|
+
|
|
6408
6484
|
/**
|
|
6409
6485
|
* The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
|
|
6410
6486
|
* when entities enter this component's defined area.
|
|
@@ -6693,6 +6769,42 @@ export declare namespace PBUiInput {
|
|
|
6693
6769
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInput;
|
|
6694
6770
|
}
|
|
6695
6771
|
|
|
6772
|
+
/**
|
|
6773
|
+
* The UiInputBinding component binds a UI entity to one or more InputActions. While the
|
|
6774
|
+
* element is pressed (touch or pointer) the listed actions are held down, driving both
|
|
6775
|
+
* the local player input and scene InputAction listeners, just like the native on-screen
|
|
6776
|
+
* buttons. It is typically combined with PBTouchScreenControls to replace the native
|
|
6777
|
+
* controls with a custom touch UI.
|
|
6778
|
+
*
|
|
6779
|
+
* Release semantics: the held actions are released as soon as the press that started them
|
|
6780
|
+
* ends. A renderer MUST release all actions held by this binding when any of the following
|
|
6781
|
+
* happens: the press/touch is lifted or cancelled, the pointer/touch leaves the element
|
|
6782
|
+
* (loses press ownership), the actions list changes (the previous set is released before
|
|
6783
|
+
* the new set is applied), the component is removed or its actions list becomes empty, the
|
|
6784
|
+
* UI element is hidden, disabled or removed from the tree, or the scene unloads. In short,
|
|
6785
|
+
* no action may remain held once the element is no longer both present and actively pressed.
|
|
6786
|
+
*
|
|
6787
|
+
* Multi-touch: the binding is a single held state, not reference-counted per pointer. The
|
|
6788
|
+
* actions are held while the element is pressed and released when that press ends; a second
|
|
6789
|
+
* simultaneous press on the same element does not stack, and does not extend the hold past
|
|
6790
|
+
* the first release.
|
|
6791
|
+
*/
|
|
6792
|
+
/**
|
|
6793
|
+
* @public
|
|
6794
|
+
*/
|
|
6795
|
+
export declare interface PBUiInputBinding {
|
|
6796
|
+
/** the input actions fired while this element is pressed */
|
|
6797
|
+
actions: InputAction[];
|
|
6798
|
+
}
|
|
6799
|
+
|
|
6800
|
+
/**
|
|
6801
|
+
* @public
|
|
6802
|
+
*/
|
|
6803
|
+
export declare namespace PBUiInputBinding {
|
|
6804
|
+
export function encode(message: PBUiInputBinding, writer?: _m0.Writer): _m0.Writer;
|
|
6805
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputBinding;
|
|
6806
|
+
}
|
|
6807
|
+
|
|
6696
6808
|
/**
|
|
6697
6809
|
* @public
|
|
6698
6810
|
*/
|
|
@@ -6961,6 +7073,7 @@ export declare namespace PBVideoPlayer {
|
|
|
6961
7073
|
* an 'instant' transition (like using speed/time = 0)
|
|
6962
7074
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6963
7075
|
* the holding entity transform).
|
|
7076
|
+
* * The fov defines the Field of View of the virtual camera
|
|
6964
7077
|
*/
|
|
6965
7078
|
/**
|
|
6966
7079
|
* @public
|
|
@@ -6968,6 +7081,8 @@ export declare namespace PBVideoPlayer {
|
|
|
6968
7081
|
export declare interface PBVirtualCamera {
|
|
6969
7082
|
defaultTransition?: CameraTransition | undefined;
|
|
6970
7083
|
lookAtEntity?: number | undefined;
|
|
7084
|
+
/** default: 60 */
|
|
7085
|
+
fov?: number | undefined;
|
|
6971
7086
|
}
|
|
6972
7087
|
|
|
6973
7088
|
/**
|
|
@@ -8988,6 +9103,9 @@ export declare const ToLinearSpace = 2.2;
|
|
|
8988
9103
|
*/
|
|
8989
9104
|
export declare type ToOptional<T> = OnlyOptionalUndefinedTypes<T> & OnlyNonUndefinedTypes<T>;
|
|
8990
9105
|
|
|
9106
|
+
/** @public */
|
|
9107
|
+
export declare const TouchScreenControls: LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>;
|
|
9108
|
+
|
|
8991
9109
|
export declare const Transform: TransformComponentExtended;
|
|
8992
9110
|
|
|
8993
9111
|
/**
|
|
@@ -9434,6 +9552,9 @@ export declare type UiFontType = 'sans-serif' | 'serif' | 'monospace';
|
|
|
9434
9552
|
/** @public */
|
|
9435
9553
|
export declare const UiInput: LastWriteWinElementSetComponentDefinition<PBUiInput>;
|
|
9436
9554
|
|
|
9555
|
+
/** @public */
|
|
9556
|
+
export declare const UiInputBinding: LastWriteWinElementSetComponentDefinition<PBUiInputBinding>;
|
|
9557
|
+
|
|
9437
9558
|
/**
|
|
9438
9559
|
* @public
|
|
9439
9560
|
*/
|