@dcl/playground-assets 7.13.0 → 7.13.1-19516109426.commit-e1e79aa
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 +774 -19
- package/dist/beta.d.ts +774 -19
- package/dist/index.bundled.d.ts +774 -19
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/apis.d.ts +17 -0
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +774 -19
- package/etc/playground-assets.api.json +11697 -4214
- package/etc/playground-assets.api.md +513 -10
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -178,12 +178,33 @@ 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
196
|
/** @public */
|
|
185
197
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
186
198
|
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
|
|
203
|
+
|
|
204
|
+
export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
|
|
205
|
+
forceRender?: string[] | undefined;
|
|
206
|
+
};
|
|
207
|
+
|
|
187
208
|
/** @public */
|
|
188
209
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
189
210
|
|
|
@@ -198,9 +219,49 @@ export declare const enum AvatarModifierType {
|
|
|
198
219
|
AMT_DISABLE_PASSPORTS = 1
|
|
199
220
|
}
|
|
200
221
|
|
|
222
|
+
/**
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
export declare interface AvatarMovementSettings {
|
|
226
|
+
controlMode?: AvatarControlType | undefined;
|
|
227
|
+
/** if not explicitly set, the following properties default to user's preference settings */
|
|
228
|
+
runSpeed?: number | undefined;
|
|
229
|
+
/** how fast the player gets up to speed or comes to rest. higher = more responsive */
|
|
230
|
+
friction?: number | undefined;
|
|
231
|
+
/** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
|
|
232
|
+
gravity?: number | undefined;
|
|
233
|
+
/** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
|
|
234
|
+
jumpHeight?: number | undefined;
|
|
235
|
+
/** max fall speed in m/s. should normally be negative */
|
|
236
|
+
maxFallSpeed?: number | undefined;
|
|
237
|
+
/** speed the player turns in tank mode, in radians/s */
|
|
238
|
+
turnSpeed?: number | undefined;
|
|
239
|
+
/** speed the player walks at, in m/s */
|
|
240
|
+
walkSpeed?: number | undefined;
|
|
241
|
+
/** 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 */
|
|
242
|
+
allowWeightedMovement?: boolean | undefined;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
export declare namespace AvatarMovementSettings {
|
|
249
|
+
export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
|
|
250
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
|
251
|
+
}
|
|
252
|
+
|
|
201
253
|
/** @public */
|
|
202
254
|
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
|
203
255
|
|
|
256
|
+
/**
|
|
257
|
+
* @public
|
|
258
|
+
*/
|
|
259
|
+
export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
|
|
260
|
+
|
|
261
|
+
export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
|
|
262
|
+
forceRender?: string[] | undefined;
|
|
263
|
+
};
|
|
264
|
+
|
|
204
265
|
/**
|
|
205
266
|
* @public
|
|
206
267
|
*/
|
|
@@ -468,11 +529,19 @@ export declare interface ByteBuffer {
|
|
|
468
529
|
}
|
|
469
530
|
|
|
470
531
|
/**
|
|
471
|
-
* Callback function
|
|
472
|
-
*
|
|
532
|
+
* legacy Callback function
|
|
533
|
+
*
|
|
534
|
+
* @public @deprecated This type is no longer used in the sdk api, EventSystemCallback is
|
|
535
|
+
* used for listeners instead
|
|
473
536
|
*/
|
|
474
537
|
export declare type Callback = () => void;
|
|
475
538
|
|
|
539
|
+
/** @public */
|
|
540
|
+
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
|
541
|
+
|
|
542
|
+
/** @public */
|
|
543
|
+
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
|
544
|
+
|
|
476
545
|
/** @public */
|
|
477
546
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
|
478
547
|
|
|
@@ -530,6 +599,39 @@ export declare const enum CameraType {
|
|
|
530
599
|
|
|
531
600
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
|
532
601
|
|
|
602
|
+
/**
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
export declare interface CinematicSettings {
|
|
606
|
+
/** Entity that defines the cinematic camera transform. */
|
|
607
|
+
cameraEntity: number;
|
|
608
|
+
/**
|
|
609
|
+
* Position -> camera's position
|
|
610
|
+
* Rotation -> camera's direction
|
|
611
|
+
* scale.z -> zoom level
|
|
612
|
+
* scale.x and scale.y -> unused
|
|
613
|
+
*/
|
|
614
|
+
allowManualRotation?: boolean | undefined;
|
|
615
|
+
/** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
|
|
616
|
+
yawRange?: number | undefined;
|
|
617
|
+
/** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
|
|
618
|
+
pitchRange?: number | undefined;
|
|
619
|
+
/** note: cameras can never look up/down further than Vec3::Y */
|
|
620
|
+
rollRange?: number | undefined;
|
|
621
|
+
/** minimum zoom level. must be greater than 0. defaults to the input zoom level */
|
|
622
|
+
zoomMin?: number | undefined;
|
|
623
|
+
/** maximum zoom level. must be greater than 0. defaults to the input zoom level */
|
|
624
|
+
zoomMax?: number | undefined;
|
|
625
|
+
}
|
|
626
|
+
|
|
627
|
+
/**
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
export declare namespace CinematicSettings {
|
|
631
|
+
export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
|
|
632
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
|
|
633
|
+
}
|
|
634
|
+
|
|
533
635
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
|
534
636
|
/**
|
|
535
637
|
* @public
|
|
@@ -1304,12 +1406,17 @@ export declare const componentDefinitionByName: {
|
|
|
1304
1406
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1305
1407
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1306
1408
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
1409
|
+
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
|
1410
|
+
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
|
1307
1411
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
|
1308
1412
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
|
1309
1413
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
|
1414
|
+
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
|
1310
1415
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
|
1311
1416
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
|
1417
|
+
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
|
1312
1418
|
"core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
|
|
1419
|
+
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
|
1313
1420
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
|
1314
1421
|
"core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
|
|
1315
1422
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
|
@@ -1327,17 +1434,20 @@ export declare const componentDefinitionByName: {
|
|
|
1327
1434
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1328
1435
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1329
1436
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1437
|
+
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
|
1330
1438
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1331
1439
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
1332
1440
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
|
1333
1441
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
|
1334
1442
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
|
1335
1443
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
|
1444
|
+
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
|
1336
1445
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
|
1337
1446
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1338
1447
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1339
1448
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1340
1449
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1450
|
+
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
|
1341
1451
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1342
1452
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
1343
1453
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
|
@@ -1904,10 +2014,18 @@ export declare type EntityComponents = {
|
|
|
1904
2014
|
uiBackground: PBUiBackground;
|
|
1905
2015
|
uiInput: PBUiInput;
|
|
1906
2016
|
uiDropdown: PBUiDropdown;
|
|
1907
|
-
onMouseDown:
|
|
1908
|
-
onMouseUp:
|
|
1909
|
-
onMouseEnter:
|
|
1910
|
-
onMouseLeave:
|
|
2017
|
+
onMouseDown: EventSystemCallback;
|
|
2018
|
+
onMouseUp: EventSystemCallback;
|
|
2019
|
+
onMouseEnter: EventSystemCallback;
|
|
2020
|
+
onMouseLeave: EventSystemCallback;
|
|
2021
|
+
onMouseDrag: EventSystemCallback;
|
|
2022
|
+
onMouseDragLocked: EventSystemCallback;
|
|
2023
|
+
onMouseDragEnd: EventSystemCallback;
|
|
2024
|
+
onInputDown: MultiCallback;
|
|
2025
|
+
onInputUp: MultiCallback;
|
|
2026
|
+
onInputDrag: MultiCallback;
|
|
2027
|
+
onInputDragLocked: MultiCallback;
|
|
2028
|
+
onInputDragEnd: MultiCallback;
|
|
1911
2029
|
};
|
|
1912
2030
|
|
|
1913
2031
|
/** @public */
|
|
@@ -1985,6 +2103,13 @@ export declare type EventSystemOptions = {
|
|
|
1985
2103
|
showHighlight?: boolean;
|
|
1986
2104
|
};
|
|
1987
2105
|
|
|
2106
|
+
/**
|
|
2107
|
+
* @public
|
|
2108
|
+
*/
|
|
2109
|
+
export declare type EventSystemOptionsCallback = EventSystemOptions & {
|
|
2110
|
+
cb: EventSystemCallback;
|
|
2111
|
+
};
|
|
2112
|
+
|
|
1988
2113
|
/**
|
|
1989
2114
|
* Excludes property keys from T where the property is assignable to U
|
|
1990
2115
|
* @public
|
|
@@ -2059,6 +2184,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
|
2059
2184
|
direction?: PBVector3;
|
|
2060
2185
|
};
|
|
2061
2186
|
|
|
2187
|
+
/** @public */
|
|
2188
|
+
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
|
2189
|
+
|
|
2062
2190
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
|
2063
2191
|
|
|
2064
2192
|
export declare type GlobalTargetRaycastSystemOptions = {
|
|
@@ -2071,9 +2199,24 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
|
2071
2199
|
/** @public */
|
|
2072
2200
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
|
2073
2201
|
|
|
2202
|
+
/** @public */
|
|
2203
|
+
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
|
2204
|
+
|
|
2074
2205
|
/** @public */
|
|
2075
2206
|
export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
|
|
2076
2207
|
|
|
2208
|
+
/** @public */
|
|
2209
|
+
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
|
2210
|
+
|
|
2211
|
+
/**
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
export declare const enum GltfNodeStateValue {
|
|
2215
|
+
GNSV_PENDING = 0,
|
|
2216
|
+
GNSV_FAILED = 1,
|
|
2217
|
+
GNSV_READY = 2
|
|
2218
|
+
}
|
|
2219
|
+
|
|
2077
2220
|
/**
|
|
2078
2221
|
* @public
|
|
2079
2222
|
*/
|
|
@@ -2428,6 +2571,12 @@ export declare type IInputSystem = {
|
|
|
2428
2571
|
* @returns the input command info or undefined if there is no command in the last tick-update
|
|
2429
2572
|
*/
|
|
2430
2573
|
getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
|
|
2574
|
+
/**
|
|
2575
|
+
* @public
|
|
2576
|
+
* Get an ordered iterator over events received within the current frame.
|
|
2577
|
+
* @returns the iterator
|
|
2578
|
+
*/
|
|
2579
|
+
getInputCommands: () => Generator<PBPointerEventsResult>;
|
|
2431
2580
|
};
|
|
2432
2581
|
|
|
2433
2582
|
/**
|
|
@@ -2723,13 +2872,29 @@ export declare interface LightSourceHelper {
|
|
|
2723
2872
|
*/
|
|
2724
2873
|
export declare type Listeners = {
|
|
2725
2874
|
/** triggered on mouse down event */
|
|
2726
|
-
onMouseDown?:
|
|
2875
|
+
onMouseDown?: EventSystemCallback;
|
|
2727
2876
|
/** triggered on mouse up event */
|
|
2728
|
-
onMouseUp?:
|
|
2877
|
+
onMouseUp?: EventSystemCallback;
|
|
2729
2878
|
/** triggered on mouse hover event */
|
|
2730
|
-
onMouseEnter?:
|
|
2879
|
+
onMouseEnter?: EventSystemCallback;
|
|
2731
2880
|
/** triggered on mouse leave event */
|
|
2732
|
-
onMouseLeave?:
|
|
2881
|
+
onMouseLeave?: EventSystemCallback;
|
|
2882
|
+
/** triggered on mouse drag event */
|
|
2883
|
+
onMouseDrag?: EventSystemCallback;
|
|
2884
|
+
/** triggered on mouse drag event */
|
|
2885
|
+
onMouseDragLocked?: EventSystemCallback;
|
|
2886
|
+
/** triggered on mouse drag event */
|
|
2887
|
+
onMouseDragEnd?: EventSystemCallback;
|
|
2888
|
+
/** triggered on input down event */
|
|
2889
|
+
onInputDown?: MultiCallback;
|
|
2890
|
+
/** triggered on input up event */
|
|
2891
|
+
onInputUp?: MultiCallback;
|
|
2892
|
+
/** triggered on input drag event */
|
|
2893
|
+
onInputDrag?: MultiCallback;
|
|
2894
|
+
/** triggered on input drag event */
|
|
2895
|
+
onInputDragLocked?: MultiCallback;
|
|
2896
|
+
/** triggered on input drag event */
|
|
2897
|
+
onInputDragEnd?: MultiCallback;
|
|
2733
2898
|
};
|
|
2734
2899
|
|
|
2735
2900
|
/**
|
|
@@ -3598,6 +3763,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
3598
3763
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
3599
3764
|
*/
|
|
3600
3765
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
3766
|
+
/**
|
|
3767
|
+
* @public
|
|
3768
|
+
* Set a gltf internal mesh in the MeshCollider component
|
|
3769
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
|
3770
|
+
* @param source - the path to the gltf
|
|
3771
|
+
* @param meshName - the name of the mesh in the gltf
|
|
3772
|
+
*/
|
|
3773
|
+
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
3601
3774
|
}
|
|
3602
3775
|
|
|
3603
3776
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -3634,6 +3807,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
3634
3807
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
3635
3808
|
*/
|
|
3636
3809
|
setSphere(entity: Entity): void;
|
|
3810
|
+
/**
|
|
3811
|
+
* @public
|
|
3812
|
+
* Set a gltf internal mesh in the MeshRenderer component
|
|
3813
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
|
3814
|
+
* @param source - the path to the gltf
|
|
3815
|
+
* @param meshName - the name of the mesh in the gltf
|
|
3816
|
+
*/
|
|
3817
|
+
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
3637
3818
|
}
|
|
3638
3819
|
|
|
3639
3820
|
/**
|
|
@@ -3682,6 +3863,19 @@ export declare namespace MoveContinuous {
|
|
|
3682
3863
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
3683
3864
|
}
|
|
3684
3865
|
|
|
3866
|
+
/**
|
|
3867
|
+
* a record object mapping `InputAction`s to functions.
|
|
3868
|
+
*
|
|
3869
|
+
* @example
|
|
3870
|
+
* onInputDown={{
|
|
3871
|
+
* [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
|
|
3872
|
+
* [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
|
|
3873
|
+
* }}
|
|
3874
|
+
*
|
|
3875
|
+
* @public
|
|
3876
|
+
*/
|
|
3877
|
+
export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
|
|
3878
|
+
|
|
3685
3879
|
export declare const Name: NameComponent;
|
|
3686
3880
|
|
|
3687
3881
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4062,6 +4256,25 @@ export declare const onVideoEvent: Observable<{
|
|
|
4062
4256
|
totalVideoLength: number;
|
|
4063
4257
|
}>;
|
|
4064
4258
|
|
|
4259
|
+
/**
|
|
4260
|
+
* @public
|
|
4261
|
+
*/
|
|
4262
|
+
export declare interface Orthographic {
|
|
4263
|
+
/**
|
|
4264
|
+
* vertical extent of the visible range in meters
|
|
4265
|
+
* defaults to 4m
|
|
4266
|
+
*/
|
|
4267
|
+
verticalRange?: number | undefined;
|
|
4268
|
+
}
|
|
4269
|
+
|
|
4270
|
+
/**
|
|
4271
|
+
* @public
|
|
4272
|
+
*/
|
|
4273
|
+
export declare namespace Orthographic {
|
|
4274
|
+
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4275
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4276
|
+
}
|
|
4277
|
+
|
|
4065
4278
|
/**
|
|
4066
4279
|
* @public
|
|
4067
4280
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -4288,6 +4501,8 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
4288
4501
|
export declare interface PBAvatarEquippedData {
|
|
4289
4502
|
wearableUrns: string[];
|
|
4290
4503
|
emoteUrns: string[];
|
|
4504
|
+
/** slots that will render even if hidden */
|
|
4505
|
+
forceRender: string[];
|
|
4291
4506
|
}
|
|
4292
4507
|
|
|
4293
4508
|
/**
|
|
@@ -4322,6 +4537,9 @@ export declare interface PBAvatarModifierArea {
|
|
|
4322
4537
|
excludeIds: string[];
|
|
4323
4538
|
/** list of modifiers to apply */
|
|
4324
4539
|
modifiers: AvatarModifierType[];
|
|
4540
|
+
movementSettings?: AvatarMovementSettings | undefined;
|
|
4541
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
4542
|
+
useColliderRange?: boolean | undefined;
|
|
4325
4543
|
}
|
|
4326
4544
|
|
|
4327
4545
|
/**
|
|
@@ -4380,6 +4598,8 @@ export declare interface PBAvatarShape {
|
|
|
4380
4598
|
emotes: string[];
|
|
4381
4599
|
/** hides the skin + hair + facial features (default: false) */
|
|
4382
4600
|
showOnlyWearables?: boolean | undefined;
|
|
4601
|
+
/** slots that will render even if hidden */
|
|
4602
|
+
forceRender: string[];
|
|
4383
4603
|
}
|
|
4384
4604
|
|
|
4385
4605
|
/**
|
|
@@ -4414,6 +4634,51 @@ export declare namespace PBBillboard {
|
|
|
4414
4634
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
4415
4635
|
}
|
|
4416
4636
|
|
|
4637
|
+
/**
|
|
4638
|
+
* @public
|
|
4639
|
+
*/
|
|
4640
|
+
export declare interface PBCameraLayer {
|
|
4641
|
+
/**
|
|
4642
|
+
* layer to which these settings apply. must be > 0
|
|
4643
|
+
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
4644
|
+
*/
|
|
4645
|
+
layer: number;
|
|
4646
|
+
/** should the sun light affect this layer? default false */
|
|
4647
|
+
directionalLight?: boolean | undefined;
|
|
4648
|
+
/** should this layer show player avatars? default false */
|
|
4649
|
+
showAvatars?: boolean | undefined;
|
|
4650
|
+
/** should this layer show the sky? default false */
|
|
4651
|
+
showSkybox?: boolean | undefined;
|
|
4652
|
+
/** should this layer show distance fog? default false */
|
|
4653
|
+
showFog?: boolean | undefined;
|
|
4654
|
+
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
4655
|
+
ambientColorOverride?: PBColor3 | undefined;
|
|
4656
|
+
ambientBrightnessOverride?: number | undefined;
|
|
4657
|
+
}
|
|
4658
|
+
|
|
4659
|
+
/**
|
|
4660
|
+
* @public
|
|
4661
|
+
*/
|
|
4662
|
+
export declare namespace PBCameraLayer {
|
|
4663
|
+
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
4664
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
4665
|
+
}
|
|
4666
|
+
|
|
4667
|
+
/**
|
|
4668
|
+
* @public
|
|
4669
|
+
*/
|
|
4670
|
+
export declare interface PBCameraLayers {
|
|
4671
|
+
layers: number[];
|
|
4672
|
+
}
|
|
4673
|
+
|
|
4674
|
+
/**
|
|
4675
|
+
* @public
|
|
4676
|
+
*/
|
|
4677
|
+
export declare namespace PBCameraLayers {
|
|
4678
|
+
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
4679
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
4680
|
+
}
|
|
4681
|
+
|
|
4417
4682
|
/**
|
|
4418
4683
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
4419
4684
|
* third-person view.
|
|
@@ -4436,7 +4701,7 @@ export declare namespace PBCameraMode {
|
|
|
4436
4701
|
|
|
4437
4702
|
/**
|
|
4438
4703
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
|
4439
|
-
* the player's camera mode (1st-person
|
|
4704
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
|
4440
4705
|
*
|
|
4441
4706
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
|
4442
4707
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
|
@@ -4446,6 +4711,8 @@ export declare namespace PBCameraMode {
|
|
|
4446
4711
|
*
|
|
4447
4712
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
|
4448
4713
|
* is actually a 3D volume.
|
|
4714
|
+
*
|
|
4715
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
|
4449
4716
|
*/
|
|
4450
4717
|
/**
|
|
4451
4718
|
* @public
|
|
@@ -4455,6 +4722,9 @@ export declare interface PBCameraModeArea {
|
|
|
4455
4722
|
area: PBVector3 | undefined;
|
|
4456
4723
|
/** the camera mode to enforce */
|
|
4457
4724
|
mode: CameraType;
|
|
4725
|
+
cinematicSettings?: CinematicSettings | undefined;
|
|
4726
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
4727
|
+
useColliderRange?: boolean | undefined;
|
|
4458
4728
|
}
|
|
4459
4729
|
|
|
4460
4730
|
/**
|
|
@@ -4526,6 +4796,39 @@ export declare namespace PBEngineInfo {
|
|
|
4526
4796
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
4527
4797
|
}
|
|
4528
4798
|
|
|
4799
|
+
/**
|
|
4800
|
+
* defines the global scene light settings. must be added to the scene root.
|
|
4801
|
+
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
4802
|
+
*/
|
|
4803
|
+
/**
|
|
4804
|
+
* @public
|
|
4805
|
+
*/
|
|
4806
|
+
export declare interface PBGlobalLight {
|
|
4807
|
+
/**
|
|
4808
|
+
* the direction the directional light shines in.
|
|
4809
|
+
* default depends on time of day and explorer implementation
|
|
4810
|
+
*/
|
|
4811
|
+
direction?: PBVector3 | undefined;
|
|
4812
|
+
/**
|
|
4813
|
+
* ambient light color
|
|
4814
|
+
* default: White
|
|
4815
|
+
*/
|
|
4816
|
+
ambientColor?: PBColor3 | undefined;
|
|
4817
|
+
/**
|
|
4818
|
+
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
4819
|
+
* default 1
|
|
4820
|
+
*/
|
|
4821
|
+
ambientBrightness?: number | undefined;
|
|
4822
|
+
}
|
|
4823
|
+
|
|
4824
|
+
/**
|
|
4825
|
+
* @public
|
|
4826
|
+
*/
|
|
4827
|
+
export declare namespace PBGlobalLight {
|
|
4828
|
+
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
4829
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
4830
|
+
}
|
|
4831
|
+
|
|
4529
4832
|
/**
|
|
4530
4833
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
4531
4834
|
*
|
|
@@ -4561,6 +4864,25 @@ export declare namespace PBGltfContainer {
|
|
|
4561
4864
|
*/
|
|
4562
4865
|
export declare interface PBGltfContainerLoadingState {
|
|
4563
4866
|
currentState: LoadingState;
|
|
4867
|
+
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
4868
|
+
nodePaths: string[];
|
|
4869
|
+
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
4870
|
+
meshNames: string[];
|
|
4871
|
+
/**
|
|
4872
|
+
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
4873
|
+
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
4874
|
+
*/
|
|
4875
|
+
materialNames: string[];
|
|
4876
|
+
/**
|
|
4877
|
+
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
4878
|
+
* sure all your materials are explicitly named.
|
|
4879
|
+
*/
|
|
4880
|
+
skinNames: string[];
|
|
4881
|
+
/**
|
|
4882
|
+
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
4883
|
+
* your skins are explicitly named.
|
|
4884
|
+
*/
|
|
4885
|
+
animationNames: string[];
|
|
4564
4886
|
}
|
|
4565
4887
|
|
|
4566
4888
|
/**
|
|
@@ -4571,6 +4893,57 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
4571
4893
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
4572
4894
|
}
|
|
4573
4895
|
|
|
4896
|
+
/**
|
|
4897
|
+
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
4898
|
+
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
4899
|
+
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
4900
|
+
* in the parent.
|
|
4901
|
+
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
4902
|
+
*
|
|
4903
|
+
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
4904
|
+
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
4905
|
+
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
4906
|
+
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
4907
|
+
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
4908
|
+
*
|
|
4909
|
+
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
4910
|
+
*
|
|
4911
|
+
* From the scene, you can modify various components to alter the gltf node:
|
|
4912
|
+
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
4913
|
+
* regardless of any intermediate gltf node hierarchy.
|
|
4914
|
+
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
4915
|
+
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
4916
|
+
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
4917
|
+
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
4918
|
+
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
4919
|
+
* 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
|
|
4920
|
+
* PBMaterial will be maintained.
|
|
4921
|
+
*
|
|
4922
|
+
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
4923
|
+
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
4924
|
+
* change the state to `GNS_FAILED`.
|
|
4925
|
+
* - deleting the scene entity will not delete the gltf node.
|
|
4926
|
+
*
|
|
4927
|
+
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
4928
|
+
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
4929
|
+
* the gltf node will also be displayed.
|
|
4930
|
+
*/
|
|
4931
|
+
/**
|
|
4932
|
+
* @public
|
|
4933
|
+
*/
|
|
4934
|
+
export declare interface PBGltfNode {
|
|
4935
|
+
/** the path of the target node in the Gltf. */
|
|
4936
|
+
path: string;
|
|
4937
|
+
}
|
|
4938
|
+
|
|
4939
|
+
/**
|
|
4940
|
+
* @public
|
|
4941
|
+
*/
|
|
4942
|
+
export declare namespace PBGltfNode {
|
|
4943
|
+
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
4944
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
4945
|
+
}
|
|
4946
|
+
|
|
4574
4947
|
/**
|
|
4575
4948
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
4576
4949
|
*
|
|
@@ -4616,6 +4989,26 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
4616
4989
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
4617
4990
|
}
|
|
4618
4991
|
|
|
4992
|
+
/**
|
|
4993
|
+
* The state of a linked gltf node.
|
|
4994
|
+
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
4995
|
+
*/
|
|
4996
|
+
/**
|
|
4997
|
+
* @public
|
|
4998
|
+
*/
|
|
4999
|
+
export declare interface PBGltfNodeState {
|
|
5000
|
+
state: GltfNodeStateValue;
|
|
5001
|
+
error?: string | undefined;
|
|
5002
|
+
}
|
|
5003
|
+
|
|
5004
|
+
/**
|
|
5005
|
+
* @public
|
|
5006
|
+
*/
|
|
5007
|
+
export declare namespace PBGltfNodeState {
|
|
5008
|
+
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5009
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5010
|
+
}
|
|
5011
|
+
|
|
4619
5012
|
/**
|
|
4620
5013
|
* @public
|
|
4621
5014
|
*/
|
|
@@ -4751,6 +5144,14 @@ export declare interface PBMaterial {
|
|
|
4751
5144
|
$case: "pbr";
|
|
4752
5145
|
pbr: PBMaterial_PbrMaterial;
|
|
4753
5146
|
} | undefined;
|
|
5147
|
+
/**
|
|
5148
|
+
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
5149
|
+
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
5150
|
+
* supported by the PbMaterial.
|
|
5151
|
+
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
5152
|
+
* field with data that reflects the gltf material once it is loaded.
|
|
5153
|
+
*/
|
|
5154
|
+
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
4754
5155
|
}
|
|
4755
5156
|
|
|
4756
5157
|
/**
|
|
@@ -4761,6 +5162,22 @@ export declare namespace PBMaterial {
|
|
|
4761
5162
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
4762
5163
|
}
|
|
4763
5164
|
|
|
5165
|
+
/**
|
|
5166
|
+
* @public
|
|
5167
|
+
*/
|
|
5168
|
+
export declare interface PBMaterial_GltfMaterial {
|
|
5169
|
+
gltfSrc: string;
|
|
5170
|
+
name: string;
|
|
5171
|
+
}
|
|
5172
|
+
|
|
5173
|
+
/**
|
|
5174
|
+
* @public
|
|
5175
|
+
*/
|
|
5176
|
+
export declare namespace PBMaterial_GltfMaterial {
|
|
5177
|
+
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
5178
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
5179
|
+
}
|
|
5180
|
+
|
|
4764
5181
|
/**
|
|
4765
5182
|
* @public
|
|
4766
5183
|
*/
|
|
@@ -4857,6 +5274,9 @@ export declare interface PBMeshCollider {
|
|
|
4857
5274
|
} | {
|
|
4858
5275
|
$case: "plane";
|
|
4859
5276
|
plane: PBMeshCollider_PlaneMesh;
|
|
5277
|
+
} | {
|
|
5278
|
+
$case: "gltf";
|
|
5279
|
+
gltf: PBMeshCollider_GltfMesh;
|
|
4860
5280
|
} | undefined;
|
|
4861
5281
|
}
|
|
4862
5282
|
|
|
@@ -4902,6 +5322,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
4902
5322
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
4903
5323
|
}
|
|
4904
5324
|
|
|
5325
|
+
/** A collider constructed from a Gltf Mesh. */
|
|
5326
|
+
/**
|
|
5327
|
+
* @public
|
|
5328
|
+
*/
|
|
5329
|
+
export declare interface PBMeshCollider_GltfMesh {
|
|
5330
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
|
5331
|
+
gltfSrc: string;
|
|
5332
|
+
/** the name of the mesh asset */
|
|
5333
|
+
name: string;
|
|
5334
|
+
}
|
|
5335
|
+
|
|
5336
|
+
/**
|
|
5337
|
+
* @public
|
|
5338
|
+
*/
|
|
5339
|
+
export declare namespace PBMeshCollider_GltfMesh {
|
|
5340
|
+
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5341
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
5342
|
+
}
|
|
5343
|
+
|
|
4905
5344
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
4906
5345
|
/**
|
|
4907
5346
|
* @public
|
|
@@ -4934,13 +5373,11 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
4934
5373
|
|
|
4935
5374
|
/**
|
|
4936
5375
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
4937
|
-
* plane, a sphere or a
|
|
5376
|
+
* plane, a sphere, a cylinder, or a Gltf mesh.
|
|
4938
5377
|
*
|
|
4939
5378
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
4940
5379
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
4941
5380
|
* `float` coordinates, one for each corner of each side of each face.
|
|
4942
|
-
*
|
|
4943
|
-
* More complex shapes require the use of a `GltfContainer` component.
|
|
4944
5381
|
*/
|
|
4945
5382
|
/**
|
|
4946
5383
|
* @public
|
|
@@ -4958,6 +5395,9 @@ export declare interface PBMeshRenderer {
|
|
|
4958
5395
|
} | {
|
|
4959
5396
|
$case: "plane";
|
|
4960
5397
|
plane: PBMeshRenderer_PlaneMesh;
|
|
5398
|
+
} | {
|
|
5399
|
+
$case: "gltf";
|
|
5400
|
+
gltf: PBMeshRenderer_GltfMesh;
|
|
4961
5401
|
} | undefined;
|
|
4962
5402
|
}
|
|
4963
5403
|
|
|
@@ -5005,6 +5445,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
5005
5445
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
5006
5446
|
}
|
|
5007
5447
|
|
|
5448
|
+
/** A mesh from a Gltf. */
|
|
5449
|
+
/**
|
|
5450
|
+
* @public
|
|
5451
|
+
*/
|
|
5452
|
+
export declare interface PBMeshRenderer_GltfMesh {
|
|
5453
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
|
5454
|
+
gltfSrc: string;
|
|
5455
|
+
/** the name of the mesh asset */
|
|
5456
|
+
name: string;
|
|
5457
|
+
}
|
|
5458
|
+
|
|
5459
|
+
/**
|
|
5460
|
+
* @public
|
|
5461
|
+
*/
|
|
5462
|
+
export declare namespace PBMeshRenderer_GltfMesh {
|
|
5463
|
+
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5464
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
5465
|
+
}
|
|
5466
|
+
|
|
5008
5467
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
5009
5468
|
/**
|
|
5010
5469
|
* @public
|
|
@@ -5253,7 +5712,10 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
5253
5712
|
screenCoordinates?: PBVector2 | undefined;
|
|
5254
5713
|
/** Movement since last frame (pixels) */
|
|
5255
5714
|
screenDelta?: PBVector2 | undefined;
|
|
5256
|
-
/**
|
|
5715
|
+
/**
|
|
5716
|
+
* ray direction that can be used with the primary camera origin for
|
|
5717
|
+
* raycasting from the cursor into the world
|
|
5718
|
+
*/
|
|
5257
5719
|
worldRayDirection?: PBVector3 | undefined;
|
|
5258
5720
|
}
|
|
5259
5721
|
|
|
@@ -5479,6 +5941,46 @@ export declare namespace PBTextShape {
|
|
|
5479
5941
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
5480
5942
|
}
|
|
5481
5943
|
|
|
5944
|
+
/**
|
|
5945
|
+
* @public
|
|
5946
|
+
*/
|
|
5947
|
+
export declare interface PBTextureCamera {
|
|
5948
|
+
/** rendered texture width */
|
|
5949
|
+
width?: number | undefined;
|
|
5950
|
+
/** rendered texture height */
|
|
5951
|
+
height?: number | undefined;
|
|
5952
|
+
/**
|
|
5953
|
+
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
5954
|
+
* defaults to 0
|
|
5955
|
+
*/
|
|
5956
|
+
layer?: number | undefined;
|
|
5957
|
+
/** default black */
|
|
5958
|
+
clearColor?: PBColor4 | undefined;
|
|
5959
|
+
/** default infinity */
|
|
5960
|
+
farPlane?: number | undefined;
|
|
5961
|
+
mode?: {
|
|
5962
|
+
$case: "perspective";
|
|
5963
|
+
perspective: Perspective;
|
|
5964
|
+
} | {
|
|
5965
|
+
$case: "orthographic";
|
|
5966
|
+
orthographic: Orthographic;
|
|
5967
|
+
} | undefined;
|
|
5968
|
+
/**
|
|
5969
|
+
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
5970
|
+
* range: 0 (off) - 1 (full volume)
|
|
5971
|
+
* default: 0
|
|
5972
|
+
*/
|
|
5973
|
+
volume?: number | undefined;
|
|
5974
|
+
}
|
|
5975
|
+
|
|
5976
|
+
/**
|
|
5977
|
+
* @public
|
|
5978
|
+
*/
|
|
5979
|
+
export declare namespace PBTextureCamera {
|
|
5980
|
+
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
5981
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
5982
|
+
}
|
|
5983
|
+
|
|
5482
5984
|
/**
|
|
5483
5985
|
* The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
|
|
5484
5986
|
* when entities enter this component's defined area.
|
|
@@ -5657,6 +6159,25 @@ export declare namespace PBUiBackground {
|
|
|
5657
6159
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
5658
6160
|
}
|
|
5659
6161
|
|
|
6162
|
+
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
6163
|
+
/**
|
|
6164
|
+
* @public
|
|
6165
|
+
*/
|
|
6166
|
+
export declare interface PBUiCanvas {
|
|
6167
|
+
width: number;
|
|
6168
|
+
height: number;
|
|
6169
|
+
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
6170
|
+
color?: PBColor4 | undefined;
|
|
6171
|
+
}
|
|
6172
|
+
|
|
6173
|
+
/**
|
|
6174
|
+
* @public
|
|
6175
|
+
*/
|
|
6176
|
+
export declare namespace PBUiCanvas {
|
|
6177
|
+
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
6178
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
6179
|
+
}
|
|
6180
|
+
|
|
5660
6181
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
5661
6182
|
/**
|
|
5662
6183
|
* @public
|
|
@@ -5773,6 +6294,21 @@ export declare namespace PBUiInputResult {
|
|
|
5773
6294
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
5774
6295
|
}
|
|
5775
6296
|
|
|
6297
|
+
/**
|
|
6298
|
+
* @public
|
|
6299
|
+
*/
|
|
6300
|
+
export declare interface PBUiScrollResult {
|
|
6301
|
+
value: PBVector2 | undefined;
|
|
6302
|
+
}
|
|
6303
|
+
|
|
6304
|
+
/**
|
|
6305
|
+
* @public
|
|
6306
|
+
*/
|
|
6307
|
+
export declare namespace PBUiScrollResult {
|
|
6308
|
+
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
6309
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
6310
|
+
}
|
|
6311
|
+
|
|
5776
6312
|
/**
|
|
5777
6313
|
* @public
|
|
5778
6314
|
*/
|
|
@@ -5789,6 +6325,10 @@ export declare interface PBUiText {
|
|
|
5789
6325
|
fontSize?: number | undefined;
|
|
5790
6326
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
|
5791
6327
|
textWrap?: TextWrap | undefined;
|
|
6328
|
+
/** width of the outline (default: 0) */
|
|
6329
|
+
outlineWidth?: number | undefined;
|
|
6330
|
+
/** RGBA color of the outline (default: opaque black) */
|
|
6331
|
+
outlineColor?: PBColor4 | undefined;
|
|
5792
6332
|
}
|
|
5793
6333
|
|
|
5794
6334
|
/**
|
|
@@ -5916,6 +6456,12 @@ export declare interface PBUiTransform {
|
|
|
5916
6456
|
borderRightColor?: PBColor4 | undefined;
|
|
5917
6457
|
/** default: 1 */
|
|
5918
6458
|
opacity?: number | undefined;
|
|
6459
|
+
/** reference for scroll_position. default empty */
|
|
6460
|
+
elementId?: string | undefined;
|
|
6461
|
+
/** default position=(0,0) */
|
|
6462
|
+
scrollPosition?: ScrollPositionValue | undefined;
|
|
6463
|
+
/** default ShowScrollBar.SSB_BOTH */
|
|
6464
|
+
scrollVisible?: ShowScrollBar | undefined;
|
|
5919
6465
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
5920
6466
|
zIndex?: number | undefined;
|
|
5921
6467
|
}
|
|
@@ -6047,6 +6593,25 @@ export declare namespace PBVisibilityComponent {
|
|
|
6047
6593
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6048
6594
|
}
|
|
6049
6595
|
|
|
6596
|
+
/**
|
|
6597
|
+
* @public
|
|
6598
|
+
*/
|
|
6599
|
+
export declare interface Perspective {
|
|
6600
|
+
/**
|
|
6601
|
+
* vertical field of view in radians
|
|
6602
|
+
* defaults to pi/4 = 45 degrees
|
|
6603
|
+
*/
|
|
6604
|
+
fieldOfView?: number | undefined;
|
|
6605
|
+
}
|
|
6606
|
+
|
|
6607
|
+
/**
|
|
6608
|
+
* @public
|
|
6609
|
+
*/
|
|
6610
|
+
export declare namespace Perspective {
|
|
6611
|
+
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
6612
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
6613
|
+
}
|
|
6614
|
+
|
|
6050
6615
|
/**
|
|
6051
6616
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6052
6617
|
* @public
|
|
@@ -6202,11 +6767,37 @@ export declare interface PointerEventsSystem {
|
|
|
6202
6767
|
* @param entity - Entity where the callback was attached
|
|
6203
6768
|
*/
|
|
6204
6769
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
6770
|
+
/**
|
|
6771
|
+
* @public
|
|
6772
|
+
* Remove the callback for onPointerDrag event
|
|
6773
|
+
* @param entity - Entity where the callback was attached
|
|
6774
|
+
*/
|
|
6775
|
+
removeOnPointerDrag(entity: Entity): void;
|
|
6776
|
+
/**
|
|
6777
|
+
* @public
|
|
6778
|
+
* Remove the callback for onPointerDragLocked event
|
|
6779
|
+
* @param entity - Entity where the callback was attached
|
|
6780
|
+
*/
|
|
6781
|
+
removeOnPointerDragLocked(entity: Entity): void;
|
|
6782
|
+
/**
|
|
6783
|
+
* @public
|
|
6784
|
+
* Remove the callback for onPointerDragEnd event
|
|
6785
|
+
* @param entity - Entity where the callback was attached
|
|
6786
|
+
*/
|
|
6787
|
+
removeOnPointerDragEnd(entity: Entity): void;
|
|
6788
|
+
/**
|
|
6789
|
+
* @public
|
|
6790
|
+
* Execute callbacks when the user presses one of the InputButtons pointing at the entity
|
|
6791
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
6792
|
+
*/
|
|
6793
|
+
onPointerDown(pointerData: {
|
|
6794
|
+
entity: Entity;
|
|
6795
|
+
optsList: EventSystemOptionsCallback[];
|
|
6796
|
+
}): void;
|
|
6205
6797
|
/**
|
|
6206
6798
|
* @public
|
|
6207
6799
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
6208
6800
|
* @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
|
|
6209
|
-
* @param cb - Function to execute when click fires
|
|
6210
6801
|
*/
|
|
6211
6802
|
onPointerDown(pointerData: {
|
|
6212
6803
|
entity: Entity;
|
|
@@ -6219,6 +6810,15 @@ export declare interface PointerEventsSystem {
|
|
|
6219
6810
|
* @param opts - Opts to trigger Feedback and Button
|
|
6220
6811
|
*/
|
|
6221
6812
|
onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
|
|
6813
|
+
/**
|
|
6814
|
+
* @public
|
|
6815
|
+
* Execute callbacks when the user releases one of the InputButtons pointing at the entity
|
|
6816
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
6817
|
+
*/
|
|
6818
|
+
onPointerUp(pointerData: {
|
|
6819
|
+
entity: Entity;
|
|
6820
|
+
optsList: EventSystemOptionsCallback[];
|
|
6821
|
+
}): void;
|
|
6222
6822
|
/**
|
|
6223
6823
|
* @public
|
|
6224
6824
|
* Execute callback when the user releases the InputButton pointing at the entity
|
|
@@ -6256,6 +6856,64 @@ export declare interface PointerEventsSystem {
|
|
|
6256
6856
|
entity: Entity;
|
|
6257
6857
|
opts?: Partial<EventSystemOptions>;
|
|
6258
6858
|
}, cb: EventSystemCallback): void;
|
|
6859
|
+
/**
|
|
6860
|
+
* @public
|
|
6861
|
+
* Execute callbacks when the user drags the pointer from inside the entity
|
|
6862
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
6863
|
+
*/
|
|
6864
|
+
onPointerDrag(pointerData: {
|
|
6865
|
+
entity: Entity;
|
|
6866
|
+
optsList: EventSystemOptionsCallback[];
|
|
6867
|
+
}): void;
|
|
6868
|
+
/**
|
|
6869
|
+
* @public
|
|
6870
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity
|
|
6871
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6872
|
+
* @param cb - Function to execute when click fires
|
|
6873
|
+
*/
|
|
6874
|
+
onPointerDrag(pointerData: {
|
|
6875
|
+
entity: Entity;
|
|
6876
|
+
opts?: Partial<EventSystemOptions>;
|
|
6877
|
+
}, cb: EventSystemCallback): void;
|
|
6878
|
+
/**
|
|
6879
|
+
* @public
|
|
6880
|
+
* Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
|
|
6881
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
6882
|
+
*/
|
|
6883
|
+
onPointerDragLocked(pointerData: {
|
|
6884
|
+
entity: Entity;
|
|
6885
|
+
optsList: EventSystemOptionsCallback[];
|
|
6886
|
+
}): void;
|
|
6887
|
+
/**
|
|
6888
|
+
* @public
|
|
6889
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
|
6890
|
+
* locking the cursor in place
|
|
6891
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6892
|
+
* @param cb - Function to execute when click fires
|
|
6893
|
+
*/
|
|
6894
|
+
onPointerDragLocked(pointerData: {
|
|
6895
|
+
entity: Entity;
|
|
6896
|
+
opts?: Partial<EventSystemOptions>;
|
|
6897
|
+
}, cb: EventSystemCallback): void;
|
|
6898
|
+
/**
|
|
6899
|
+
* @public
|
|
6900
|
+
* Execute callbacks when the user releases a button after a drag
|
|
6901
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
6902
|
+
*/
|
|
6903
|
+
onPointerDragEnd(pointerData: {
|
|
6904
|
+
entity: Entity;
|
|
6905
|
+
optsList: EventSystemOptionsCallback[];
|
|
6906
|
+
}): void;
|
|
6907
|
+
/**
|
|
6908
|
+
* @public
|
|
6909
|
+
* Execute callback when the user releases the button after a drag
|
|
6910
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
6911
|
+
* @param cb - Function to execute when click fires
|
|
6912
|
+
*/
|
|
6913
|
+
onPointerDragEnd(pointerData: {
|
|
6914
|
+
entity: Entity;
|
|
6915
|
+
opts?: Partial<EventSystemOptions>;
|
|
6916
|
+
}, cb: EventSystemCallback): void;
|
|
6259
6917
|
}
|
|
6260
6918
|
|
|
6261
6919
|
/**
|
|
@@ -6272,7 +6930,10 @@ export declare const enum PointerEventType {
|
|
|
6272
6930
|
PET_UP = 0,
|
|
6273
6931
|
PET_DOWN = 1,
|
|
6274
6932
|
PET_HOVER_ENTER = 2,
|
|
6275
|
-
PET_HOVER_LEAVE = 3
|
|
6933
|
+
PET_HOVER_LEAVE = 3,
|
|
6934
|
+
PET_DRAG_LOCKED = 4,
|
|
6935
|
+
PET_DRAG = 5,
|
|
6936
|
+
PET_DRAG_END = 6
|
|
6276
6937
|
}
|
|
6277
6938
|
|
|
6278
6939
|
/**
|
|
@@ -6303,7 +6964,10 @@ export declare const enum PointerType {
|
|
|
6303
6964
|
/** POT_NONE - No pointer input */
|
|
6304
6965
|
POT_NONE = 0,
|
|
6305
6966
|
/** POT_MOUSE - Traditional mouse input */
|
|
6306
|
-
POT_MOUSE = 1
|
|
6967
|
+
POT_MOUSE = 1,
|
|
6968
|
+
POT_PAD = 2,
|
|
6969
|
+
POT_TOUCH = 3,
|
|
6970
|
+
POT_WAND = 4
|
|
6307
6971
|
}
|
|
6308
6972
|
|
|
6309
6973
|
/**
|
|
@@ -6900,6 +7564,7 @@ export declare type RaycastSystemOptions = {
|
|
|
6900
7564
|
export declare interface ReactBasedUiSystem {
|
|
6901
7565
|
destroy(): void;
|
|
6902
7566
|
setUiRenderer(ui: UiComponent): void;
|
|
7567
|
+
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
6903
7568
|
}
|
|
6904
7569
|
|
|
6905
7570
|
/**
|
|
@@ -7378,6 +8043,43 @@ export declare namespace Schemas {
|
|
|
7378
8043
|
}) => void;
|
|
7379
8044
|
}
|
|
7380
8045
|
|
|
8046
|
+
/**
|
|
8047
|
+
* @public
|
|
8048
|
+
*/
|
|
8049
|
+
export declare interface ScrollPositionValue {
|
|
8050
|
+
value?: {
|
|
8051
|
+
$case: "position";
|
|
8052
|
+
position: PBVector2;
|
|
8053
|
+
} | {
|
|
8054
|
+
$case: "reference";
|
|
8055
|
+
reference: string;
|
|
8056
|
+
} | undefined;
|
|
8057
|
+
}
|
|
8058
|
+
|
|
8059
|
+
/**
|
|
8060
|
+
* @public
|
|
8061
|
+
*/
|
|
8062
|
+
export declare namespace ScrollPositionValue {
|
|
8063
|
+
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
8064
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
8065
|
+
}
|
|
8066
|
+
|
|
8067
|
+
/**
|
|
8068
|
+
* @public
|
|
8069
|
+
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
|
8070
|
+
*/
|
|
8071
|
+
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
8072
|
+
|
|
8073
|
+
/**
|
|
8074
|
+
* @public
|
|
8075
|
+
*/
|
|
8076
|
+
export declare const enum ShowScrollBar {
|
|
8077
|
+
SSB_BOTH = 0,
|
|
8078
|
+
SSB_ONLY_VERTICAL = 1,
|
|
8079
|
+
SSB_ONLY_HORIZONTAL = 2,
|
|
8080
|
+
SSB_HIDDEN = 3
|
|
8081
|
+
}
|
|
8082
|
+
|
|
7381
8083
|
/** @public */
|
|
7382
8084
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
7383
8085
|
|
|
@@ -7489,6 +8191,9 @@ export declare namespace Texture {
|
|
|
7489
8191
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
7490
8192
|
}
|
|
7491
8193
|
|
|
8194
|
+
/** @public */
|
|
8195
|
+
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
8196
|
+
|
|
7492
8197
|
/**
|
|
7493
8198
|
* @public
|
|
7494
8199
|
*/
|
|
@@ -7599,6 +8304,9 @@ export declare interface TextureUnion {
|
|
|
7599
8304
|
} | {
|
|
7600
8305
|
$case: "videoTexture";
|
|
7601
8306
|
videoTexture: VideoTexture;
|
|
8307
|
+
} | {
|
|
8308
|
+
$case: "uiTexture";
|
|
8309
|
+
uiTexture: UiCanvasTexture;
|
|
7602
8310
|
} | undefined;
|
|
7603
8311
|
}
|
|
7604
8312
|
|
|
@@ -7971,7 +8679,7 @@ export declare type TweenSystem = {
|
|
|
7971
8679
|
|
|
7972
8680
|
/**
|
|
7973
8681
|
* @public
|
|
7974
|
-
* Register callback functions to a particular entity on
|
|
8682
|
+
* Register callback functions to a particular entity on video events.
|
|
7975
8683
|
*/
|
|
7976
8684
|
export declare const tweenSystem: TweenSystem;
|
|
7977
8685
|
|
|
@@ -8003,6 +8711,8 @@ export declare interface UiBackgroundProps {
|
|
|
8003
8711
|
uvs?: number[];
|
|
8004
8712
|
/** AvatarTexture for the background */
|
|
8005
8713
|
avatarTexture?: UiAvatarTexture;
|
|
8714
|
+
/** VideoTexture for the background */
|
|
8715
|
+
videoTexture?: UiVideoTexture;
|
|
8006
8716
|
/** Texture for the background */
|
|
8007
8717
|
texture?: UiTexture;
|
|
8008
8718
|
}
|
|
@@ -8022,9 +8732,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
8022
8732
|
disabled?: boolean;
|
|
8023
8733
|
}
|
|
8024
8734
|
|
|
8735
|
+
/** @public */
|
|
8736
|
+
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
8737
|
+
|
|
8025
8738
|
/** @public */
|
|
8026
8739
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
8027
8740
|
|
|
8741
|
+
/**
|
|
8742
|
+
* @public
|
|
8743
|
+
*/
|
|
8744
|
+
export declare interface UiCanvasTexture {
|
|
8745
|
+
uiCanvasEntity: number;
|
|
8746
|
+
/** default = TextureWrapMode.Clamp */
|
|
8747
|
+
wrapMode?: TextureWrapMode | undefined;
|
|
8748
|
+
/** default = FilterMode.Bilinear */
|
|
8749
|
+
filterMode?: TextureFilterMode | undefined;
|
|
8750
|
+
}
|
|
8751
|
+
|
|
8752
|
+
/**
|
|
8753
|
+
* @public
|
|
8754
|
+
*/
|
|
8755
|
+
export declare namespace UiCanvasTexture {
|
|
8756
|
+
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
8757
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
8758
|
+
}
|
|
8759
|
+
|
|
8028
8760
|
/**
|
|
8029
8761
|
* @public
|
|
8030
8762
|
*/
|
|
@@ -8094,6 +8826,10 @@ export declare interface UiLabelProps {
|
|
|
8094
8826
|
textAlign?: TextAlignType | undefined;
|
|
8095
8827
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
8096
8828
|
font?: UiFontType | undefined;
|
|
8829
|
+
/** Outline width of the text. @defaultValue 0 */
|
|
8830
|
+
outlineWidth?: number | undefined;
|
|
8831
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
|
8832
|
+
outlineColor?: PBColor4 | undefined;
|
|
8097
8833
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
8098
8834
|
textWrap?: UiTextWrapType | undefined;
|
|
8099
8835
|
}
|
|
@@ -8103,6 +8839,9 @@ export declare interface UiLabelProps {
|
|
|
8103
8839
|
*/
|
|
8104
8840
|
export declare type uint32 = number;
|
|
8105
8841
|
|
|
8842
|
+
/** @public */
|
|
8843
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
8844
|
+
|
|
8106
8845
|
/** @public */
|
|
8107
8846
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
8108
8847
|
|
|
@@ -8180,10 +8919,26 @@ export declare interface UiTransformProps {
|
|
|
8180
8919
|
borderWidth?: Partial<Position> | PositionUnit;
|
|
8181
8920
|
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
|
8182
8921
|
opacity?: number;
|
|
8922
|
+
/** A reference value to identify the element, default empty */
|
|
8923
|
+
elementId?: string;
|
|
8924
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
|
8925
|
+
scrollPosition?: PBVector2 | string;
|
|
8926
|
+
/** default ShowScrollBar.SSB_BOTH */
|
|
8927
|
+
scrollVisible?: ScrollVisibleType;
|
|
8183
8928
|
/** default 0 */
|
|
8184
8929
|
zIndex?: number;
|
|
8185
8930
|
}
|
|
8186
8931
|
|
|
8932
|
+
/**
|
|
8933
|
+
* Texture
|
|
8934
|
+
* @public
|
|
8935
|
+
*/
|
|
8936
|
+
export declare interface UiVideoTexture {
|
|
8937
|
+
videoPlayerEntity: Entity;
|
|
8938
|
+
wrapMode?: TextureWrapType;
|
|
8939
|
+
filterMode?: TextureFilterType;
|
|
8940
|
+
}
|
|
8941
|
+
|
|
8187
8942
|
/**
|
|
8188
8943
|
* @public
|
|
8189
8944
|
*/
|