@dcl/playground-assets 7.9.4-16809745514.commit-19691a7 → 7.9.4-16839103320.commit-8a3e6ef
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 +748 -83
- package/dist/beta.d.ts +748 -83
- package/dist/index.bundled.d.ts +748 -83
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/apis.d.ts +12 -0
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +748 -83
- package/etc/playground-assets.api.json +9383 -2824
- package/etc/playground-assets.api.md +499 -50
- package/package.json +4 -4
package/dist/beta.d.ts
CHANGED
@@ -178,11 +178,31 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
|
|
178
178
|
/** @public */
|
179
179
|
export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
|
180
180
|
|
181
|
+
/**
|
182
|
+
* @public
|
183
|
+
*/
|
184
|
+
export declare const enum AvatarControlType {
|
185
|
+
/** CCT_NONE - avatar cannot move */
|
186
|
+
CCT_NONE = 0,
|
187
|
+
/** CCT_RELATIVE - avatar moves relative to the camera origin */
|
188
|
+
CCT_RELATIVE = 1,
|
189
|
+
/** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
|
190
|
+
CCT_TANK = 2
|
191
|
+
}
|
192
|
+
|
181
193
|
/** @public */
|
182
194
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
183
195
|
|
184
|
-
|
185
|
-
|
196
|
+
export declare const AvatarEquippedData: AvatarEquippedDataComponentDefinitionExtended;
|
197
|
+
|
198
|
+
/**
|
199
|
+
* @public
|
200
|
+
*/
|
201
|
+
export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
|
202
|
+
|
203
|
+
export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
|
204
|
+
forceRender?: string[] | undefined;
|
205
|
+
};
|
186
206
|
|
187
207
|
/** @public */
|
188
208
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
@@ -198,8 +218,47 @@ export declare const enum AvatarModifierType {
|
|
198
218
|
AMT_DISABLE_PASSPORTS = 1
|
199
219
|
}
|
200
220
|
|
201
|
-
/**
|
202
|
-
|
221
|
+
/**
|
222
|
+
* @public
|
223
|
+
*/
|
224
|
+
export declare interface AvatarMovementSettings {
|
225
|
+
controlMode?: AvatarControlType | undefined;
|
226
|
+
/** if not explicitly set, the following properties default to user's preference settings */
|
227
|
+
runSpeed?: number | undefined;
|
228
|
+
/** how fast the player gets up to speed or comes to rest. higher = more responsive */
|
229
|
+
friction?: number | undefined;
|
230
|
+
/** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
|
231
|
+
gravity?: number | undefined;
|
232
|
+
/** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
|
233
|
+
jumpHeight?: number | undefined;
|
234
|
+
/** max fall speed in m/s. should normally be negative */
|
235
|
+
maxFallSpeed?: number | undefined;
|
236
|
+
/** speed the player turns in tank mode, in radians/s */
|
237
|
+
turnSpeed?: number | undefined;
|
238
|
+
/** speed the player walks at, in m/s */
|
239
|
+
walkSpeed?: number | undefined;
|
240
|
+
/** 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 */
|
241
|
+
allowWeightedMovement?: boolean | undefined;
|
242
|
+
}
|
243
|
+
|
244
|
+
/**
|
245
|
+
* @public
|
246
|
+
*/
|
247
|
+
export declare namespace AvatarMovementSettings {
|
248
|
+
export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
|
249
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
250
|
+
}
|
251
|
+
|
252
|
+
export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
|
253
|
+
|
254
|
+
/**
|
255
|
+
* @public
|
256
|
+
*/
|
257
|
+
export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
|
258
|
+
|
259
|
+
export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
|
260
|
+
forceRender?: string[] | undefined;
|
261
|
+
};
|
203
262
|
|
204
263
|
/**
|
205
264
|
* @public
|
@@ -468,11 +527,19 @@ export declare interface ByteBuffer {
|
|
468
527
|
}
|
469
528
|
|
470
529
|
/**
|
471
|
-
* Callback function
|
472
|
-
*
|
530
|
+
* legacy Callback function
|
531
|
+
*
|
532
|
+
* @public @deprecated This type is no longer used in the sdk api, EventSystemCallback is
|
533
|
+
* used for listeners instead
|
473
534
|
*/
|
474
535
|
export declare type Callback = () => void;
|
475
536
|
|
537
|
+
/** @public */
|
538
|
+
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
539
|
+
|
540
|
+
/** @public */
|
541
|
+
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
542
|
+
|
476
543
|
/** @public */
|
477
544
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
478
545
|
|
@@ -530,6 +597,39 @@ export declare const enum CameraType {
|
|
530
597
|
|
531
598
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
532
599
|
|
600
|
+
/**
|
601
|
+
* @public
|
602
|
+
*/
|
603
|
+
export declare interface CinematicSettings {
|
604
|
+
/** Entity that defines the cinematic camera transform. */
|
605
|
+
cameraEntity: number;
|
606
|
+
/**
|
607
|
+
* Position -> camera's position
|
608
|
+
* Rotation -> camera's direction
|
609
|
+
* scale.z -> zoom level
|
610
|
+
* scale.x and scale.y -> unused
|
611
|
+
*/
|
612
|
+
allowManualRotation?: boolean | undefined;
|
613
|
+
/** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
|
614
|
+
yawRange?: number | undefined;
|
615
|
+
/** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
|
616
|
+
pitchRange?: number | undefined;
|
617
|
+
/** note: cameras can never look up/down further than Vec3::Y */
|
618
|
+
rollRange?: number | undefined;
|
619
|
+
/** minimum zoom level. must be greater than 0. defaults to the input zoom level */
|
620
|
+
zoomMin?: number | undefined;
|
621
|
+
/** maximum zoom level. must be greater than 0. defaults to the input zoom level */
|
622
|
+
zoomMax?: number | undefined;
|
623
|
+
}
|
624
|
+
|
625
|
+
/**
|
626
|
+
* @public
|
627
|
+
*/
|
628
|
+
export declare namespace CinematicSettings {
|
629
|
+
export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
|
630
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
|
631
|
+
}
|
632
|
+
|
533
633
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
534
634
|
/**
|
535
635
|
* @public
|
@@ -1303,12 +1403,16 @@ export declare const componentDefinitionByName: {
|
|
1303
1403
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
1304
1404
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
1305
1405
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
1406
|
+
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
1407
|
+
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
1306
1408
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
1307
1409
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
1308
1410
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
1411
|
+
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
1309
1412
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
1310
1413
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
1311
|
-
"core::
|
1414
|
+
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
1415
|
+
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
1312
1416
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
1313
1417
|
"core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
|
1314
1418
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
@@ -1324,17 +1428,19 @@ export declare const componentDefinitionByName: {
|
|
1324
1428
|
"core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
|
1325
1429
|
"core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
|
1326
1430
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
1327
|
-
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
1328
1431
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
1432
|
+
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
1329
1433
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
1330
1434
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
1331
1435
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
1332
1436
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
1437
|
+
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
1333
1438
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
1334
1439
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
1335
1440
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
1336
1441
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
1337
1442
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
1443
|
+
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
1338
1444
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
1339
1445
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
1340
1446
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
@@ -1901,10 +2007,18 @@ export declare type EntityComponents = {
|
|
1901
2007
|
uiBackground: PBUiBackground;
|
1902
2008
|
uiInput: PBUiInput;
|
1903
2009
|
uiDropdown: PBUiDropdown;
|
1904
|
-
onMouseDown:
|
1905
|
-
onMouseUp:
|
1906
|
-
onMouseEnter:
|
1907
|
-
onMouseLeave:
|
2010
|
+
onMouseDown: EventSystemCallback;
|
2011
|
+
onMouseUp: EventSystemCallback;
|
2012
|
+
onMouseEnter: EventSystemCallback;
|
2013
|
+
onMouseLeave: EventSystemCallback;
|
2014
|
+
onMouseDrag: EventSystemCallback;
|
2015
|
+
onMouseDragLocked: EventSystemCallback;
|
2016
|
+
onMouseDragEnd: EventSystemCallback;
|
2017
|
+
onInputDown: MultiCallback;
|
2018
|
+
onInputUp: MultiCallback;
|
2019
|
+
onInputDrag: MultiCallback;
|
2020
|
+
onInputDragLocked: MultiCallback;
|
2021
|
+
onInputDragEnd: MultiCallback;
|
1908
2022
|
};
|
1909
2023
|
|
1910
2024
|
/** @public */
|
@@ -1982,6 +2096,13 @@ export declare type EventSystemOptions = {
|
|
1982
2096
|
showHighlight?: boolean;
|
1983
2097
|
};
|
1984
2098
|
|
2099
|
+
/**
|
2100
|
+
* @public
|
2101
|
+
*/
|
2102
|
+
export declare type EventSystemOptionsCallback = EventSystemOptions & {
|
2103
|
+
cb: EventSystemCallback;
|
2104
|
+
};
|
2105
|
+
|
1985
2106
|
/**
|
1986
2107
|
* Excludes property keys from T where the property is assignable to U
|
1987
2108
|
* @public
|
@@ -2056,6 +2177,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
2056
2177
|
direction?: PBVector3;
|
2057
2178
|
};
|
2058
2179
|
|
2180
|
+
/** @public */
|
2181
|
+
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
2182
|
+
|
2059
2183
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
2060
2184
|
|
2061
2185
|
export declare type GlobalTargetRaycastSystemOptions = {
|
@@ -2069,7 +2193,19 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
2069
2193
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
2070
2194
|
|
2071
2195
|
/** @public */
|
2072
|
-
export declare const
|
2196
|
+
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
2197
|
+
|
2198
|
+
/** @public */
|
2199
|
+
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
2200
|
+
|
2201
|
+
/**
|
2202
|
+
* @public
|
2203
|
+
*/
|
2204
|
+
export declare const enum GltfNodeStateValue {
|
2205
|
+
GNSV_PENDING = 0,
|
2206
|
+
GNSV_FAILED = 1,
|
2207
|
+
GNSV_READY = 2
|
2208
|
+
}
|
2073
2209
|
|
2074
2210
|
/**
|
2075
2211
|
* @public
|
@@ -2409,6 +2545,12 @@ export declare type IInputSystem = {
|
|
2409
2545
|
* @returns the input command info or undefined if there is no command in the last tick-update
|
2410
2546
|
*/
|
2411
2547
|
getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
|
2548
|
+
/**
|
2549
|
+
* @public
|
2550
|
+
* Get an ordered iterator over events received within the current frame.
|
2551
|
+
* @returns the iterator
|
2552
|
+
*/
|
2553
|
+
getInputCommands: () => Generator<PBPointerEventsResult>;
|
2412
2554
|
};
|
2413
2555
|
|
2414
2556
|
/**
|
@@ -2681,13 +2823,29 @@ export declare const LightSource: LastWriteWinElementSetComponentDefinition<PBLi
|
|
2681
2823
|
*/
|
2682
2824
|
export declare type Listeners = {
|
2683
2825
|
/** triggered on mouse down event */
|
2684
|
-
onMouseDown?:
|
2826
|
+
onMouseDown?: EventSystemCallback;
|
2685
2827
|
/** triggered on mouse up event */
|
2686
|
-
onMouseUp?:
|
2828
|
+
onMouseUp?: EventSystemCallback;
|
2687
2829
|
/** triggered on mouse hover event */
|
2688
|
-
onMouseEnter?:
|
2830
|
+
onMouseEnter?: EventSystemCallback;
|
2689
2831
|
/** triggered on mouse leave event */
|
2690
|
-
onMouseLeave?:
|
2832
|
+
onMouseLeave?: EventSystemCallback;
|
2833
|
+
/** triggered on mouse drag event */
|
2834
|
+
onMouseDrag?: EventSystemCallback;
|
2835
|
+
/** triggered on mouse drag event */
|
2836
|
+
onMouseDragLocked?: EventSystemCallback;
|
2837
|
+
/** triggered on mouse drag event */
|
2838
|
+
onMouseDragEnd?: EventSystemCallback;
|
2839
|
+
/** triggered on input down event */
|
2840
|
+
onInputDown?: MultiCallback;
|
2841
|
+
/** triggered on input up event */
|
2842
|
+
onInputUp?: MultiCallback;
|
2843
|
+
/** triggered on input drag event */
|
2844
|
+
onInputDrag?: MultiCallback;
|
2845
|
+
/** triggered on input drag event */
|
2846
|
+
onInputDragLocked?: MultiCallback;
|
2847
|
+
/** triggered on input drag event */
|
2848
|
+
onInputDragEnd?: MultiCallback;
|
2691
2849
|
};
|
2692
2850
|
|
2693
2851
|
/**
|
@@ -3556,6 +3714,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3556
3714
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3557
3715
|
*/
|
3558
3716
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3717
|
+
/**
|
3718
|
+
* @public
|
3719
|
+
* Set a gltf internal mesh in the MeshCollider component
|
3720
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
3721
|
+
* @param source - the path to the gltf
|
3722
|
+
* @param meshName - the name of the mesh in the gltf
|
3723
|
+
*/
|
3724
|
+
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3559
3725
|
}
|
3560
3726
|
|
3561
3727
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3592,6 +3758,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3592
3758
|
* @param entity - entity to create or replace the MeshRenderer component
|
3593
3759
|
*/
|
3594
3760
|
setSphere(entity: Entity): void;
|
3761
|
+
/**
|
3762
|
+
* @public
|
3763
|
+
* Set a gltf internal mesh in the MeshRenderer component
|
3764
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
3765
|
+
* @param source - the path to the gltf
|
3766
|
+
* @param meshName - the name of the mesh in the gltf
|
3767
|
+
*/
|
3768
|
+
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3595
3769
|
}
|
3596
3770
|
|
3597
3771
|
/* Excluded from this release type: MessageBus */
|
@@ -3613,6 +3787,19 @@ export declare namespace Move {
|
|
3613
3787
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Move;
|
3614
3788
|
}
|
3615
3789
|
|
3790
|
+
/**
|
3791
|
+
* a record object mapping `InputAction`s to functions.
|
3792
|
+
*
|
3793
|
+
* @example
|
3794
|
+
* onInputDown={{
|
3795
|
+
* [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
|
3796
|
+
* [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
|
3797
|
+
* }}
|
3798
|
+
*
|
3799
|
+
* @public
|
3800
|
+
*/
|
3801
|
+
export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
|
3802
|
+
|
3616
3803
|
export declare const Name: NameComponent;
|
3617
3804
|
|
3618
3805
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
@@ -3985,6 +4172,25 @@ export declare const onVideoEvent: Observable<{
|
|
3985
4172
|
totalVideoLength: number;
|
3986
4173
|
}>;
|
3987
4174
|
|
4175
|
+
/**
|
4176
|
+
* @public
|
4177
|
+
*/
|
4178
|
+
export declare interface Orthographic {
|
4179
|
+
/**
|
4180
|
+
* vertical extent of the visible range in meters
|
4181
|
+
* defaults to 4m
|
4182
|
+
*/
|
4183
|
+
verticalRange?: number | undefined;
|
4184
|
+
}
|
4185
|
+
|
4186
|
+
/**
|
4187
|
+
* @public
|
4188
|
+
*/
|
4189
|
+
export declare namespace Orthographic {
|
4190
|
+
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4191
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4192
|
+
}
|
4193
|
+
|
3988
4194
|
/**
|
3989
4195
|
* @public
|
3990
4196
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4211,6 +4417,8 @@ export declare namespace PBAvatarEmoteCommand {
|
|
4211
4417
|
export declare interface PBAvatarEquippedData {
|
4212
4418
|
wearableUrns: string[];
|
4213
4419
|
emoteUrns: string[];
|
4420
|
+
/** slots that will render even if hidden */
|
4421
|
+
forceRender: string[];
|
4214
4422
|
}
|
4215
4423
|
|
4216
4424
|
/**
|
@@ -4245,6 +4453,9 @@ export declare interface PBAvatarModifierArea {
|
|
4245
4453
|
excludeIds: string[];
|
4246
4454
|
/** list of modifiers to apply */
|
4247
4455
|
modifiers: AvatarModifierType[];
|
4456
|
+
movementSettings?: AvatarMovementSettings | undefined;
|
4457
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4458
|
+
useColliderRange?: boolean | undefined;
|
4248
4459
|
}
|
4249
4460
|
|
4250
4461
|
/**
|
@@ -4301,8 +4512,8 @@ export declare interface PBAvatarShape {
|
|
4301
4512
|
wearables: string[];
|
4302
4513
|
/** available emotes (default empty) */
|
4303
4514
|
emotes: string[];
|
4304
|
-
/**
|
4305
|
-
|
4515
|
+
/** slots that will render even if hidden */
|
4516
|
+
forceRender: string[];
|
4306
4517
|
}
|
4307
4518
|
|
4308
4519
|
/**
|
@@ -4337,6 +4548,51 @@ export declare namespace PBBillboard {
|
|
4337
4548
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4338
4549
|
}
|
4339
4550
|
|
4551
|
+
/**
|
4552
|
+
* @public
|
4553
|
+
*/
|
4554
|
+
export declare interface PBCameraLayer {
|
4555
|
+
/**
|
4556
|
+
* layer to which these settings apply. must be > 0
|
4557
|
+
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4558
|
+
*/
|
4559
|
+
layer: number;
|
4560
|
+
/** should the sun light affect this layer? default false */
|
4561
|
+
directionalLight?: boolean | undefined;
|
4562
|
+
/** should this layer show player avatars? default false */
|
4563
|
+
showAvatars?: boolean | undefined;
|
4564
|
+
/** should this layer show the sky? default false */
|
4565
|
+
showSkybox?: boolean | undefined;
|
4566
|
+
/** should this layer show distance fog? default false */
|
4567
|
+
showFog?: boolean | undefined;
|
4568
|
+
/** ambient light overrides for this layer. default -> use same as main camera */
|
4569
|
+
ambientColorOverride?: PBColor3 | undefined;
|
4570
|
+
ambientBrightnessOverride?: number | undefined;
|
4571
|
+
}
|
4572
|
+
|
4573
|
+
/**
|
4574
|
+
* @public
|
4575
|
+
*/
|
4576
|
+
export declare namespace PBCameraLayer {
|
4577
|
+
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4578
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4579
|
+
}
|
4580
|
+
|
4581
|
+
/**
|
4582
|
+
* @public
|
4583
|
+
*/
|
4584
|
+
export declare interface PBCameraLayers {
|
4585
|
+
layers: number[];
|
4586
|
+
}
|
4587
|
+
|
4588
|
+
/**
|
4589
|
+
* @public
|
4590
|
+
*/
|
4591
|
+
export declare namespace PBCameraLayers {
|
4592
|
+
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4593
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4594
|
+
}
|
4595
|
+
|
4340
4596
|
/**
|
4341
4597
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4342
4598
|
* third-person view.
|
@@ -4359,7 +4615,7 @@ export declare namespace PBCameraMode {
|
|
4359
4615
|
|
4360
4616
|
/**
|
4361
4617
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4362
|
-
* the player's camera mode (1st-person
|
4618
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
4363
4619
|
*
|
4364
4620
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4365
4621
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4369,6 +4625,8 @@ export declare namespace PBCameraMode {
|
|
4369
4625
|
*
|
4370
4626
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4371
4627
|
* is actually a 3D volume.
|
4628
|
+
*
|
4629
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4372
4630
|
*/
|
4373
4631
|
/**
|
4374
4632
|
* @public
|
@@ -4378,6 +4636,9 @@ export declare interface PBCameraModeArea {
|
|
4378
4636
|
area: PBVector3 | undefined;
|
4379
4637
|
/** the camera mode to enforce */
|
4380
4638
|
mode: CameraType;
|
4639
|
+
cinematicSettings?: CinematicSettings | undefined;
|
4640
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4641
|
+
useColliderRange?: boolean | undefined;
|
4381
4642
|
}
|
4382
4643
|
|
4383
4644
|
/**
|
@@ -4449,6 +4710,39 @@ export declare namespace PBEngineInfo {
|
|
4449
4710
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4450
4711
|
}
|
4451
4712
|
|
4713
|
+
/**
|
4714
|
+
* defines the global scene light settings. must be added to the scene root.
|
4715
|
+
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4716
|
+
*/
|
4717
|
+
/**
|
4718
|
+
* @public
|
4719
|
+
*/
|
4720
|
+
export declare interface PBGlobalLight {
|
4721
|
+
/**
|
4722
|
+
* the direction the directional light shines in.
|
4723
|
+
* default depends on time of day and explorer implementation
|
4724
|
+
*/
|
4725
|
+
direction?: PBVector3 | undefined;
|
4726
|
+
/**
|
4727
|
+
* ambient light color
|
4728
|
+
* default: White
|
4729
|
+
*/
|
4730
|
+
ambientColor?: PBColor3 | undefined;
|
4731
|
+
/**
|
4732
|
+
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4733
|
+
* default 1
|
4734
|
+
*/
|
4735
|
+
ambientBrightness?: number | undefined;
|
4736
|
+
}
|
4737
|
+
|
4738
|
+
/**
|
4739
|
+
* @public
|
4740
|
+
*/
|
4741
|
+
export declare namespace PBGlobalLight {
|
4742
|
+
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4743
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4744
|
+
}
|
4745
|
+
|
4452
4746
|
/**
|
4453
4747
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4454
4748
|
*
|
@@ -4484,6 +4778,25 @@ export declare namespace PBGltfContainer {
|
|
4484
4778
|
*/
|
4485
4779
|
export declare interface PBGltfContainerLoadingState {
|
4486
4780
|
currentState: LoadingState;
|
4781
|
+
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4782
|
+
nodePaths: string[];
|
4783
|
+
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4784
|
+
meshNames: string[];
|
4785
|
+
/**
|
4786
|
+
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4787
|
+
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4788
|
+
*/
|
4789
|
+
materialNames: string[];
|
4790
|
+
/**
|
4791
|
+
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4792
|
+
* sure all your materials are explicitly named.
|
4793
|
+
*/
|
4794
|
+
skinNames: string[];
|
4795
|
+
/**
|
4796
|
+
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4797
|
+
* your skins are explicitly named.
|
4798
|
+
*/
|
4799
|
+
animationNames: string[];
|
4487
4800
|
}
|
4488
4801
|
|
4489
4802
|
/**
|
@@ -4495,48 +4808,74 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4495
4808
|
}
|
4496
4809
|
|
4497
4810
|
/**
|
4498
|
-
*
|
4811
|
+
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4812
|
+
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4813
|
+
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4814
|
+
* in the parent.
|
4815
|
+
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4816
|
+
*
|
4817
|
+
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4818
|
+
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4819
|
+
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4820
|
+
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4821
|
+
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4822
|
+
*
|
4823
|
+
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4499
4824
|
*
|
4500
|
-
*
|
4825
|
+
* From the scene, you can modify various components to alter the gltf node:
|
4826
|
+
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4827
|
+
* regardless of any intermediate gltf node hierarchy.
|
4828
|
+
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4829
|
+
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4830
|
+
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4831
|
+
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4832
|
+
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4833
|
+
* used as a base, and any gltf features (e.g. occlusion maps) from the gtlf spec that the renderer supports but that are not exposed in the
|
4834
|
+
* PBMaterial will be maintained.
|
4501
4835
|
*
|
4502
|
-
*
|
4503
|
-
*
|
4504
|
-
*
|
4505
|
-
* the
|
4836
|
+
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4837
|
+
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4838
|
+
* change the state to `GNS_FAILED`.
|
4839
|
+
* - deleting the scene entity will not delete the gltf node.
|
4840
|
+
*
|
4841
|
+
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4842
|
+
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4843
|
+
* the gltf node will also be displayed.
|
4506
4844
|
*/
|
4507
4845
|
/**
|
4508
4846
|
* @public
|
4509
4847
|
*/
|
4510
|
-
export declare interface
|
4511
|
-
|
4848
|
+
export declare interface PBGltfNode {
|
4849
|
+
/** the path of the target node in the Gltf. */
|
4850
|
+
path: string;
|
4512
4851
|
}
|
4513
4852
|
|
4514
4853
|
/**
|
4515
4854
|
* @public
|
4516
4855
|
*/
|
4517
|
-
export declare namespace
|
4518
|
-
export function encode(message:
|
4519
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number):
|
4856
|
+
export declare namespace PBGltfNode {
|
4857
|
+
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4858
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4520
4859
|
}
|
4521
4860
|
|
4861
|
+
/**
|
4862
|
+
* The state of a linked gltf node.
|
4863
|
+
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4864
|
+
*/
|
4522
4865
|
/**
|
4523
4866
|
* @public
|
4524
4867
|
*/
|
4525
|
-
export declare interface
|
4526
|
-
|
4527
|
-
|
4528
|
-
/** The casting shadows enabled override */
|
4529
|
-
castShadows?: boolean | undefined;
|
4530
|
-
/** The Material that will be overridden on the target Node */
|
4531
|
-
material?: PBMaterial | undefined;
|
4868
|
+
export declare interface PBGltfNodeState {
|
4869
|
+
state: GltfNodeStateValue;
|
4870
|
+
error?: string | undefined;
|
4532
4871
|
}
|
4533
4872
|
|
4534
4873
|
/**
|
4535
4874
|
* @public
|
4536
4875
|
*/
|
4537
|
-
export declare namespace
|
4538
|
-
export function encode(message:
|
4539
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number):
|
4876
|
+
export declare namespace PBGltfNodeState {
|
4877
|
+
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4878
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4540
4879
|
}
|
4541
4880
|
|
4542
4881
|
/**
|
@@ -4674,6 +5013,14 @@ export declare interface PBMaterial {
|
|
4674
5013
|
$case: "pbr";
|
4675
5014
|
pbr: PBMaterial_PbrMaterial;
|
4676
5015
|
} | undefined;
|
5016
|
+
/**
|
5017
|
+
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
5018
|
+
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
5019
|
+
* supported by the PbMaterial.
|
5020
|
+
* If this is provided and the `material` field is not provided, the renderer will update the material
|
5021
|
+
* field with data that reflects the gltf material once it is loaded.
|
5022
|
+
*/
|
5023
|
+
gltf?: PBMaterial_GltfMaterial | undefined;
|
4677
5024
|
}
|
4678
5025
|
|
4679
5026
|
/**
|
@@ -4684,6 +5031,22 @@ export declare namespace PBMaterial {
|
|
4684
5031
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4685
5032
|
}
|
4686
5033
|
|
5034
|
+
/**
|
5035
|
+
* @public
|
5036
|
+
*/
|
5037
|
+
export declare interface PBMaterial_GltfMaterial {
|
5038
|
+
gltfSrc: string;
|
5039
|
+
name: string;
|
5040
|
+
}
|
5041
|
+
|
5042
|
+
/**
|
5043
|
+
* @public
|
5044
|
+
*/
|
5045
|
+
export declare namespace PBMaterial_GltfMaterial {
|
5046
|
+
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
5047
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
5048
|
+
}
|
5049
|
+
|
4687
5050
|
/**
|
4688
5051
|
* @public
|
4689
5052
|
*/
|
@@ -4780,6 +5143,9 @@ export declare interface PBMeshCollider {
|
|
4780
5143
|
} | {
|
4781
5144
|
$case: "plane";
|
4782
5145
|
plane: PBMeshCollider_PlaneMesh;
|
5146
|
+
} | {
|
5147
|
+
$case: "gltf";
|
5148
|
+
gltf: PBMeshCollider_GltfMesh;
|
4783
5149
|
} | undefined;
|
4784
5150
|
}
|
4785
5151
|
|
@@ -4825,6 +5191,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
4825
5191
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
4826
5192
|
}
|
4827
5193
|
|
5194
|
+
/** A collider constructed from a Gltf Mesh. */
|
5195
|
+
/**
|
5196
|
+
* @public
|
5197
|
+
*/
|
5198
|
+
export declare interface PBMeshCollider_GltfMesh {
|
5199
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
5200
|
+
gltfSrc: string;
|
5201
|
+
/** the name of the mesh asset */
|
5202
|
+
name: string;
|
5203
|
+
}
|
5204
|
+
|
5205
|
+
/**
|
5206
|
+
* @public
|
5207
|
+
*/
|
5208
|
+
export declare namespace PBMeshCollider_GltfMesh {
|
5209
|
+
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5210
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5211
|
+
}
|
5212
|
+
|
4828
5213
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
4829
5214
|
/**
|
4830
5215
|
* @public
|
@@ -4857,13 +5242,11 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
4857
5242
|
|
4858
5243
|
/**
|
4859
5244
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
4860
|
-
* plane, a sphere or a
|
5245
|
+
* plane, a sphere, a cylinder, or a Gltf mesh.
|
4861
5246
|
*
|
4862
5247
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
4863
5248
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
4864
5249
|
* `float` coordinates, one for each corner of each side of each face.
|
4865
|
-
*
|
4866
|
-
* More complex shapes require the use of a `GltfContainer` component.
|
4867
5250
|
*/
|
4868
5251
|
/**
|
4869
5252
|
* @public
|
@@ -4881,6 +5264,9 @@ export declare interface PBMeshRenderer {
|
|
4881
5264
|
} | {
|
4882
5265
|
$case: "plane";
|
4883
5266
|
plane: PBMeshRenderer_PlaneMesh;
|
5267
|
+
} | {
|
5268
|
+
$case: "gltf";
|
5269
|
+
gltf: PBMeshRenderer_GltfMesh;
|
4884
5270
|
} | undefined;
|
4885
5271
|
}
|
4886
5272
|
|
@@ -4928,6 +5314,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
4928
5314
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
4929
5315
|
}
|
4930
5316
|
|
5317
|
+
/** A mesh from a Gltf. */
|
5318
|
+
/**
|
5319
|
+
* @public
|
5320
|
+
*/
|
5321
|
+
export declare interface PBMeshRenderer_GltfMesh {
|
5322
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
5323
|
+
gltfSrc: string;
|
5324
|
+
/** the name of the mesh asset */
|
5325
|
+
name: string;
|
5326
|
+
}
|
5327
|
+
|
5328
|
+
/**
|
5329
|
+
* @public
|
5330
|
+
*/
|
5331
|
+
export declare namespace PBMeshRenderer_GltfMesh {
|
5332
|
+
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5333
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5334
|
+
}
|
5335
|
+
|
4931
5336
|
/** PlaneMesh renders a 2D rectangular shape. */
|
4932
5337
|
/**
|
4933
5338
|
* @public
|
@@ -5176,7 +5581,10 @@ export declare interface PBPrimaryPointerInfo {
|
|
5176
5581
|
screenCoordinates?: PBVector2 | undefined;
|
5177
5582
|
/** Movement since last frame (pixels) */
|
5178
5583
|
screenDelta?: PBVector2 | undefined;
|
5179
|
-
/**
|
5584
|
+
/**
|
5585
|
+
* ray direction that can be used with the primary camera origin for
|
5586
|
+
* raycasting from the cursor into the world
|
5587
|
+
*/
|
5180
5588
|
worldRayDirection?: PBVector3 | undefined;
|
5181
5589
|
}
|
5182
5590
|
|
@@ -5316,28 +5724,6 @@ export declare namespace PBRealmInfo {
|
|
5316
5724
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5317
5725
|
}
|
5318
5726
|
|
5319
|
-
/**
|
5320
|
-
* The SkyboxTime component allows controlling the time of day for the skybox,
|
5321
|
-
* affecting the lighting and appearance of the sky in the scene.
|
5322
|
-
*/
|
5323
|
-
/**
|
5324
|
-
* @public
|
5325
|
-
*/
|
5326
|
-
export declare interface PBSkyboxTime {
|
5327
|
-
/** fixed time of day, represented as a number of seconds since the start of the day, where 0 is 00:00hs, 43200 is 12:00hs and 86400 is 24:00hs */
|
5328
|
-
fixedTime: number;
|
5329
|
-
/** default = TransitionMode.TM_FORWARD, controls the direction of time transitions */
|
5330
|
-
transitionMode?: TransitionMode | undefined;
|
5331
|
-
}
|
5332
|
-
|
5333
|
-
/**
|
5334
|
-
* @public
|
5335
|
-
*/
|
5336
|
-
export declare namespace PBSkyboxTime {
|
5337
|
-
export function encode(message: PBSkyboxTime, writer?: _m0.Writer): _m0.Writer;
|
5338
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
|
5339
|
-
}
|
5340
|
-
|
5341
5727
|
/**
|
5342
5728
|
* The TextShape component renders customizable floating text.
|
5343
5729
|
*
|
@@ -5402,6 +5788,46 @@ export declare namespace PBTextShape {
|
|
5402
5788
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5403
5789
|
}
|
5404
5790
|
|
5791
|
+
/**
|
5792
|
+
* @public
|
5793
|
+
*/
|
5794
|
+
export declare interface PBTextureCamera {
|
5795
|
+
/** rendered texture width */
|
5796
|
+
width?: number | undefined;
|
5797
|
+
/** rendered texture height */
|
5798
|
+
height?: number | undefined;
|
5799
|
+
/**
|
5800
|
+
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5801
|
+
* defaults to 0
|
5802
|
+
*/
|
5803
|
+
layer?: number | undefined;
|
5804
|
+
/** default black */
|
5805
|
+
clearColor?: PBColor4 | undefined;
|
5806
|
+
/** default infinity */
|
5807
|
+
farPlane?: number | undefined;
|
5808
|
+
mode?: {
|
5809
|
+
$case: "perspective";
|
5810
|
+
perspective: Perspective;
|
5811
|
+
} | {
|
5812
|
+
$case: "orthographic";
|
5813
|
+
orthographic: Orthographic;
|
5814
|
+
} | undefined;
|
5815
|
+
/**
|
5816
|
+
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
5817
|
+
* range: 0 (off) - 1 (full volume)
|
5818
|
+
* default: 0
|
5819
|
+
*/
|
5820
|
+
volume?: number | undefined;
|
5821
|
+
}
|
5822
|
+
|
5823
|
+
/**
|
5824
|
+
* @public
|
5825
|
+
*/
|
5826
|
+
export declare namespace PBTextureCamera {
|
5827
|
+
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5828
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5829
|
+
}
|
5830
|
+
|
5405
5831
|
/**
|
5406
5832
|
* @public
|
5407
5833
|
*/
|
@@ -5491,6 +5917,25 @@ export declare namespace PBUiBackground {
|
|
5491
5917
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5492
5918
|
}
|
5493
5919
|
|
5920
|
+
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5921
|
+
/**
|
5922
|
+
* @public
|
5923
|
+
*/
|
5924
|
+
export declare interface PBUiCanvas {
|
5925
|
+
width: number;
|
5926
|
+
height: number;
|
5927
|
+
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5928
|
+
color?: PBColor4 | undefined;
|
5929
|
+
}
|
5930
|
+
|
5931
|
+
/**
|
5932
|
+
* @public
|
5933
|
+
*/
|
5934
|
+
export declare namespace PBUiCanvas {
|
5935
|
+
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5936
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5937
|
+
}
|
5938
|
+
|
5494
5939
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5495
5940
|
/**
|
5496
5941
|
* @public
|
@@ -5607,6 +6052,21 @@ export declare namespace PBUiInputResult {
|
|
5607
6052
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5608
6053
|
}
|
5609
6054
|
|
6055
|
+
/**
|
6056
|
+
* @public
|
6057
|
+
*/
|
6058
|
+
export declare interface PBUiScrollResult {
|
6059
|
+
value: PBVector2 | undefined;
|
6060
|
+
}
|
6061
|
+
|
6062
|
+
/**
|
6063
|
+
* @public
|
6064
|
+
*/
|
6065
|
+
export declare namespace PBUiScrollResult {
|
6066
|
+
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
6067
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
6068
|
+
}
|
6069
|
+
|
5610
6070
|
/**
|
5611
6071
|
* @public
|
5612
6072
|
*/
|
@@ -5623,6 +6083,10 @@ export declare interface PBUiText {
|
|
5623
6083
|
fontSize?: number | undefined;
|
5624
6084
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
5625
6085
|
textWrap?: TextWrap | undefined;
|
6086
|
+
/** width of the outline (default: 0) */
|
6087
|
+
outlineWidth?: number | undefined;
|
6088
|
+
/** RGBA color of the outline (default: opaque black) */
|
6089
|
+
outlineColor?: PBColor4 | undefined;
|
5626
6090
|
}
|
5627
6091
|
|
5628
6092
|
/**
|
@@ -5750,6 +6214,12 @@ export declare interface PBUiTransform {
|
|
5750
6214
|
borderRightColor?: PBColor4 | undefined;
|
5751
6215
|
/** default: 1 */
|
5752
6216
|
opacity?: number | undefined;
|
6217
|
+
/** reference for scroll_position. default empty */
|
6218
|
+
elementId?: string | undefined;
|
6219
|
+
/** default position=(0,0) */
|
6220
|
+
scrollPosition?: ScrollPositionValue | undefined;
|
6221
|
+
/** default ShowScrollBar.SSB_BOTH */
|
6222
|
+
scrollVisible?: ShowScrollBar | undefined;
|
5753
6223
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
5754
6224
|
zIndex?: number | undefined;
|
5755
6225
|
}
|
@@ -5881,6 +6351,25 @@ export declare namespace PBVisibilityComponent {
|
|
5881
6351
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
5882
6352
|
}
|
5883
6353
|
|
6354
|
+
/**
|
6355
|
+
* @public
|
6356
|
+
*/
|
6357
|
+
export declare interface Perspective {
|
6358
|
+
/**
|
6359
|
+
* vertical field of view in radians
|
6360
|
+
* defaults to pi/4 = 45 degrees
|
6361
|
+
*/
|
6362
|
+
fieldOfView?: number | undefined;
|
6363
|
+
}
|
6364
|
+
|
6365
|
+
/**
|
6366
|
+
* @public
|
6367
|
+
*/
|
6368
|
+
export declare namespace Perspective {
|
6369
|
+
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6370
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6371
|
+
}
|
6372
|
+
|
5884
6373
|
/**
|
5885
6374
|
* Represens a plane by the equation ax + by + cz + d = 0
|
5886
6375
|
* @public
|
@@ -6036,11 +6525,37 @@ export declare interface PointerEventsSystem {
|
|
6036
6525
|
* @param entity - Entity where the callback was attached
|
6037
6526
|
*/
|
6038
6527
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6528
|
+
/**
|
6529
|
+
* @public
|
6530
|
+
* Remove the callback for onPointerDrag event
|
6531
|
+
* @param entity - Entity where the callback was attached
|
6532
|
+
*/
|
6533
|
+
removeOnPointerDrag(entity: Entity): void;
|
6534
|
+
/**
|
6535
|
+
* @public
|
6536
|
+
* Remove the callback for onPointerDragLocked event
|
6537
|
+
* @param entity - Entity where the callback was attached
|
6538
|
+
*/
|
6539
|
+
removeOnPointerDragLocked(entity: Entity): void;
|
6540
|
+
/**
|
6541
|
+
* @public
|
6542
|
+
* Remove the callback for onPointerDragEnd event
|
6543
|
+
* @param entity - Entity where the callback was attached
|
6544
|
+
*/
|
6545
|
+
removeOnPointerDragEnd(entity: Entity): void;
|
6546
|
+
/**
|
6547
|
+
* @public
|
6548
|
+
* Execute callbacks when the user presses one of the InputButtons pointing at the entity
|
6549
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6550
|
+
*/
|
6551
|
+
onPointerDown(pointerData: {
|
6552
|
+
entity: Entity;
|
6553
|
+
optsList: EventSystemOptionsCallback[];
|
6554
|
+
}): void;
|
6039
6555
|
/**
|
6040
6556
|
* @public
|
6041
6557
|
* Execute callback when the user press the InputButton pointing at the entity
|
6042
6558
|
* @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
|
6043
|
-
* @param cb - Function to execute when click fires
|
6044
6559
|
*/
|
6045
6560
|
onPointerDown(pointerData: {
|
6046
6561
|
entity: Entity;
|
@@ -6053,6 +6568,15 @@ export declare interface PointerEventsSystem {
|
|
6053
6568
|
* @param opts - Opts to trigger Feedback and Button
|
6054
6569
|
*/
|
6055
6570
|
onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
|
6571
|
+
/**
|
6572
|
+
* @public
|
6573
|
+
* Execute callbacks when the user releases one of the InputButtons pointing at the entity
|
6574
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6575
|
+
*/
|
6576
|
+
onPointerUp(pointerData: {
|
6577
|
+
entity: Entity;
|
6578
|
+
optsList: EventSystemOptionsCallback[];
|
6579
|
+
}): void;
|
6056
6580
|
/**
|
6057
6581
|
* @public
|
6058
6582
|
* Execute callback when the user releases the InputButton pointing at the entity
|
@@ -6090,6 +6614,64 @@ export declare interface PointerEventsSystem {
|
|
6090
6614
|
entity: Entity;
|
6091
6615
|
opts?: Partial<EventSystemOptions>;
|
6092
6616
|
}, cb: EventSystemCallback): void;
|
6617
|
+
/**
|
6618
|
+
* @public
|
6619
|
+
* Execute callbacks when the user drags the pointer from inside the entity
|
6620
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6621
|
+
*/
|
6622
|
+
onPointerDrag(pointerData: {
|
6623
|
+
entity: Entity;
|
6624
|
+
optsList: EventSystemOptionsCallback[];
|
6625
|
+
}): void;
|
6626
|
+
/**
|
6627
|
+
* @public
|
6628
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6629
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6630
|
+
* @param cb - Function to execute when click fires
|
6631
|
+
*/
|
6632
|
+
onPointerDrag(pointerData: {
|
6633
|
+
entity: Entity;
|
6634
|
+
opts?: Partial<EventSystemOptions>;
|
6635
|
+
}, cb: EventSystemCallback): void;
|
6636
|
+
/**
|
6637
|
+
* @public
|
6638
|
+
* Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
|
6639
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6640
|
+
*/
|
6641
|
+
onPointerDragLocked(pointerData: {
|
6642
|
+
entity: Entity;
|
6643
|
+
optsList: EventSystemOptionsCallback[];
|
6644
|
+
}): void;
|
6645
|
+
/**
|
6646
|
+
* @public
|
6647
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6648
|
+
* locking the cursor in place
|
6649
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6650
|
+
* @param cb - Function to execute when click fires
|
6651
|
+
*/
|
6652
|
+
onPointerDragLocked(pointerData: {
|
6653
|
+
entity: Entity;
|
6654
|
+
opts?: Partial<EventSystemOptions>;
|
6655
|
+
}, cb: EventSystemCallback): void;
|
6656
|
+
/**
|
6657
|
+
* @public
|
6658
|
+
* Execute callbacks when the user releases a button after a drag
|
6659
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6660
|
+
*/
|
6661
|
+
onPointerDragEnd(pointerData: {
|
6662
|
+
entity: Entity;
|
6663
|
+
optsList: EventSystemOptionsCallback[];
|
6664
|
+
}): void;
|
6665
|
+
/**
|
6666
|
+
* @public
|
6667
|
+
* Execute callback when the user releases the button after a drag
|
6668
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6669
|
+
* @param cb - Function to execute when click fires
|
6670
|
+
*/
|
6671
|
+
onPointerDragEnd(pointerData: {
|
6672
|
+
entity: Entity;
|
6673
|
+
opts?: Partial<EventSystemOptions>;
|
6674
|
+
}, cb: EventSystemCallback): void;
|
6093
6675
|
}
|
6094
6676
|
|
6095
6677
|
/**
|
@@ -6106,7 +6688,10 @@ export declare const enum PointerEventType {
|
|
6106
6688
|
PET_UP = 0,
|
6107
6689
|
PET_DOWN = 1,
|
6108
6690
|
PET_HOVER_ENTER = 2,
|
6109
|
-
PET_HOVER_LEAVE = 3
|
6691
|
+
PET_HOVER_LEAVE = 3,
|
6692
|
+
PET_DRAG_LOCKED = 4,
|
6693
|
+
PET_DRAG = 5,
|
6694
|
+
PET_DRAG_END = 6
|
6110
6695
|
}
|
6111
6696
|
|
6112
6697
|
/**
|
@@ -6137,7 +6722,10 @@ export declare const enum PointerType {
|
|
6137
6722
|
/** POT_NONE - No pointer input */
|
6138
6723
|
POT_NONE = 0,
|
6139
6724
|
/** POT_MOUSE - Traditional mouse input */
|
6140
|
-
POT_MOUSE = 1
|
6725
|
+
POT_MOUSE = 1,
|
6726
|
+
POT_PAD = 2,
|
6727
|
+
POT_TOUCH = 3,
|
6728
|
+
POT_WAND = 4
|
6141
6729
|
}
|
6142
6730
|
|
6143
6731
|
/**
|
@@ -6734,6 +7322,7 @@ export declare type RaycastSystemOptions = {
|
|
6734
7322
|
export declare interface ReactBasedUiSystem {
|
6735
7323
|
destroy(): void;
|
6736
7324
|
setUiRenderer(ui: UiComponent): void;
|
7325
|
+
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
6737
7326
|
}
|
6738
7327
|
|
6739
7328
|
/**
|
@@ -7196,8 +7785,42 @@ export declare namespace Schemas {
|
|
7196
7785
|
}) => void;
|
7197
7786
|
}
|
7198
7787
|
|
7199
|
-
/**
|
7200
|
-
|
7788
|
+
/**
|
7789
|
+
* @public
|
7790
|
+
*/
|
7791
|
+
export declare interface ScrollPositionValue {
|
7792
|
+
value?: {
|
7793
|
+
$case: "position";
|
7794
|
+
position: PBVector2;
|
7795
|
+
} | {
|
7796
|
+
$case: "reference";
|
7797
|
+
reference: string;
|
7798
|
+
} | undefined;
|
7799
|
+
}
|
7800
|
+
|
7801
|
+
/**
|
7802
|
+
* @public
|
7803
|
+
*/
|
7804
|
+
export declare namespace ScrollPositionValue {
|
7805
|
+
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7806
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7807
|
+
}
|
7808
|
+
|
7809
|
+
/**
|
7810
|
+
* @public
|
7811
|
+
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7812
|
+
*/
|
7813
|
+
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7814
|
+
|
7815
|
+
/**
|
7816
|
+
* @public
|
7817
|
+
*/
|
7818
|
+
export declare const enum ShowScrollBar {
|
7819
|
+
SSB_BOTH = 0,
|
7820
|
+
SSB_ONLY_VERTICAL = 1,
|
7821
|
+
SSB_ONLY_HORIZONTAL = 2,
|
7822
|
+
SSB_HIDDEN = 3
|
7823
|
+
}
|
7201
7824
|
|
7202
7825
|
/**
|
7203
7826
|
* @public
|
@@ -7275,6 +7898,9 @@ export declare namespace Texture {
|
|
7275
7898
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7276
7899
|
}
|
7277
7900
|
|
7901
|
+
/** @public */
|
7902
|
+
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7903
|
+
|
7278
7904
|
/**
|
7279
7905
|
* @public
|
7280
7906
|
*/
|
@@ -7367,6 +7993,9 @@ export declare interface TextureUnion {
|
|
7367
7993
|
} | {
|
7368
7994
|
$case: "videoTexture";
|
7369
7995
|
videoTexture: VideoTexture;
|
7996
|
+
} | {
|
7997
|
+
$case: "uiTexture";
|
7998
|
+
uiTexture: UiCanvasTexture;
|
7370
7999
|
} | undefined;
|
7371
8000
|
}
|
7372
8001
|
|
@@ -7460,17 +8089,6 @@ export declare type TransformType = {
|
|
7460
8089
|
*/
|
7461
8090
|
export declare type TransformTypeWithOptionals = Partial<TransformType>;
|
7462
8091
|
|
7463
|
-
/** Controls the direction for animated skybox transitions */
|
7464
|
-
/**
|
7465
|
-
* @public
|
7466
|
-
*/
|
7467
|
-
export declare const enum TransitionMode {
|
7468
|
-
/** TM_FORWARD - transitions forward (default) */
|
7469
|
-
TM_FORWARD = 0,
|
7470
|
-
/** TM_BACKWARD - transitions backward */
|
7471
|
-
TM_BACKWARD = 1
|
7472
|
-
}
|
7473
|
-
|
7474
8092
|
/**
|
7475
8093
|
* @public
|
7476
8094
|
*/
|
@@ -7585,6 +8203,8 @@ export declare interface UiBackgroundProps {
|
|
7585
8203
|
uvs?: number[];
|
7586
8204
|
/** AvatarTexture for the background */
|
7587
8205
|
avatarTexture?: UiAvatarTexture;
|
8206
|
+
/** VideoTexture for the background */
|
8207
|
+
videoTexture?: UiVideoTexture;
|
7588
8208
|
/** Texture for the background */
|
7589
8209
|
texture?: UiTexture;
|
7590
8210
|
}
|
@@ -7604,9 +8224,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
7604
8224
|
disabled?: boolean;
|
7605
8225
|
}
|
7606
8226
|
|
8227
|
+
/** @public */
|
8228
|
+
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8229
|
+
|
7607
8230
|
/** @public */
|
7608
8231
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
7609
8232
|
|
8233
|
+
/**
|
8234
|
+
* @public
|
8235
|
+
*/
|
8236
|
+
export declare interface UiCanvasTexture {
|
8237
|
+
uiCanvasEntity: number;
|
8238
|
+
/** default = TextureWrapMode.Clamp */
|
8239
|
+
wrapMode?: TextureWrapMode | undefined;
|
8240
|
+
/** default = FilterMode.Bilinear */
|
8241
|
+
filterMode?: TextureFilterMode | undefined;
|
8242
|
+
}
|
8243
|
+
|
8244
|
+
/**
|
8245
|
+
* @public
|
8246
|
+
*/
|
8247
|
+
export declare namespace UiCanvasTexture {
|
8248
|
+
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8249
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8250
|
+
}
|
8251
|
+
|
7610
8252
|
/**
|
7611
8253
|
* @public
|
7612
8254
|
*/
|
@@ -7676,6 +8318,10 @@ export declare interface UiLabelProps {
|
|
7676
8318
|
textAlign?: TextAlignType | undefined;
|
7677
8319
|
/** Label font type. @defaultValue 'sans-serif' */
|
7678
8320
|
font?: UiFontType | undefined;
|
8321
|
+
/** Outline width of the text. @defaultValue 0 */
|
8322
|
+
outlineWidth?: number | undefined;
|
8323
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8324
|
+
outlineColor?: PBColor4 | undefined;
|
7679
8325
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
7680
8326
|
textWrap?: UiTextWrapType | undefined;
|
7681
8327
|
}
|
@@ -7685,6 +8331,9 @@ export declare interface UiLabelProps {
|
|
7685
8331
|
*/
|
7686
8332
|
export declare type uint32 = number;
|
7687
8333
|
|
8334
|
+
/** @public */
|
8335
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8336
|
+
|
7688
8337
|
/** @public */
|
7689
8338
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
7690
8339
|
|
@@ -7762,10 +8411,26 @@ export declare interface UiTransformProps {
|
|
7762
8411
|
borderWidth?: Partial<Position> | PositionUnit;
|
7763
8412
|
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
7764
8413
|
opacity?: number;
|
8414
|
+
/** A reference value to identify the element, default empty */
|
8415
|
+
elementId?: string;
|
8416
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8417
|
+
scrollPosition?: PBVector2 | string;
|
8418
|
+
/** default ShowScrollBar.SSB_BOTH */
|
8419
|
+
scrollVisible?: ScrollVisibleType;
|
7765
8420
|
/** default 0 */
|
7766
8421
|
zIndex?: number;
|
7767
8422
|
}
|
7768
8423
|
|
8424
|
+
/**
|
8425
|
+
* Texture
|
8426
|
+
* @public
|
8427
|
+
*/
|
8428
|
+
export declare interface UiVideoTexture {
|
8429
|
+
videoPlayerEntity: Entity;
|
8430
|
+
wrapMode?: TextureWrapType;
|
8431
|
+
filterMode?: TextureFilterType;
|
8432
|
+
}
|
8433
|
+
|
7769
8434
|
/**
|
7770
8435
|
* @public
|
7771
8436
|
*/
|