@dcl/playground-assets 7.9.4-16820196581.commit-2495603 → 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/alpha.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
|
@@ -2418,6 +2554,12 @@ export declare type IInputSystem = {
|
|
2418
2554
|
* @returns the input command info or undefined if there is no command in the last tick-update
|
2419
2555
|
*/
|
2420
2556
|
getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
|
2557
|
+
/**
|
2558
|
+
* @public
|
2559
|
+
* Get an ordered iterator over events received within the current frame.
|
2560
|
+
* @returns the iterator
|
2561
|
+
*/
|
2562
|
+
getInputCommands: () => Generator<PBPointerEventsResult>;
|
2421
2563
|
};
|
2422
2564
|
|
2423
2565
|
/**
|
@@ -2690,13 +2832,29 @@ export declare const LightSource: LastWriteWinElementSetComponentDefinition<PBLi
|
|
2690
2832
|
*/
|
2691
2833
|
export declare type Listeners = {
|
2692
2834
|
/** triggered on mouse down event */
|
2693
|
-
onMouseDown?:
|
2835
|
+
onMouseDown?: EventSystemCallback;
|
2694
2836
|
/** triggered on mouse up event */
|
2695
|
-
onMouseUp?:
|
2837
|
+
onMouseUp?: EventSystemCallback;
|
2696
2838
|
/** triggered on mouse hover event */
|
2697
|
-
onMouseEnter?:
|
2839
|
+
onMouseEnter?: EventSystemCallback;
|
2698
2840
|
/** triggered on mouse leave event */
|
2699
|
-
onMouseLeave?:
|
2841
|
+
onMouseLeave?: EventSystemCallback;
|
2842
|
+
/** triggered on mouse drag event */
|
2843
|
+
onMouseDrag?: EventSystemCallback;
|
2844
|
+
/** triggered on mouse drag event */
|
2845
|
+
onMouseDragLocked?: EventSystemCallback;
|
2846
|
+
/** triggered on mouse drag event */
|
2847
|
+
onMouseDragEnd?: EventSystemCallback;
|
2848
|
+
/** triggered on input down event */
|
2849
|
+
onInputDown?: MultiCallback;
|
2850
|
+
/** triggered on input up event */
|
2851
|
+
onInputUp?: MultiCallback;
|
2852
|
+
/** triggered on input drag event */
|
2853
|
+
onInputDrag?: MultiCallback;
|
2854
|
+
/** triggered on input drag event */
|
2855
|
+
onInputDragLocked?: MultiCallback;
|
2856
|
+
/** triggered on input drag event */
|
2857
|
+
onInputDragEnd?: MultiCallback;
|
2700
2858
|
};
|
2701
2859
|
|
2702
2860
|
/**
|
@@ -3565,6 +3723,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3565
3723
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3566
3724
|
*/
|
3567
3725
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3726
|
+
/**
|
3727
|
+
* @public
|
3728
|
+
* Set a gltf internal mesh in the MeshCollider component
|
3729
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
3730
|
+
* @param source - the path to the gltf
|
3731
|
+
* @param meshName - the name of the mesh in the gltf
|
3732
|
+
*/
|
3733
|
+
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3568
3734
|
}
|
3569
3735
|
|
3570
3736
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3601,6 +3767,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3601
3767
|
* @param entity - entity to create or replace the MeshRenderer component
|
3602
3768
|
*/
|
3603
3769
|
setSphere(entity: Entity): void;
|
3770
|
+
/**
|
3771
|
+
* @public
|
3772
|
+
* Set a gltf internal mesh in the MeshRenderer component
|
3773
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
3774
|
+
* @param source - the path to the gltf
|
3775
|
+
* @param meshName - the name of the mesh in the gltf
|
3776
|
+
*/
|
3777
|
+
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3604
3778
|
}
|
3605
3779
|
|
3606
3780
|
/**
|
@@ -3633,6 +3807,19 @@ export declare namespace Move {
|
|
3633
3807
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Move;
|
3634
3808
|
}
|
3635
3809
|
|
3810
|
+
/**
|
3811
|
+
* a record object mapping `InputAction`s to functions.
|
3812
|
+
*
|
3813
|
+
* @example
|
3814
|
+
* onInputDown={{
|
3815
|
+
* [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
|
3816
|
+
* [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
|
3817
|
+
* }}
|
3818
|
+
*
|
3819
|
+
* @public
|
3820
|
+
*/
|
3821
|
+
export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
|
3822
|
+
|
3636
3823
|
export declare const Name: NameComponent;
|
3637
3824
|
|
3638
3825
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
@@ -4013,6 +4200,25 @@ export declare const onVideoEvent: Observable<{
|
|
4013
4200
|
totalVideoLength: number;
|
4014
4201
|
}>;
|
4015
4202
|
|
4203
|
+
/**
|
4204
|
+
* @public
|
4205
|
+
*/
|
4206
|
+
export declare interface Orthographic {
|
4207
|
+
/**
|
4208
|
+
* vertical extent of the visible range in meters
|
4209
|
+
* defaults to 4m
|
4210
|
+
*/
|
4211
|
+
verticalRange?: number | undefined;
|
4212
|
+
}
|
4213
|
+
|
4214
|
+
/**
|
4215
|
+
* @public
|
4216
|
+
*/
|
4217
|
+
export declare namespace Orthographic {
|
4218
|
+
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4219
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4220
|
+
}
|
4221
|
+
|
4016
4222
|
/**
|
4017
4223
|
* @public
|
4018
4224
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4239,6 +4445,8 @@ export declare namespace PBAvatarEmoteCommand {
|
|
4239
4445
|
export declare interface PBAvatarEquippedData {
|
4240
4446
|
wearableUrns: string[];
|
4241
4447
|
emoteUrns: string[];
|
4448
|
+
/** slots that will render even if hidden */
|
4449
|
+
forceRender: string[];
|
4242
4450
|
}
|
4243
4451
|
|
4244
4452
|
/**
|
@@ -4273,6 +4481,9 @@ export declare interface PBAvatarModifierArea {
|
|
4273
4481
|
excludeIds: string[];
|
4274
4482
|
/** list of modifiers to apply */
|
4275
4483
|
modifiers: AvatarModifierType[];
|
4484
|
+
movementSettings?: AvatarMovementSettings | undefined;
|
4485
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4486
|
+
useColliderRange?: boolean | undefined;
|
4276
4487
|
}
|
4277
4488
|
|
4278
4489
|
/**
|
@@ -4329,8 +4540,8 @@ export declare interface PBAvatarShape {
|
|
4329
4540
|
wearables: string[];
|
4330
4541
|
/** available emotes (default empty) */
|
4331
4542
|
emotes: string[];
|
4332
|
-
/**
|
4333
|
-
|
4543
|
+
/** slots that will render even if hidden */
|
4544
|
+
forceRender: string[];
|
4334
4545
|
}
|
4335
4546
|
|
4336
4547
|
/**
|
@@ -4365,6 +4576,51 @@ export declare namespace PBBillboard {
|
|
4365
4576
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4366
4577
|
}
|
4367
4578
|
|
4579
|
+
/**
|
4580
|
+
* @public
|
4581
|
+
*/
|
4582
|
+
export declare interface PBCameraLayer {
|
4583
|
+
/**
|
4584
|
+
* layer to which these settings apply. must be > 0
|
4585
|
+
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4586
|
+
*/
|
4587
|
+
layer: number;
|
4588
|
+
/** should the sun light affect this layer? default false */
|
4589
|
+
directionalLight?: boolean | undefined;
|
4590
|
+
/** should this layer show player avatars? default false */
|
4591
|
+
showAvatars?: boolean | undefined;
|
4592
|
+
/** should this layer show the sky? default false */
|
4593
|
+
showSkybox?: boolean | undefined;
|
4594
|
+
/** should this layer show distance fog? default false */
|
4595
|
+
showFog?: boolean | undefined;
|
4596
|
+
/** ambient light overrides for this layer. default -> use same as main camera */
|
4597
|
+
ambientColorOverride?: PBColor3 | undefined;
|
4598
|
+
ambientBrightnessOverride?: number | undefined;
|
4599
|
+
}
|
4600
|
+
|
4601
|
+
/**
|
4602
|
+
* @public
|
4603
|
+
*/
|
4604
|
+
export declare namespace PBCameraLayer {
|
4605
|
+
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4606
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4607
|
+
}
|
4608
|
+
|
4609
|
+
/**
|
4610
|
+
* @public
|
4611
|
+
*/
|
4612
|
+
export declare interface PBCameraLayers {
|
4613
|
+
layers: number[];
|
4614
|
+
}
|
4615
|
+
|
4616
|
+
/**
|
4617
|
+
* @public
|
4618
|
+
*/
|
4619
|
+
export declare namespace PBCameraLayers {
|
4620
|
+
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4621
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4622
|
+
}
|
4623
|
+
|
4368
4624
|
/**
|
4369
4625
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4370
4626
|
* third-person view.
|
@@ -4387,7 +4643,7 @@ export declare namespace PBCameraMode {
|
|
4387
4643
|
|
4388
4644
|
/**
|
4389
4645
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4390
|
-
* the player's camera mode (1st-person
|
4646
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
4391
4647
|
*
|
4392
4648
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4393
4649
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4397,6 +4653,8 @@ export declare namespace PBCameraMode {
|
|
4397
4653
|
*
|
4398
4654
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4399
4655
|
* is actually a 3D volume.
|
4656
|
+
*
|
4657
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4400
4658
|
*/
|
4401
4659
|
/**
|
4402
4660
|
* @public
|
@@ -4406,6 +4664,9 @@ export declare interface PBCameraModeArea {
|
|
4406
4664
|
area: PBVector3 | undefined;
|
4407
4665
|
/** the camera mode to enforce */
|
4408
4666
|
mode: CameraType;
|
4667
|
+
cinematicSettings?: CinematicSettings | undefined;
|
4668
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4669
|
+
useColliderRange?: boolean | undefined;
|
4409
4670
|
}
|
4410
4671
|
|
4411
4672
|
/**
|
@@ -4477,6 +4738,39 @@ export declare namespace PBEngineInfo {
|
|
4477
4738
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4478
4739
|
}
|
4479
4740
|
|
4741
|
+
/**
|
4742
|
+
* defines the global scene light settings. must be added to the scene root.
|
4743
|
+
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4744
|
+
*/
|
4745
|
+
/**
|
4746
|
+
* @public
|
4747
|
+
*/
|
4748
|
+
export declare interface PBGlobalLight {
|
4749
|
+
/**
|
4750
|
+
* the direction the directional light shines in.
|
4751
|
+
* default depends on time of day and explorer implementation
|
4752
|
+
*/
|
4753
|
+
direction?: PBVector3 | undefined;
|
4754
|
+
/**
|
4755
|
+
* ambient light color
|
4756
|
+
* default: White
|
4757
|
+
*/
|
4758
|
+
ambientColor?: PBColor3 | undefined;
|
4759
|
+
/**
|
4760
|
+
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4761
|
+
* default 1
|
4762
|
+
*/
|
4763
|
+
ambientBrightness?: number | undefined;
|
4764
|
+
}
|
4765
|
+
|
4766
|
+
/**
|
4767
|
+
* @public
|
4768
|
+
*/
|
4769
|
+
export declare namespace PBGlobalLight {
|
4770
|
+
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4771
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4772
|
+
}
|
4773
|
+
|
4480
4774
|
/**
|
4481
4775
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4482
4776
|
*
|
@@ -4512,6 +4806,25 @@ export declare namespace PBGltfContainer {
|
|
4512
4806
|
*/
|
4513
4807
|
export declare interface PBGltfContainerLoadingState {
|
4514
4808
|
currentState: LoadingState;
|
4809
|
+
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4810
|
+
nodePaths: string[];
|
4811
|
+
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4812
|
+
meshNames: string[];
|
4813
|
+
/**
|
4814
|
+
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4815
|
+
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4816
|
+
*/
|
4817
|
+
materialNames: string[];
|
4818
|
+
/**
|
4819
|
+
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4820
|
+
* sure all your materials are explicitly named.
|
4821
|
+
*/
|
4822
|
+
skinNames: string[];
|
4823
|
+
/**
|
4824
|
+
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4825
|
+
* your skins are explicitly named.
|
4826
|
+
*/
|
4827
|
+
animationNames: string[];
|
4515
4828
|
}
|
4516
4829
|
|
4517
4830
|
/**
|
@@ -4523,48 +4836,74 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4523
4836
|
}
|
4524
4837
|
|
4525
4838
|
/**
|
4526
|
-
*
|
4839
|
+
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4840
|
+
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4841
|
+
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4842
|
+
* in the parent.
|
4843
|
+
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4844
|
+
*
|
4845
|
+
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4846
|
+
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4847
|
+
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4848
|
+
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4849
|
+
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4850
|
+
*
|
4851
|
+
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4527
4852
|
*
|
4528
|
-
*
|
4853
|
+
* From the scene, you can modify various components to alter the gltf node:
|
4854
|
+
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4855
|
+
* regardless of any intermediate gltf node hierarchy.
|
4856
|
+
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4857
|
+
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4858
|
+
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4859
|
+
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4860
|
+
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4861
|
+
* 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
|
4862
|
+
* PBMaterial will be maintained.
|
4529
4863
|
*
|
4530
|
-
*
|
4531
|
-
*
|
4532
|
-
*
|
4533
|
-
* the
|
4864
|
+
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4865
|
+
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4866
|
+
* change the state to `GNS_FAILED`.
|
4867
|
+
* - deleting the scene entity will not delete the gltf node.
|
4868
|
+
*
|
4869
|
+
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4870
|
+
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4871
|
+
* the gltf node will also be displayed.
|
4534
4872
|
*/
|
4535
4873
|
/**
|
4536
4874
|
* @public
|
4537
4875
|
*/
|
4538
|
-
export declare interface
|
4539
|
-
|
4876
|
+
export declare interface PBGltfNode {
|
4877
|
+
/** the path of the target node in the Gltf. */
|
4878
|
+
path: string;
|
4540
4879
|
}
|
4541
4880
|
|
4542
4881
|
/**
|
4543
4882
|
* @public
|
4544
4883
|
*/
|
4545
|
-
export declare namespace
|
4546
|
-
export function encode(message:
|
4547
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number):
|
4884
|
+
export declare namespace PBGltfNode {
|
4885
|
+
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4886
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4548
4887
|
}
|
4549
4888
|
|
4889
|
+
/**
|
4890
|
+
* The state of a linked gltf node.
|
4891
|
+
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4892
|
+
*/
|
4550
4893
|
/**
|
4551
4894
|
* @public
|
4552
4895
|
*/
|
4553
|
-
export declare interface
|
4554
|
-
|
4555
|
-
|
4556
|
-
/** The casting shadows enabled override */
|
4557
|
-
castShadows?: boolean | undefined;
|
4558
|
-
/** The Material that will be overridden on the target Node */
|
4559
|
-
material?: PBMaterial | undefined;
|
4896
|
+
export declare interface PBGltfNodeState {
|
4897
|
+
state: GltfNodeStateValue;
|
4898
|
+
error?: string | undefined;
|
4560
4899
|
}
|
4561
4900
|
|
4562
4901
|
/**
|
4563
4902
|
* @public
|
4564
4903
|
*/
|
4565
|
-
export declare namespace
|
4566
|
-
export function encode(message:
|
4567
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number):
|
4904
|
+
export declare namespace PBGltfNodeState {
|
4905
|
+
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4906
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4568
4907
|
}
|
4569
4908
|
|
4570
4909
|
/**
|
@@ -4702,6 +5041,14 @@ export declare interface PBMaterial {
|
|
4702
5041
|
$case: "pbr";
|
4703
5042
|
pbr: PBMaterial_PbrMaterial;
|
4704
5043
|
} | undefined;
|
5044
|
+
/**
|
5045
|
+
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
5046
|
+
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
5047
|
+
* supported by the PbMaterial.
|
5048
|
+
* If this is provided and the `material` field is not provided, the renderer will update the material
|
5049
|
+
* field with data that reflects the gltf material once it is loaded.
|
5050
|
+
*/
|
5051
|
+
gltf?: PBMaterial_GltfMaterial | undefined;
|
4705
5052
|
}
|
4706
5053
|
|
4707
5054
|
/**
|
@@ -4712,6 +5059,22 @@ export declare namespace PBMaterial {
|
|
4712
5059
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4713
5060
|
}
|
4714
5061
|
|
5062
|
+
/**
|
5063
|
+
* @public
|
5064
|
+
*/
|
5065
|
+
export declare interface PBMaterial_GltfMaterial {
|
5066
|
+
gltfSrc: string;
|
5067
|
+
name: string;
|
5068
|
+
}
|
5069
|
+
|
5070
|
+
/**
|
5071
|
+
* @public
|
5072
|
+
*/
|
5073
|
+
export declare namespace PBMaterial_GltfMaterial {
|
5074
|
+
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
5075
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
5076
|
+
}
|
5077
|
+
|
4715
5078
|
/**
|
4716
5079
|
* @public
|
4717
5080
|
*/
|
@@ -4808,6 +5171,9 @@ export declare interface PBMeshCollider {
|
|
4808
5171
|
} | {
|
4809
5172
|
$case: "plane";
|
4810
5173
|
plane: PBMeshCollider_PlaneMesh;
|
5174
|
+
} | {
|
5175
|
+
$case: "gltf";
|
5176
|
+
gltf: PBMeshCollider_GltfMesh;
|
4811
5177
|
} | undefined;
|
4812
5178
|
}
|
4813
5179
|
|
@@ -4853,6 +5219,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
4853
5219
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
4854
5220
|
}
|
4855
5221
|
|
5222
|
+
/** A collider constructed from a Gltf Mesh. */
|
5223
|
+
/**
|
5224
|
+
* @public
|
5225
|
+
*/
|
5226
|
+
export declare interface PBMeshCollider_GltfMesh {
|
5227
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
5228
|
+
gltfSrc: string;
|
5229
|
+
/** the name of the mesh asset */
|
5230
|
+
name: string;
|
5231
|
+
}
|
5232
|
+
|
5233
|
+
/**
|
5234
|
+
* @public
|
5235
|
+
*/
|
5236
|
+
export declare namespace PBMeshCollider_GltfMesh {
|
5237
|
+
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5238
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5239
|
+
}
|
5240
|
+
|
4856
5241
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
4857
5242
|
/**
|
4858
5243
|
* @public
|
@@ -4885,13 +5270,11 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
4885
5270
|
|
4886
5271
|
/**
|
4887
5272
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
4888
|
-
* plane, a sphere or a
|
5273
|
+
* plane, a sphere, a cylinder, or a Gltf mesh.
|
4889
5274
|
*
|
4890
5275
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
4891
5276
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
4892
5277
|
* `float` coordinates, one for each corner of each side of each face.
|
4893
|
-
*
|
4894
|
-
* More complex shapes require the use of a `GltfContainer` component.
|
4895
5278
|
*/
|
4896
5279
|
/**
|
4897
5280
|
* @public
|
@@ -4909,6 +5292,9 @@ export declare interface PBMeshRenderer {
|
|
4909
5292
|
} | {
|
4910
5293
|
$case: "plane";
|
4911
5294
|
plane: PBMeshRenderer_PlaneMesh;
|
5295
|
+
} | {
|
5296
|
+
$case: "gltf";
|
5297
|
+
gltf: PBMeshRenderer_GltfMesh;
|
4912
5298
|
} | undefined;
|
4913
5299
|
}
|
4914
5300
|
|
@@ -4956,6 +5342,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
4956
5342
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
4957
5343
|
}
|
4958
5344
|
|
5345
|
+
/** A mesh from a Gltf. */
|
5346
|
+
/**
|
5347
|
+
* @public
|
5348
|
+
*/
|
5349
|
+
export declare interface PBMeshRenderer_GltfMesh {
|
5350
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
5351
|
+
gltfSrc: string;
|
5352
|
+
/** the name of the mesh asset */
|
5353
|
+
name: string;
|
5354
|
+
}
|
5355
|
+
|
5356
|
+
/**
|
5357
|
+
* @public
|
5358
|
+
*/
|
5359
|
+
export declare namespace PBMeshRenderer_GltfMesh {
|
5360
|
+
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5361
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5362
|
+
}
|
5363
|
+
|
4959
5364
|
/** PlaneMesh renders a 2D rectangular shape. */
|
4960
5365
|
/**
|
4961
5366
|
* @public
|
@@ -5204,7 +5609,10 @@ export declare interface PBPrimaryPointerInfo {
|
|
5204
5609
|
screenCoordinates?: PBVector2 | undefined;
|
5205
5610
|
/** Movement since last frame (pixels) */
|
5206
5611
|
screenDelta?: PBVector2 | undefined;
|
5207
|
-
/**
|
5612
|
+
/**
|
5613
|
+
* ray direction that can be used with the primary camera origin for
|
5614
|
+
* raycasting from the cursor into the world
|
5615
|
+
*/
|
5208
5616
|
worldRayDirection?: PBVector3 | undefined;
|
5209
5617
|
}
|
5210
5618
|
|
@@ -5344,28 +5752,6 @@ export declare namespace PBRealmInfo {
|
|
5344
5752
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5345
5753
|
}
|
5346
5754
|
|
5347
|
-
/**
|
5348
|
-
* The SkyboxTime component allows controlling the time of day for the skybox,
|
5349
|
-
* affecting the lighting and appearance of the sky in the scene.
|
5350
|
-
*/
|
5351
|
-
/**
|
5352
|
-
* @public
|
5353
|
-
*/
|
5354
|
-
export declare interface PBSkyboxTime {
|
5355
|
-
/** 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 */
|
5356
|
-
fixedTime: number;
|
5357
|
-
/** default = TransitionMode.TM_FORWARD, controls the direction of time transitions */
|
5358
|
-
transitionMode?: TransitionMode | undefined;
|
5359
|
-
}
|
5360
|
-
|
5361
|
-
/**
|
5362
|
-
* @public
|
5363
|
-
*/
|
5364
|
-
export declare namespace PBSkyboxTime {
|
5365
|
-
export function encode(message: PBSkyboxTime, writer?: _m0.Writer): _m0.Writer;
|
5366
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
|
5367
|
-
}
|
5368
|
-
|
5369
5755
|
/**
|
5370
5756
|
* The TextShape component renders customizable floating text.
|
5371
5757
|
*
|
@@ -5430,6 +5816,46 @@ export declare namespace PBTextShape {
|
|
5430
5816
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5431
5817
|
}
|
5432
5818
|
|
5819
|
+
/**
|
5820
|
+
* @public
|
5821
|
+
*/
|
5822
|
+
export declare interface PBTextureCamera {
|
5823
|
+
/** rendered texture width */
|
5824
|
+
width?: number | undefined;
|
5825
|
+
/** rendered texture height */
|
5826
|
+
height?: number | undefined;
|
5827
|
+
/**
|
5828
|
+
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5829
|
+
* defaults to 0
|
5830
|
+
*/
|
5831
|
+
layer?: number | undefined;
|
5832
|
+
/** default black */
|
5833
|
+
clearColor?: PBColor4 | undefined;
|
5834
|
+
/** default infinity */
|
5835
|
+
farPlane?: number | undefined;
|
5836
|
+
mode?: {
|
5837
|
+
$case: "perspective";
|
5838
|
+
perspective: Perspective;
|
5839
|
+
} | {
|
5840
|
+
$case: "orthographic";
|
5841
|
+
orthographic: Orthographic;
|
5842
|
+
} | undefined;
|
5843
|
+
/**
|
5844
|
+
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
5845
|
+
* range: 0 (off) - 1 (full volume)
|
5846
|
+
* default: 0
|
5847
|
+
*/
|
5848
|
+
volume?: number | undefined;
|
5849
|
+
}
|
5850
|
+
|
5851
|
+
/**
|
5852
|
+
* @public
|
5853
|
+
*/
|
5854
|
+
export declare namespace PBTextureCamera {
|
5855
|
+
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5856
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5857
|
+
}
|
5858
|
+
|
5433
5859
|
/**
|
5434
5860
|
* @public
|
5435
5861
|
*/
|
@@ -5519,6 +5945,25 @@ export declare namespace PBUiBackground {
|
|
5519
5945
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5520
5946
|
}
|
5521
5947
|
|
5948
|
+
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5949
|
+
/**
|
5950
|
+
* @public
|
5951
|
+
*/
|
5952
|
+
export declare interface PBUiCanvas {
|
5953
|
+
width: number;
|
5954
|
+
height: number;
|
5955
|
+
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5956
|
+
color?: PBColor4 | undefined;
|
5957
|
+
}
|
5958
|
+
|
5959
|
+
/**
|
5960
|
+
* @public
|
5961
|
+
*/
|
5962
|
+
export declare namespace PBUiCanvas {
|
5963
|
+
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5964
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5965
|
+
}
|
5966
|
+
|
5522
5967
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5523
5968
|
/**
|
5524
5969
|
* @public
|
@@ -5635,6 +6080,21 @@ export declare namespace PBUiInputResult {
|
|
5635
6080
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5636
6081
|
}
|
5637
6082
|
|
6083
|
+
/**
|
6084
|
+
* @public
|
6085
|
+
*/
|
6086
|
+
export declare interface PBUiScrollResult {
|
6087
|
+
value: PBVector2 | undefined;
|
6088
|
+
}
|
6089
|
+
|
6090
|
+
/**
|
6091
|
+
* @public
|
6092
|
+
*/
|
6093
|
+
export declare namespace PBUiScrollResult {
|
6094
|
+
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
6095
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
6096
|
+
}
|
6097
|
+
|
5638
6098
|
/**
|
5639
6099
|
* @public
|
5640
6100
|
*/
|
@@ -5651,6 +6111,10 @@ export declare interface PBUiText {
|
|
5651
6111
|
fontSize?: number | undefined;
|
5652
6112
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
5653
6113
|
textWrap?: TextWrap | undefined;
|
6114
|
+
/** width of the outline (default: 0) */
|
6115
|
+
outlineWidth?: number | undefined;
|
6116
|
+
/** RGBA color of the outline (default: opaque black) */
|
6117
|
+
outlineColor?: PBColor4 | undefined;
|
5654
6118
|
}
|
5655
6119
|
|
5656
6120
|
/**
|
@@ -5778,6 +6242,12 @@ export declare interface PBUiTransform {
|
|
5778
6242
|
borderRightColor?: PBColor4 | undefined;
|
5779
6243
|
/** default: 1 */
|
5780
6244
|
opacity?: number | undefined;
|
6245
|
+
/** reference for scroll_position. default empty */
|
6246
|
+
elementId?: string | undefined;
|
6247
|
+
/** default position=(0,0) */
|
6248
|
+
scrollPosition?: ScrollPositionValue | undefined;
|
6249
|
+
/** default ShowScrollBar.SSB_BOTH */
|
6250
|
+
scrollVisible?: ShowScrollBar | undefined;
|
5781
6251
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
5782
6252
|
zIndex?: number | undefined;
|
5783
6253
|
}
|
@@ -5909,6 +6379,25 @@ export declare namespace PBVisibilityComponent {
|
|
5909
6379
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
5910
6380
|
}
|
5911
6381
|
|
6382
|
+
/**
|
6383
|
+
* @public
|
6384
|
+
*/
|
6385
|
+
export declare interface Perspective {
|
6386
|
+
/**
|
6387
|
+
* vertical field of view in radians
|
6388
|
+
* defaults to pi/4 = 45 degrees
|
6389
|
+
*/
|
6390
|
+
fieldOfView?: number | undefined;
|
6391
|
+
}
|
6392
|
+
|
6393
|
+
/**
|
6394
|
+
* @public
|
6395
|
+
*/
|
6396
|
+
export declare namespace Perspective {
|
6397
|
+
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6398
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6399
|
+
}
|
6400
|
+
|
5912
6401
|
/**
|
5913
6402
|
* Represens a plane by the equation ax + by + cz + d = 0
|
5914
6403
|
* @public
|
@@ -6064,11 +6553,37 @@ export declare interface PointerEventsSystem {
|
|
6064
6553
|
* @param entity - Entity where the callback was attached
|
6065
6554
|
*/
|
6066
6555
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6556
|
+
/**
|
6557
|
+
* @public
|
6558
|
+
* Remove the callback for onPointerDrag event
|
6559
|
+
* @param entity - Entity where the callback was attached
|
6560
|
+
*/
|
6561
|
+
removeOnPointerDrag(entity: Entity): void;
|
6562
|
+
/**
|
6563
|
+
* @public
|
6564
|
+
* Remove the callback for onPointerDragLocked event
|
6565
|
+
* @param entity - Entity where the callback was attached
|
6566
|
+
*/
|
6567
|
+
removeOnPointerDragLocked(entity: Entity): void;
|
6568
|
+
/**
|
6569
|
+
* @public
|
6570
|
+
* Remove the callback for onPointerDragEnd event
|
6571
|
+
* @param entity - Entity where the callback was attached
|
6572
|
+
*/
|
6573
|
+
removeOnPointerDragEnd(entity: Entity): void;
|
6574
|
+
/**
|
6575
|
+
* @public
|
6576
|
+
* Execute callbacks when the user presses one of the InputButtons pointing at the entity
|
6577
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6578
|
+
*/
|
6579
|
+
onPointerDown(pointerData: {
|
6580
|
+
entity: Entity;
|
6581
|
+
optsList: EventSystemOptionsCallback[];
|
6582
|
+
}): void;
|
6067
6583
|
/**
|
6068
6584
|
* @public
|
6069
6585
|
* Execute callback when the user press the InputButton pointing at the entity
|
6070
6586
|
* @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
|
6071
|
-
* @param cb - Function to execute when click fires
|
6072
6587
|
*/
|
6073
6588
|
onPointerDown(pointerData: {
|
6074
6589
|
entity: Entity;
|
@@ -6081,6 +6596,15 @@ export declare interface PointerEventsSystem {
|
|
6081
6596
|
* @param opts - Opts to trigger Feedback and Button
|
6082
6597
|
*/
|
6083
6598
|
onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
|
6599
|
+
/**
|
6600
|
+
* @public
|
6601
|
+
* Execute callbacks when the user releases one of the InputButtons pointing at the entity
|
6602
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6603
|
+
*/
|
6604
|
+
onPointerUp(pointerData: {
|
6605
|
+
entity: Entity;
|
6606
|
+
optsList: EventSystemOptionsCallback[];
|
6607
|
+
}): void;
|
6084
6608
|
/**
|
6085
6609
|
* @public
|
6086
6610
|
* Execute callback when the user releases the InputButton pointing at the entity
|
@@ -6118,6 +6642,64 @@ export declare interface PointerEventsSystem {
|
|
6118
6642
|
entity: Entity;
|
6119
6643
|
opts?: Partial<EventSystemOptions>;
|
6120
6644
|
}, cb: EventSystemCallback): void;
|
6645
|
+
/**
|
6646
|
+
* @public
|
6647
|
+
* Execute callbacks when the user drags the pointer from inside the entity
|
6648
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6649
|
+
*/
|
6650
|
+
onPointerDrag(pointerData: {
|
6651
|
+
entity: Entity;
|
6652
|
+
optsList: EventSystemOptionsCallback[];
|
6653
|
+
}): void;
|
6654
|
+
/**
|
6655
|
+
* @public
|
6656
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6657
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6658
|
+
* @param cb - Function to execute when click fires
|
6659
|
+
*/
|
6660
|
+
onPointerDrag(pointerData: {
|
6661
|
+
entity: Entity;
|
6662
|
+
opts?: Partial<EventSystemOptions>;
|
6663
|
+
}, cb: EventSystemCallback): void;
|
6664
|
+
/**
|
6665
|
+
* @public
|
6666
|
+
* Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
|
6667
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6668
|
+
*/
|
6669
|
+
onPointerDragLocked(pointerData: {
|
6670
|
+
entity: Entity;
|
6671
|
+
optsList: EventSystemOptionsCallback[];
|
6672
|
+
}): void;
|
6673
|
+
/**
|
6674
|
+
* @public
|
6675
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6676
|
+
* locking the cursor in place
|
6677
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6678
|
+
* @param cb - Function to execute when click fires
|
6679
|
+
*/
|
6680
|
+
onPointerDragLocked(pointerData: {
|
6681
|
+
entity: Entity;
|
6682
|
+
opts?: Partial<EventSystemOptions>;
|
6683
|
+
}, cb: EventSystemCallback): void;
|
6684
|
+
/**
|
6685
|
+
* @public
|
6686
|
+
* Execute callbacks when the user releases a button after a drag
|
6687
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
6688
|
+
*/
|
6689
|
+
onPointerDragEnd(pointerData: {
|
6690
|
+
entity: Entity;
|
6691
|
+
optsList: EventSystemOptionsCallback[];
|
6692
|
+
}): void;
|
6693
|
+
/**
|
6694
|
+
* @public
|
6695
|
+
* Execute callback when the user releases the button after a drag
|
6696
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6697
|
+
* @param cb - Function to execute when click fires
|
6698
|
+
*/
|
6699
|
+
onPointerDragEnd(pointerData: {
|
6700
|
+
entity: Entity;
|
6701
|
+
opts?: Partial<EventSystemOptions>;
|
6702
|
+
}, cb: EventSystemCallback): void;
|
6121
6703
|
}
|
6122
6704
|
|
6123
6705
|
/**
|
@@ -6134,7 +6716,10 @@ export declare const enum PointerEventType {
|
|
6134
6716
|
PET_UP = 0,
|
6135
6717
|
PET_DOWN = 1,
|
6136
6718
|
PET_HOVER_ENTER = 2,
|
6137
|
-
PET_HOVER_LEAVE = 3
|
6719
|
+
PET_HOVER_LEAVE = 3,
|
6720
|
+
PET_DRAG_LOCKED = 4,
|
6721
|
+
PET_DRAG = 5,
|
6722
|
+
PET_DRAG_END = 6
|
6138
6723
|
}
|
6139
6724
|
|
6140
6725
|
/**
|
@@ -6165,7 +6750,10 @@ export declare const enum PointerType {
|
|
6165
6750
|
/** POT_NONE - No pointer input */
|
6166
6751
|
POT_NONE = 0,
|
6167
6752
|
/** POT_MOUSE - Traditional mouse input */
|
6168
|
-
POT_MOUSE = 1
|
6753
|
+
POT_MOUSE = 1,
|
6754
|
+
POT_PAD = 2,
|
6755
|
+
POT_TOUCH = 3,
|
6756
|
+
POT_WAND = 4
|
6169
6757
|
}
|
6170
6758
|
|
6171
6759
|
/**
|
@@ -6762,6 +7350,7 @@ export declare type RaycastSystemOptions = {
|
|
6762
7350
|
export declare interface ReactBasedUiSystem {
|
6763
7351
|
destroy(): void;
|
6764
7352
|
setUiRenderer(ui: UiComponent): void;
|
7353
|
+
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
6765
7354
|
}
|
6766
7355
|
|
6767
7356
|
/**
|
@@ -7224,8 +7813,42 @@ export declare namespace Schemas {
|
|
7224
7813
|
}) => void;
|
7225
7814
|
}
|
7226
7815
|
|
7227
|
-
/**
|
7228
|
-
|
7816
|
+
/**
|
7817
|
+
* @public
|
7818
|
+
*/
|
7819
|
+
export declare interface ScrollPositionValue {
|
7820
|
+
value?: {
|
7821
|
+
$case: "position";
|
7822
|
+
position: PBVector2;
|
7823
|
+
} | {
|
7824
|
+
$case: "reference";
|
7825
|
+
reference: string;
|
7826
|
+
} | undefined;
|
7827
|
+
}
|
7828
|
+
|
7829
|
+
/**
|
7830
|
+
* @public
|
7831
|
+
*/
|
7832
|
+
export declare namespace ScrollPositionValue {
|
7833
|
+
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7834
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7835
|
+
}
|
7836
|
+
|
7837
|
+
/**
|
7838
|
+
* @public
|
7839
|
+
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7840
|
+
*/
|
7841
|
+
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7842
|
+
|
7843
|
+
/**
|
7844
|
+
* @public
|
7845
|
+
*/
|
7846
|
+
export declare const enum ShowScrollBar {
|
7847
|
+
SSB_BOTH = 0,
|
7848
|
+
SSB_ONLY_VERTICAL = 1,
|
7849
|
+
SSB_ONLY_HORIZONTAL = 2,
|
7850
|
+
SSB_HIDDEN = 3
|
7851
|
+
}
|
7229
7852
|
|
7230
7853
|
/**
|
7231
7854
|
* @public
|
@@ -7308,6 +7931,9 @@ export declare namespace Texture {
|
|
7308
7931
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7309
7932
|
}
|
7310
7933
|
|
7934
|
+
/** @public */
|
7935
|
+
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7936
|
+
|
7311
7937
|
/**
|
7312
7938
|
* @public
|
7313
7939
|
*/
|
@@ -7400,6 +8026,9 @@ export declare interface TextureUnion {
|
|
7400
8026
|
} | {
|
7401
8027
|
$case: "videoTexture";
|
7402
8028
|
videoTexture: VideoTexture;
|
8029
|
+
} | {
|
8030
|
+
$case: "uiTexture";
|
8031
|
+
uiTexture: UiCanvasTexture;
|
7403
8032
|
} | undefined;
|
7404
8033
|
}
|
7405
8034
|
|
@@ -7493,17 +8122,6 @@ export declare type TransformType = {
|
|
7493
8122
|
*/
|
7494
8123
|
export declare type TransformTypeWithOptionals = Partial<TransformType>;
|
7495
8124
|
|
7496
|
-
/** Controls the direction for animated skybox transitions */
|
7497
|
-
/**
|
7498
|
-
* @public
|
7499
|
-
*/
|
7500
|
-
export declare const enum TransitionMode {
|
7501
|
-
/** TM_FORWARD - transitions forward (default) */
|
7502
|
-
TM_FORWARD = 0,
|
7503
|
-
/** TM_BACKWARD - transitions backward */
|
7504
|
-
TM_BACKWARD = 1
|
7505
|
-
}
|
7506
|
-
|
7507
8125
|
/**
|
7508
8126
|
* @public
|
7509
8127
|
*/
|
@@ -7618,6 +8236,8 @@ export declare interface UiBackgroundProps {
|
|
7618
8236
|
uvs?: number[];
|
7619
8237
|
/** AvatarTexture for the background */
|
7620
8238
|
avatarTexture?: UiAvatarTexture;
|
8239
|
+
/** VideoTexture for the background */
|
8240
|
+
videoTexture?: UiVideoTexture;
|
7621
8241
|
/** Texture for the background */
|
7622
8242
|
texture?: UiTexture;
|
7623
8243
|
}
|
@@ -7637,9 +8257,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
7637
8257
|
disabled?: boolean;
|
7638
8258
|
}
|
7639
8259
|
|
8260
|
+
/** @public */
|
8261
|
+
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8262
|
+
|
7640
8263
|
/** @public */
|
7641
8264
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
7642
8265
|
|
8266
|
+
/**
|
8267
|
+
* @public
|
8268
|
+
*/
|
8269
|
+
export declare interface UiCanvasTexture {
|
8270
|
+
uiCanvasEntity: number;
|
8271
|
+
/** default = TextureWrapMode.Clamp */
|
8272
|
+
wrapMode?: TextureWrapMode | undefined;
|
8273
|
+
/** default = FilterMode.Bilinear */
|
8274
|
+
filterMode?: TextureFilterMode | undefined;
|
8275
|
+
}
|
8276
|
+
|
8277
|
+
/**
|
8278
|
+
* @public
|
8279
|
+
*/
|
8280
|
+
export declare namespace UiCanvasTexture {
|
8281
|
+
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8282
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8283
|
+
}
|
8284
|
+
|
7643
8285
|
/**
|
7644
8286
|
* @public
|
7645
8287
|
*/
|
@@ -7709,6 +8351,10 @@ export declare interface UiLabelProps {
|
|
7709
8351
|
textAlign?: TextAlignType | undefined;
|
7710
8352
|
/** Label font type. @defaultValue 'sans-serif' */
|
7711
8353
|
font?: UiFontType | undefined;
|
8354
|
+
/** Outline width of the text. @defaultValue 0 */
|
8355
|
+
outlineWidth?: number | undefined;
|
8356
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8357
|
+
outlineColor?: PBColor4 | undefined;
|
7712
8358
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
7713
8359
|
textWrap?: UiTextWrapType | undefined;
|
7714
8360
|
}
|
@@ -7718,6 +8364,9 @@ export declare interface UiLabelProps {
|
|
7718
8364
|
*/
|
7719
8365
|
export declare type uint32 = number;
|
7720
8366
|
|
8367
|
+
/** @public */
|
8368
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8369
|
+
|
7721
8370
|
/** @public */
|
7722
8371
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
7723
8372
|
|
@@ -7795,10 +8444,26 @@ export declare interface UiTransformProps {
|
|
7795
8444
|
borderWidth?: Partial<Position> | PositionUnit;
|
7796
8445
|
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
7797
8446
|
opacity?: number;
|
8447
|
+
/** A reference value to identify the element, default empty */
|
8448
|
+
elementId?: string;
|
8449
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8450
|
+
scrollPosition?: PBVector2 | string;
|
8451
|
+
/** default ShowScrollBar.SSB_BOTH */
|
8452
|
+
scrollVisible?: ScrollVisibleType;
|
7798
8453
|
/** default 0 */
|
7799
8454
|
zIndex?: number;
|
7800
8455
|
}
|
7801
8456
|
|
8457
|
+
/**
|
8458
|
+
* Texture
|
8459
|
+
* @public
|
8460
|
+
*/
|
8461
|
+
export declare interface UiVideoTexture {
|
8462
|
+
videoPlayerEntity: Entity;
|
8463
|
+
wrapMode?: TextureWrapType;
|
8464
|
+
filterMode?: TextureFilterType;
|
8465
|
+
}
|
8466
|
+
|
7802
8467
|
/**
|
7803
8468
|
* @public
|
7804
8469
|
*/
|