@dcl/playground-assets 7.8.6-14664638926.commit-7bb4ee2 → 7.8.6-14834806827.commit-cd5899c
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 +26 -816
- package/dist/beta.d.ts +25 -815
- package/dist/index.bundled.d.ts +25 -815
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +26 -816
- package/dist/tsdoc-metadata.json +1 -1
- package/etc/playground-assets.api.json +2437 -10172
- package/etc/playground-assets.api.md +22 -535
- package/package.json +4 -4
@@ -178,32 +178,11 @@ 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
|
-
|
193
181
|
/** @public */
|
194
182
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
195
183
|
|
196
|
-
|
197
|
-
|
198
|
-
/**
|
199
|
-
* @public
|
200
|
-
*/
|
201
|
-
export declare interface AvatarEquippedDataComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType> {
|
202
|
-
}
|
203
|
-
|
204
|
-
export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
|
205
|
-
forceRender?: string[] | undefined;
|
206
|
-
};
|
184
|
+
/** @public */
|
185
|
+
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
207
186
|
|
208
187
|
/** @public */
|
209
188
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
@@ -219,48 +198,8 @@ export declare const enum AvatarModifierType {
|
|
219
198
|
AMT_DISABLE_PASSPORTS = 1
|
220
199
|
}
|
221
200
|
|
222
|
-
/**
|
223
|
-
|
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
|
-
|
253
|
-
export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
|
254
|
-
|
255
|
-
/**
|
256
|
-
* @public
|
257
|
-
*/
|
258
|
-
export declare interface AvatarShapeComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<AvatarShapeType> {
|
259
|
-
}
|
260
|
-
|
261
|
-
export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
|
262
|
-
forceRender?: string[] | undefined;
|
263
|
-
};
|
201
|
+
/** @public */
|
202
|
+
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
264
203
|
|
265
204
|
/**
|
266
205
|
* @public
|
@@ -534,12 +473,6 @@ export declare interface ByteBuffer {
|
|
534
473
|
*/
|
535
474
|
export declare type Callback = () => void;
|
536
475
|
|
537
|
-
/** @public */
|
538
|
-
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
539
|
-
|
540
|
-
/** @public */
|
541
|
-
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
542
|
-
|
543
476
|
/** @public */
|
544
477
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
545
478
|
|
@@ -597,39 +530,6 @@ export declare const enum CameraType {
|
|
597
530
|
|
598
531
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
599
532
|
|
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
|
-
|
633
533
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
634
534
|
/**
|
635
535
|
* @public
|
@@ -1403,18 +1303,12 @@ export declare const componentDefinitionByName: {
|
|
1403
1303
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
1404
1304
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
1405
1305
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
1406
|
-
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
1407
|
-
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
1408
1306
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
1409
1307
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
1410
1308
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
1411
|
-
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
1412
1309
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
1413
1310
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
1414
|
-
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
1415
|
-
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
1416
1311
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
1417
|
-
"core::Light": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLight>>;
|
1418
1312
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
1419
1313
|
"core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
|
1420
1314
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
@@ -1424,24 +1318,19 @@ export declare const componentDefinitionByName: {
|
|
1424
1318
|
"core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
|
1425
1319
|
"core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
|
1426
1320
|
"core::PointerLock": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerLock>>;
|
1427
|
-
"core::PrimaryPointerInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>>;
|
1428
1321
|
"core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
|
1429
1322
|
"core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
|
1430
1323
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
1431
|
-
"core::Spotlight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSpotlight>>;
|
1432
1324
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
1433
|
-
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
1434
1325
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
1435
1326
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
1436
1327
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
1437
1328
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
1438
|
-
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
1439
1329
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
1440
1330
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
1441
1331
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
1442
1332
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
1443
1333
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
1444
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
1445
1334
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
1446
1335
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
1447
1336
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
@@ -2012,9 +1901,6 @@ export declare type EntityComponents = {
|
|
2012
1901
|
onMouseUp: Callback;
|
2013
1902
|
onMouseEnter: Callback;
|
2014
1903
|
onMouseLeave: Callback;
|
2015
|
-
onMouseDrag: Callback;
|
2016
|
-
onMouseDragLocked: Callback;
|
2017
|
-
onMouseDragEnd: Callback;
|
2018
1904
|
};
|
2019
1905
|
|
2020
1906
|
/** @public */
|
@@ -2166,9 +2052,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
2166
2052
|
direction?: PBVector3;
|
2167
2053
|
};
|
2168
2054
|
|
2169
|
-
/** @public */
|
2170
|
-
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
2171
|
-
|
2172
2055
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
2173
2056
|
|
2174
2057
|
export declare type GlobalTargetRaycastSystemOptions = {
|
@@ -2181,21 +2064,6 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
2181
2064
|
/** @public */
|
2182
2065
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
2183
2066
|
|
2184
|
-
/** @public */
|
2185
|
-
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
2186
|
-
|
2187
|
-
/** @public */
|
2188
|
-
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
2189
|
-
|
2190
|
-
/**
|
2191
|
-
* @public
|
2192
|
-
*/
|
2193
|
-
export declare const enum GltfNodeStateValue {
|
2194
|
-
GNSV_PENDING = 0,
|
2195
|
-
GNSV_FAILED = 1,
|
2196
|
-
GNSV_READY = 2
|
2197
|
-
}
|
2198
|
-
|
2199
2067
|
/**
|
2200
2068
|
* @public
|
2201
2069
|
*/
|
@@ -2367,7 +2235,14 @@ export declare interface IEngine {
|
|
2367
2235
|
* Search for the entity that matches de label string defined in the editor.
|
2368
2236
|
* @param value - Name value string
|
2369
2237
|
*/
|
2370
|
-
getEntityOrNullByName(label:
|
2238
|
+
getEntityOrNullByName<T = string>(label: T): Entity | null;
|
2239
|
+
/**
|
2240
|
+
* @public
|
2241
|
+
* Search for the entity that matches de label string defined in the editor.
|
2242
|
+
* @param value - Name value string
|
2243
|
+
* @typeParam T - The type of the entity name value
|
2244
|
+
*/
|
2245
|
+
getEntityByName<T = never, K = T>(value: K & (T extends never ? never : string)): Entity;
|
2371
2246
|
/**
|
2372
2247
|
* @public
|
2373
2248
|
* @param deltaTime - deltaTime in seconds
|
@@ -2799,9 +2674,6 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
2799
2674
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
2800
2675
|
}
|
2801
2676
|
|
2802
|
-
/** @public */
|
2803
|
-
export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
|
2804
|
-
|
2805
2677
|
/**
|
2806
2678
|
* User key event Listeners
|
2807
2679
|
* @public
|
@@ -2815,12 +2687,6 @@ export declare type Listeners = {
|
|
2815
2687
|
onMouseEnter?: Callback;
|
2816
2688
|
/** triggered on mouse leave event */
|
2817
2689
|
onMouseLeave?: Callback;
|
2818
|
-
/** triggered on mouse drag event */
|
2819
|
-
onMouseDrag?: Callback;
|
2820
|
-
/** triggered on mouse drag event */
|
2821
|
-
onMouseDragLocked?: Callback;
|
2822
|
-
/** triggered on mouse drag event */
|
2823
|
-
onMouseDragEnd?: Callback;
|
2824
2690
|
};
|
2825
2691
|
|
2826
2692
|
/**
|
@@ -3689,14 +3555,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3689
3555
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3690
3556
|
*/
|
3691
3557
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3692
|
-
/**
|
3693
|
-
* @public
|
3694
|
-
* Set a gltf internal mesh in the MeshCollider component
|
3695
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3696
|
-
* @param source - the path to the gltf
|
3697
|
-
* @param meshName - the name of the mesh in the gltf
|
3698
|
-
*/
|
3699
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3700
3558
|
}
|
3701
3559
|
|
3702
3560
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3733,14 +3591,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3733
3591
|
* @param entity - entity to create or replace the MeshRenderer component
|
3734
3592
|
*/
|
3735
3593
|
setSphere(entity: Entity): void;
|
3736
|
-
/**
|
3737
|
-
* @public
|
3738
|
-
* Set a gltf internal mesh in the MeshRenderer component
|
3739
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3740
|
-
* @param source - the path to the gltf
|
3741
|
-
* @param meshName - the name of the mesh in the gltf
|
3742
|
-
*/
|
3743
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3744
3594
|
}
|
3745
3595
|
|
3746
3596
|
/**
|
@@ -4153,25 +4003,6 @@ export declare const onVideoEvent: Observable<{
|
|
4153
4003
|
totalVideoLength: number;
|
4154
4004
|
}>;
|
4155
4005
|
|
4156
|
-
/**
|
4157
|
-
* @public
|
4158
|
-
*/
|
4159
|
-
export declare interface Orthographic {
|
4160
|
-
/**
|
4161
|
-
* vertical extent of the visible range in meters
|
4162
|
-
* defaults to 4m
|
4163
|
-
*/
|
4164
|
-
verticalRange?: number | undefined;
|
4165
|
-
}
|
4166
|
-
|
4167
|
-
/**
|
4168
|
-
* @public
|
4169
|
-
*/
|
4170
|
-
export declare namespace Orthographic {
|
4171
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4172
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4173
|
-
}
|
4174
|
-
|
4175
4006
|
/**
|
4176
4007
|
* @public
|
4177
4008
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4398,8 +4229,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
4398
4229
|
export declare interface PBAvatarEquippedData {
|
4399
4230
|
wearableUrns: string[];
|
4400
4231
|
emoteUrns: string[];
|
4401
|
-
/** slots that will render even if hidden */
|
4402
|
-
forceRender: string[];
|
4403
4232
|
}
|
4404
4233
|
|
4405
4234
|
/**
|
@@ -4434,9 +4263,6 @@ export declare interface PBAvatarModifierArea {
|
|
4434
4263
|
excludeIds: string[];
|
4435
4264
|
/** list of modifiers to apply */
|
4436
4265
|
modifiers: AvatarModifierType[];
|
4437
|
-
movementSettings?: AvatarMovementSettings | undefined;
|
4438
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4439
|
-
useColliderRange?: boolean | undefined;
|
4440
4266
|
}
|
4441
4267
|
|
4442
4268
|
/**
|
@@ -4493,8 +4319,6 @@ export declare interface PBAvatarShape {
|
|
4493
4319
|
wearables: string[];
|
4494
4320
|
/** available emotes (default empty) */
|
4495
4321
|
emotes: string[];
|
4496
|
-
/** slots that will render even if hidden */
|
4497
|
-
forceRender: string[];
|
4498
4322
|
}
|
4499
4323
|
|
4500
4324
|
/**
|
@@ -4529,51 +4353,6 @@ export declare namespace PBBillboard {
|
|
4529
4353
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4530
4354
|
}
|
4531
4355
|
|
4532
|
-
/**
|
4533
|
-
* @public
|
4534
|
-
*/
|
4535
|
-
export declare interface PBCameraLayer {
|
4536
|
-
/**
|
4537
|
-
* layer to which these settings apply. must be > 0
|
4538
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4539
|
-
*/
|
4540
|
-
layer: number;
|
4541
|
-
/** should the sun light affect this layer? default false */
|
4542
|
-
directionalLight?: boolean | undefined;
|
4543
|
-
/** should this layer show player avatars? default false */
|
4544
|
-
showAvatars?: boolean | undefined;
|
4545
|
-
/** should this layer show the sky? default false */
|
4546
|
-
showSkybox?: boolean | undefined;
|
4547
|
-
/** should this layer show distance fog? default false */
|
4548
|
-
showFog?: boolean | undefined;
|
4549
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
4550
|
-
ambientColorOverride?: PBColor3 | undefined;
|
4551
|
-
ambientBrightnessOverride?: number | undefined;
|
4552
|
-
}
|
4553
|
-
|
4554
|
-
/**
|
4555
|
-
* @public
|
4556
|
-
*/
|
4557
|
-
export declare namespace PBCameraLayer {
|
4558
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4559
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4560
|
-
}
|
4561
|
-
|
4562
|
-
/**
|
4563
|
-
* @public
|
4564
|
-
*/
|
4565
|
-
export declare interface PBCameraLayers {
|
4566
|
-
layers: number[];
|
4567
|
-
}
|
4568
|
-
|
4569
|
-
/**
|
4570
|
-
* @public
|
4571
|
-
*/
|
4572
|
-
export declare namespace PBCameraLayers {
|
4573
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4574
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4575
|
-
}
|
4576
|
-
|
4577
4356
|
/**
|
4578
4357
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4579
4358
|
* third-person view.
|
@@ -4596,7 +4375,7 @@ export declare namespace PBCameraMode {
|
|
4596
4375
|
|
4597
4376
|
/**
|
4598
4377
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4599
|
-
* the player's camera mode (1st-person
|
4378
|
+
* the player's camera mode (1st-person or 3rd-person) is overridden.
|
4600
4379
|
*
|
4601
4380
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4602
4381
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4606,8 +4385,6 @@ export declare namespace PBCameraMode {
|
|
4606
4385
|
*
|
4607
4386
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4608
4387
|
* is actually a 3D volume.
|
4609
|
-
*
|
4610
|
-
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4611
4388
|
*/
|
4612
4389
|
/**
|
4613
4390
|
* @public
|
@@ -4617,9 +4394,6 @@ export declare interface PBCameraModeArea {
|
|
4617
4394
|
area: PBVector3 | undefined;
|
4618
4395
|
/** the camera mode to enforce */
|
4619
4396
|
mode: CameraType;
|
4620
|
-
cinematicSettings?: CinematicSettings | undefined;
|
4621
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4622
|
-
useColliderRange?: boolean | undefined;
|
4623
4397
|
}
|
4624
4398
|
|
4625
4399
|
/**
|
@@ -4691,39 +4465,6 @@ export declare namespace PBEngineInfo {
|
|
4691
4465
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4692
4466
|
}
|
4693
4467
|
|
4694
|
-
/**
|
4695
|
-
* defines the global scene light settings. must be added to the scene root.
|
4696
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4697
|
-
*/
|
4698
|
-
/**
|
4699
|
-
* @public
|
4700
|
-
*/
|
4701
|
-
export declare interface PBGlobalLight {
|
4702
|
-
/**
|
4703
|
-
* the direction the directional light shines in.
|
4704
|
-
* default depends on time of day and explorer implementation
|
4705
|
-
*/
|
4706
|
-
direction?: PBVector3 | undefined;
|
4707
|
-
/**
|
4708
|
-
* ambient light color
|
4709
|
-
* default: White
|
4710
|
-
*/
|
4711
|
-
ambientColor?: PBColor3 | undefined;
|
4712
|
-
/**
|
4713
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4714
|
-
* default 1
|
4715
|
-
*/
|
4716
|
-
ambientBrightness?: number | undefined;
|
4717
|
-
}
|
4718
|
-
|
4719
|
-
/**
|
4720
|
-
* @public
|
4721
|
-
*/
|
4722
|
-
export declare namespace PBGlobalLight {
|
4723
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4724
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4725
|
-
}
|
4726
|
-
|
4727
4468
|
/**
|
4728
4469
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4729
4470
|
*
|
@@ -4759,25 +4500,6 @@ export declare namespace PBGltfContainer {
|
|
4759
4500
|
*/
|
4760
4501
|
export declare interface PBGltfContainerLoadingState {
|
4761
4502
|
currentState: LoadingState;
|
4762
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4763
|
-
nodePaths: string[];
|
4764
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4765
|
-
meshNames: string[];
|
4766
|
-
/**
|
4767
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4768
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4769
|
-
*/
|
4770
|
-
materialNames: string[];
|
4771
|
-
/**
|
4772
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4773
|
-
* sure all your materials are explicitly named.
|
4774
|
-
*/
|
4775
|
-
skinNames: string[];
|
4776
|
-
/**
|
4777
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4778
|
-
* your skins are explicitly named.
|
4779
|
-
*/
|
4780
|
-
animationNames: string[];
|
4781
4503
|
}
|
4782
4504
|
|
4783
4505
|
/**
|
@@ -4788,77 +4510,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4788
4510
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4789
4511
|
}
|
4790
4512
|
|
4791
|
-
/**
|
4792
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4793
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4794
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4795
|
-
* in the parent.
|
4796
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4797
|
-
*
|
4798
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4799
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4800
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4801
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4802
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4803
|
-
*
|
4804
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4805
|
-
*
|
4806
|
-
* From the scene, you can modify various components to alter the gltf node:
|
4807
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4808
|
-
* regardless of any intermediate gltf node hierarchy.
|
4809
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4810
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4811
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4812
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4813
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4814
|
-
* 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
|
4815
|
-
* PBMaterial will be maintained.
|
4816
|
-
*
|
4817
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4818
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4819
|
-
* change the state to `GNS_FAILED`.
|
4820
|
-
* - deleting the scene entity will not delete the gltf node.
|
4821
|
-
*
|
4822
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4823
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4824
|
-
* the gltf node will also be displayed.
|
4825
|
-
*/
|
4826
|
-
/**
|
4827
|
-
* @public
|
4828
|
-
*/
|
4829
|
-
export declare interface PBGltfNode {
|
4830
|
-
/** the path of the target node in the Gltf. */
|
4831
|
-
path: string;
|
4832
|
-
}
|
4833
|
-
|
4834
|
-
/**
|
4835
|
-
* @public
|
4836
|
-
*/
|
4837
|
-
export declare namespace PBGltfNode {
|
4838
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4839
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4840
|
-
}
|
4841
|
-
|
4842
|
-
/**
|
4843
|
-
* The state of a linked gltf node.
|
4844
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4845
|
-
*/
|
4846
|
-
/**
|
4847
|
-
* @public
|
4848
|
-
*/
|
4849
|
-
export declare interface PBGltfNodeState {
|
4850
|
-
state: GltfNodeStateValue;
|
4851
|
-
error?: string | undefined;
|
4852
|
-
}
|
4853
|
-
|
4854
|
-
/**
|
4855
|
-
* @public
|
4856
|
-
*/
|
4857
|
-
export declare namespace PBGltfNodeState {
|
4858
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4859
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4860
|
-
}
|
4861
|
-
|
4862
4513
|
/**
|
4863
4514
|
* @public
|
4864
4515
|
*/
|
@@ -4898,62 +4549,6 @@ export declare namespace PBInputModifier_StandardInput {
|
|
4898
4549
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4899
4550
|
}
|
4900
4551
|
|
4901
|
-
/**
|
4902
|
-
* defines a light source.
|
4903
|
-
* the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
|
4904
|
-
* a PBGlobalLight component can also be added to the root to control the directional light direction.
|
4905
|
-
* point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
|
4906
|
-
*/
|
4907
|
-
/**
|
4908
|
-
* @public
|
4909
|
-
*/
|
4910
|
-
export declare interface PBLight {
|
4911
|
-
/**
|
4912
|
-
* whether the light is on
|
4913
|
-
* default true
|
4914
|
-
*/
|
4915
|
-
enabled?: boolean | undefined;
|
4916
|
-
/**
|
4917
|
-
* light brightness in lux (lumens/m^2).
|
4918
|
-
*
|
4919
|
-
* for global directional light, this applies as a constant value at all surfaces and distances (though the effect on the surface still depends on incidence angle).
|
4920
|
-
* the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
|
4921
|
-
* for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
|
4922
|
-
*
|
4923
|
-
* for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
|
4924
|
-
* divide lumens by ~12 (4*pi).
|
4925
|
-
* e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
|
4926
|
-
* a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
|
4927
|
-
*
|
4928
|
-
* default
|
4929
|
-
* for point/spotlights: 10,000
|
4930
|
-
* for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
|
4931
|
-
*/
|
4932
|
-
illuminance?: number | undefined;
|
4933
|
-
/**
|
4934
|
-
* whether the light should cast shadows.
|
4935
|
-
* note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
|
4936
|
-
* of lights depending on the implementation, platform, and user settings.
|
4937
|
-
* default
|
4938
|
-
* for point/spotlights: false / off
|
4939
|
-
* for global directional light: true / on
|
4940
|
-
*/
|
4941
|
-
shadows?: boolean | undefined;
|
4942
|
-
/**
|
4943
|
-
* light color
|
4944
|
-
* default White
|
4945
|
-
*/
|
4946
|
-
color?: PBColor3 | undefined;
|
4947
|
-
}
|
4948
|
-
|
4949
|
-
/**
|
4950
|
-
* @public
|
4951
|
-
*/
|
4952
|
-
export declare namespace PBLight {
|
4953
|
-
export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
|
4954
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
|
4955
|
-
}
|
4956
|
-
|
4957
4552
|
/**
|
4958
4553
|
* PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
|
4959
4554
|
* This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
|
@@ -4985,14 +4580,6 @@ export declare interface PBMaterial {
|
|
4985
4580
|
$case: "pbr";
|
4986
4581
|
pbr: PBMaterial_PbrMaterial;
|
4987
4582
|
} | undefined;
|
4988
|
-
/**
|
4989
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
4990
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
4991
|
-
* supported by the PbMaterial.
|
4992
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
4993
|
-
* field with data that reflects the gltf material once it is loaded.
|
4994
|
-
*/
|
4995
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
4996
4583
|
}
|
4997
4584
|
|
4998
4585
|
/**
|
@@ -5003,22 +4590,6 @@ export declare namespace PBMaterial {
|
|
5003
4590
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
5004
4591
|
}
|
5005
4592
|
|
5006
|
-
/**
|
5007
|
-
* @public
|
5008
|
-
*/
|
5009
|
-
export declare interface PBMaterial_GltfMaterial {
|
5010
|
-
gltfSrc: string;
|
5011
|
-
name: string;
|
5012
|
-
}
|
5013
|
-
|
5014
|
-
/**
|
5015
|
-
* @public
|
5016
|
-
*/
|
5017
|
-
export declare namespace PBMaterial_GltfMaterial {
|
5018
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
5019
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
5020
|
-
}
|
5021
|
-
|
5022
4593
|
/**
|
5023
4594
|
* @public
|
5024
4595
|
*/
|
@@ -5115,9 +4686,6 @@ export declare interface PBMeshCollider {
|
|
5115
4686
|
} | {
|
5116
4687
|
$case: "plane";
|
5117
4688
|
plane: PBMeshCollider_PlaneMesh;
|
5118
|
-
} | {
|
5119
|
-
$case: "gltf";
|
5120
|
-
gltf: PBMeshCollider_GltfMesh;
|
5121
4689
|
} | undefined;
|
5122
4690
|
}
|
5123
4691
|
|
@@ -5163,25 +4731,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
5163
4731
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
5164
4732
|
}
|
5165
4733
|
|
5166
|
-
/** A collider constructed from a Gltf Mesh. */
|
5167
|
-
/**
|
5168
|
-
* @public
|
5169
|
-
*/
|
5170
|
-
export declare interface PBMeshCollider_GltfMesh {
|
5171
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5172
|
-
gltfSrc: string;
|
5173
|
-
/** the name of the mesh asset */
|
5174
|
-
name: string;
|
5175
|
-
}
|
5176
|
-
|
5177
|
-
/**
|
5178
|
-
* @public
|
5179
|
-
*/
|
5180
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
5181
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5182
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5183
|
-
}
|
5184
|
-
|
5185
4734
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
5186
4735
|
/**
|
5187
4736
|
* @public
|
@@ -5214,11 +4763,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
5214
4763
|
|
5215
4764
|
/**
|
5216
4765
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
5217
|
-
* plane, a sphere
|
4766
|
+
* plane, a sphere or a cylinder.
|
5218
4767
|
*
|
5219
4768
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
5220
4769
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
5221
4770
|
* `float` coordinates, one for each corner of each side of each face.
|
4771
|
+
*
|
4772
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
5222
4773
|
*/
|
5223
4774
|
/**
|
5224
4775
|
* @public
|
@@ -5236,9 +4787,6 @@ export declare interface PBMeshRenderer {
|
|
5236
4787
|
} | {
|
5237
4788
|
$case: "plane";
|
5238
4789
|
plane: PBMeshRenderer_PlaneMesh;
|
5239
|
-
} | {
|
5240
|
-
$case: "gltf";
|
5241
|
-
gltf: PBMeshRenderer_GltfMesh;
|
5242
4790
|
} | undefined;
|
5243
4791
|
}
|
5244
4792
|
|
@@ -5286,25 +4834,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
5286
4834
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
5287
4835
|
}
|
5288
4836
|
|
5289
|
-
/** A mesh from a Gltf. */
|
5290
|
-
/**
|
5291
|
-
* @public
|
5292
|
-
*/
|
5293
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
5294
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5295
|
-
gltfSrc: string;
|
5296
|
-
/** the name of the mesh asset */
|
5297
|
-
name: string;
|
5298
|
-
}
|
5299
|
-
|
5300
|
-
/**
|
5301
|
-
* @public
|
5302
|
-
*/
|
5303
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
5304
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5305
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5306
|
-
}
|
5307
|
-
|
5308
4837
|
/** PlaneMesh renders a 2D rectangular shape. */
|
5309
4838
|
/**
|
5310
4839
|
* @public
|
@@ -5523,30 +5052,6 @@ export declare namespace PBPosition {
|
|
5523
5052
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
|
5524
5053
|
}
|
5525
5054
|
|
5526
|
-
/**
|
5527
|
-
* @public
|
5528
|
-
*/
|
5529
|
-
export declare interface PBPrimaryPointerInfo {
|
5530
|
-
pointerType?: PointerType | undefined;
|
5531
|
-
/** in pixels */
|
5532
|
-
screenCoordinates?: PBVector2 | undefined;
|
5533
|
-
/** in pixels */
|
5534
|
-
screenDelta?: PBVector2 | undefined;
|
5535
|
-
/**
|
5536
|
-
* ray direction that can be used with the primary camera origin for
|
5537
|
-
* raycasting from the cursor into the world
|
5538
|
-
*/
|
5539
|
-
worldRayDirection?: PBVector3 | undefined;
|
5540
|
-
}
|
5541
|
-
|
5542
|
-
/**
|
5543
|
-
* @public
|
5544
|
-
*/
|
5545
|
-
export declare namespace PBPrimaryPointerInfo {
|
5546
|
-
export function encode(message: PBPrimaryPointerInfo, writer?: _m0.Writer): _m0.Writer;
|
5547
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPrimaryPointerInfo;
|
5548
|
-
}
|
5549
|
-
|
5550
5055
|
/**
|
5551
5056
|
* @public
|
5552
5057
|
*/
|
@@ -5668,39 +5173,6 @@ export declare namespace PBRealmInfo {
|
|
5668
5173
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5669
5174
|
}
|
5670
5175
|
|
5671
|
-
/**
|
5672
|
-
* defines a spotlight.
|
5673
|
-
* spotlights are point lights that emit light only in a cone around the transform's forward direction.
|
5674
|
-
* add this component together with the PBLight component to transform a point light into a spotlight.
|
5675
|
-
* note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
|
5676
|
-
* so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
|
5677
|
-
* a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
|
5678
|
-
* and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
|
5679
|
-
*/
|
5680
|
-
/**
|
5681
|
-
* @public
|
5682
|
-
*/
|
5683
|
-
export declare interface PBSpotlight {
|
5684
|
-
/**
|
5685
|
-
* the cone radius in radians. distance away from forward in which the light is visible.
|
5686
|
-
* for a torch a value around 0.15 is appropriate.
|
5687
|
-
*/
|
5688
|
-
angle: number;
|
5689
|
-
/**
|
5690
|
-
* optional angle at which the light is brightest. should be <= outer angle.
|
5691
|
-
* if specified, the light will fall off smoothly between `inner_angle` and `angle`.
|
5692
|
-
*/
|
5693
|
-
innerAngle?: number | undefined;
|
5694
|
-
}
|
5695
|
-
|
5696
|
-
/**
|
5697
|
-
* @public
|
5698
|
-
*/
|
5699
|
-
export declare namespace PBSpotlight {
|
5700
|
-
export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
|
5701
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
|
5702
|
-
}
|
5703
|
-
|
5704
5176
|
/**
|
5705
5177
|
* The TextShape component renders customizable floating text.
|
5706
5178
|
*
|
@@ -5765,46 +5237,6 @@ export declare namespace PBTextShape {
|
|
5765
5237
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5766
5238
|
}
|
5767
5239
|
|
5768
|
-
/**
|
5769
|
-
* @public
|
5770
|
-
*/
|
5771
|
-
export declare interface PBTextureCamera {
|
5772
|
-
/** rendered texture width */
|
5773
|
-
width?: number | undefined;
|
5774
|
-
/** rendered texture height */
|
5775
|
-
height?: number | undefined;
|
5776
|
-
/**
|
5777
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5778
|
-
* defaults to 0
|
5779
|
-
*/
|
5780
|
-
layer?: number | undefined;
|
5781
|
-
/** default black */
|
5782
|
-
clearColor?: PBColor4 | undefined;
|
5783
|
-
/** default infinity */
|
5784
|
-
farPlane?: number | undefined;
|
5785
|
-
mode?: {
|
5786
|
-
$case: "perspective";
|
5787
|
-
perspective: Perspective;
|
5788
|
-
} | {
|
5789
|
-
$case: "orthographic";
|
5790
|
-
orthographic: Orthographic;
|
5791
|
-
} | undefined;
|
5792
|
-
/**
|
5793
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
5794
|
-
* range: 0 (off) - 1 (full volume)
|
5795
|
-
* default: 0
|
5796
|
-
*/
|
5797
|
-
volume?: number | undefined;
|
5798
|
-
}
|
5799
|
-
|
5800
|
-
/**
|
5801
|
-
* @public
|
5802
|
-
*/
|
5803
|
-
export declare namespace PBTextureCamera {
|
5804
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5805
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5806
|
-
}
|
5807
|
-
|
5808
5240
|
/**
|
5809
5241
|
* @public
|
5810
5242
|
*/
|
@@ -5894,25 +5326,6 @@ export declare namespace PBUiBackground {
|
|
5894
5326
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5895
5327
|
}
|
5896
5328
|
|
5897
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5898
|
-
/**
|
5899
|
-
* @public
|
5900
|
-
*/
|
5901
|
-
export declare interface PBUiCanvas {
|
5902
|
-
width: number;
|
5903
|
-
height: number;
|
5904
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5905
|
-
color?: PBColor4 | undefined;
|
5906
|
-
}
|
5907
|
-
|
5908
|
-
/**
|
5909
|
-
* @public
|
5910
|
-
*/
|
5911
|
-
export declare namespace PBUiCanvas {
|
5912
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5913
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5914
|
-
}
|
5915
|
-
|
5916
5329
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5917
5330
|
/**
|
5918
5331
|
* @public
|
@@ -6029,21 +5442,6 @@ export declare namespace PBUiInputResult {
|
|
6029
5442
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
6030
5443
|
}
|
6031
5444
|
|
6032
|
-
/**
|
6033
|
-
* @public
|
6034
|
-
*/
|
6035
|
-
export declare interface PBUiScrollResult {
|
6036
|
-
value: PBVector2 | undefined;
|
6037
|
-
}
|
6038
|
-
|
6039
|
-
/**
|
6040
|
-
* @public
|
6041
|
-
*/
|
6042
|
-
export declare namespace PBUiScrollResult {
|
6043
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
6044
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
6045
|
-
}
|
6046
|
-
|
6047
5445
|
/**
|
6048
5446
|
* @public
|
6049
5447
|
*/
|
@@ -6060,10 +5458,6 @@ export declare interface PBUiText {
|
|
6060
5458
|
fontSize?: number | undefined;
|
6061
5459
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
6062
5460
|
textWrap?: TextWrap | undefined;
|
6063
|
-
/** width of the outline (default: 0) */
|
6064
|
-
outlineWidth?: number | undefined;
|
6065
|
-
/** RGBA color of the outline (default: opaque black) */
|
6066
|
-
outlineColor?: PBColor4 | undefined;
|
6067
5461
|
}
|
6068
5462
|
|
6069
5463
|
/**
|
@@ -6189,16 +5583,6 @@ export declare interface PBUiTransform {
|
|
6189
5583
|
borderBottomColor?: PBColor4 | undefined;
|
6190
5584
|
borderLeftColor?: PBColor4 | undefined;
|
6191
5585
|
borderRightColor?: PBColor4 | undefined;
|
6192
|
-
/** default: 1 */
|
6193
|
-
opacity?: number | undefined;
|
6194
|
-
/** reference for scroll_position. default empty */
|
6195
|
-
elementId?: string | undefined;
|
6196
|
-
/** default position=(0,0) */
|
6197
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
6198
|
-
/** default ShowScrollBar.SSB_BOTH */
|
6199
|
-
scrollVisible?: ShowScrollBar | undefined;
|
6200
|
-
/** default 0 */
|
6201
|
-
zIndex?: number | undefined;
|
6202
5586
|
}
|
6203
5587
|
|
6204
5588
|
/**
|
@@ -6328,25 +5712,6 @@ export declare namespace PBVisibilityComponent {
|
|
6328
5712
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
6329
5713
|
}
|
6330
5714
|
|
6331
|
-
/**
|
6332
|
-
* @public
|
6333
|
-
*/
|
6334
|
-
export declare interface Perspective {
|
6335
|
-
/**
|
6336
|
-
* vertical field of view in radians
|
6337
|
-
* defaults to pi/4 = 45 degrees
|
6338
|
-
*/
|
6339
|
-
fieldOfView?: number | undefined;
|
6340
|
-
}
|
6341
|
-
|
6342
|
-
/**
|
6343
|
-
* @public
|
6344
|
-
*/
|
6345
|
-
export declare namespace Perspective {
|
6346
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6347
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6348
|
-
}
|
6349
|
-
|
6350
5715
|
/**
|
6351
5716
|
* Represens a plane by the equation ax + by + cz + d = 0
|
6352
5717
|
* @public
|
@@ -6502,24 +5867,6 @@ export declare interface PointerEventsSystem {
|
|
6502
5867
|
* @param entity - Entity where the callback was attached
|
6503
5868
|
*/
|
6504
5869
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6505
|
-
/**
|
6506
|
-
* @public
|
6507
|
-
* Remove the callback for onPointerDrag event
|
6508
|
-
* @param entity - Entity where the callback was attached
|
6509
|
-
*/
|
6510
|
-
removeOnPointerDrag(entity: Entity): void;
|
6511
|
-
/**
|
6512
|
-
* @public
|
6513
|
-
* Remove the callback for onPointerDragLocked event
|
6514
|
-
* @param entity - Entity where the callback was attached
|
6515
|
-
*/
|
6516
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
6517
|
-
/**
|
6518
|
-
* @public
|
6519
|
-
* Remove the callback for onPointerDragEnd event
|
6520
|
-
* @param entity - Entity where the callback was attached
|
6521
|
-
*/
|
6522
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
6523
5870
|
/**
|
6524
5871
|
* @public
|
6525
5872
|
* Execute callback when the user press the InputButton pointing at the entity
|
@@ -6574,37 +5921,6 @@ export declare interface PointerEventsSystem {
|
|
6574
5921
|
entity: Entity;
|
6575
5922
|
opts?: Partial<EventSystemOptions>;
|
6576
5923
|
}, cb: EventSystemCallback): void;
|
6577
|
-
/**
|
6578
|
-
* @public
|
6579
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6580
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6581
|
-
* @param cb - Function to execute when click fires
|
6582
|
-
*/
|
6583
|
-
onPointerDrag(pointerData: {
|
6584
|
-
entity: Entity;
|
6585
|
-
opts?: Partial<EventSystemOptions>;
|
6586
|
-
}, cb: EventSystemCallback): void;
|
6587
|
-
/**
|
6588
|
-
* @public
|
6589
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6590
|
-
* locking the cursor in place
|
6591
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6592
|
-
* @param cb - Function to execute when click fires
|
6593
|
-
*/
|
6594
|
-
onPointerDragLocked(pointerData: {
|
6595
|
-
entity: Entity;
|
6596
|
-
opts?: Partial<EventSystemOptions>;
|
6597
|
-
}, cb: EventSystemCallback): void;
|
6598
|
-
/**
|
6599
|
-
* @public
|
6600
|
-
* Execute callback when the user releases the button after a drag
|
6601
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6602
|
-
* @param cb - Function to execute when click fires
|
6603
|
-
*/
|
6604
|
-
onPointerDragEnd(pointerData: {
|
6605
|
-
entity: Entity;
|
6606
|
-
opts?: Partial<EventSystemOptions>;
|
6607
|
-
}, cb: EventSystemCallback): void;
|
6608
5924
|
}
|
6609
5925
|
|
6610
5926
|
/**
|
@@ -6621,10 +5937,7 @@ export declare const enum PointerEventType {
|
|
6621
5937
|
PET_UP = 0,
|
6622
5938
|
PET_DOWN = 1,
|
6623
5939
|
PET_HOVER_ENTER = 2,
|
6624
|
-
PET_HOVER_LEAVE = 3
|
6625
|
-
PET_DRAG_LOCKED = 4,
|
6626
|
-
PET_DRAG = 5,
|
6627
|
-
PET_DRAG_END = 6
|
5940
|
+
PET_HOVER_LEAVE = 3
|
6628
5941
|
}
|
6629
5942
|
|
6630
5943
|
/**
|
@@ -6644,17 +5957,6 @@ export declare type PointerFilterType = 'none' | 'block';
|
|
6644
5957
|
/** @public */
|
6645
5958
|
export declare const PointerLock: LastWriteWinElementSetComponentDefinition<PBPointerLock>;
|
6646
5959
|
|
6647
|
-
/**
|
6648
|
-
* @public
|
6649
|
-
*/
|
6650
|
-
export declare const enum PointerType {
|
6651
|
-
POT_NONE = 0,
|
6652
|
-
POT_MOUSE = 1,
|
6653
|
-
POT_PAD = 2,
|
6654
|
-
POT_TOUCH = 3,
|
6655
|
-
POT_WAND = 4
|
6656
|
-
}
|
6657
|
-
|
6658
5960
|
/**
|
6659
5961
|
* Type used for defining the position of the element. i.e. margin, padding
|
6660
5962
|
* @public
|
@@ -6692,9 +5994,6 @@ export declare type PositionType = 'absolute' | 'relative';
|
|
6692
5994
|
*/
|
6693
5995
|
export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
|
6694
5996
|
|
6695
|
-
/** @public */
|
6696
|
-
export declare const PrimaryPointerInfo: LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>;
|
6697
|
-
|
6698
5997
|
export declare enum ProcessMessageResultType {
|
6699
5998
|
/**
|
6700
5999
|
* Typical message and new state set.
|
@@ -7249,7 +6548,6 @@ export declare type RaycastSystemOptions = {
|
|
7249
6548
|
export declare interface ReactBasedUiSystem {
|
7250
6549
|
destroy(): void;
|
7251
6550
|
setUiRenderer(ui: UiComponent): void;
|
7252
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
7253
6551
|
}
|
7254
6552
|
|
7255
6553
|
/**
|
@@ -7280,6 +6578,15 @@ export declare namespace ReactEcs {
|
|
7280
6578
|
}
|
7281
6579
|
}
|
7282
6580
|
const createElement: any;
|
6581
|
+
export type SetStateAction<T> = T | ((prevState: T) => T);
|
6582
|
+
export type Dispatch<T> = (action: SetStateAction<T>) => void;
|
6583
|
+
export type StateHook = <T>(initialState: T | (() => T)) => [T, Dispatch<T>];
|
6584
|
+
export type DependencyList = ReadonlyArray<any>;
|
6585
|
+
export type EffectCallback = () => void | (() => void | undefined);
|
6586
|
+
export type EffectHook = (effect: EffectCallback, deps?: DependencyList) => void;
|
6587
|
+
const useEffect: EffectHook;
|
6588
|
+
const useState: StateHook;
|
6589
|
+
{};
|
7283
6590
|
}
|
7284
6591
|
|
7285
6592
|
/**
|
@@ -7703,43 +7010,6 @@ export declare namespace Schemas {
|
|
7703
7010
|
}) => void;
|
7704
7011
|
}
|
7705
7012
|
|
7706
|
-
/**
|
7707
|
-
* @public
|
7708
|
-
*/
|
7709
|
-
export declare interface ScrollPositionValue {
|
7710
|
-
value?: {
|
7711
|
-
$case: "position";
|
7712
|
-
position: PBVector2;
|
7713
|
-
} | {
|
7714
|
-
$case: "reference";
|
7715
|
-
reference: string;
|
7716
|
-
} | undefined;
|
7717
|
-
}
|
7718
|
-
|
7719
|
-
/**
|
7720
|
-
* @public
|
7721
|
-
*/
|
7722
|
-
export declare namespace ScrollPositionValue {
|
7723
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7724
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7725
|
-
}
|
7726
|
-
|
7727
|
-
/**
|
7728
|
-
* @public
|
7729
|
-
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7730
|
-
*/
|
7731
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7732
|
-
|
7733
|
-
/**
|
7734
|
-
* @public
|
7735
|
-
*/
|
7736
|
-
export declare const enum ShowScrollBar {
|
7737
|
-
SSB_BOTH = 0,
|
7738
|
-
SSB_ONLY_VERTICAL = 1,
|
7739
|
-
SSB_ONLY_HORIZONTAL = 2,
|
7740
|
-
SSB_HIDDEN = 3
|
7741
|
-
}
|
7742
|
-
|
7743
7013
|
/**
|
7744
7014
|
* @public
|
7745
7015
|
*/
|
@@ -7747,9 +7017,6 @@ export declare interface Spec {
|
|
7747
7017
|
[key: string]: ISchema;
|
7748
7018
|
}
|
7749
7019
|
|
7750
|
-
/** @public */
|
7751
|
-
export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
|
7752
|
-
|
7753
7020
|
/**
|
7754
7021
|
* @alpha
|
7755
7022
|
* This is going to be used for sync components through a server.
|
@@ -7824,9 +7091,6 @@ export declare namespace Texture {
|
|
7824
7091
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7825
7092
|
}
|
7826
7093
|
|
7827
|
-
/** @public */
|
7828
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7829
|
-
|
7830
7094
|
/**
|
7831
7095
|
* @public
|
7832
7096
|
*/
|
@@ -7919,9 +7183,6 @@ export declare interface TextureUnion {
|
|
7919
7183
|
} | {
|
7920
7184
|
$case: "videoTexture";
|
7921
7185
|
videoTexture: VideoTexture;
|
7922
|
-
} | {
|
7923
|
-
$case: "uiTexture";
|
7924
|
-
uiTexture: UiCanvasTexture;
|
7925
7186
|
} | undefined;
|
7926
7187
|
}
|
7927
7188
|
|
@@ -8129,8 +7390,6 @@ export declare interface UiBackgroundProps {
|
|
8129
7390
|
uvs?: number[];
|
8130
7391
|
/** AvatarTexture for the background */
|
8131
7392
|
avatarTexture?: UiAvatarTexture;
|
8132
|
-
/** VideoTexture for the background */
|
8133
|
-
videoTexture?: UiVideoTexture;
|
8134
7393
|
/** Texture for the background */
|
8135
7394
|
texture?: UiTexture;
|
8136
7395
|
}
|
@@ -8150,31 +7409,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
8150
7409
|
disabled?: boolean;
|
8151
7410
|
}
|
8152
7411
|
|
8153
|
-
/** @public */
|
8154
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8155
|
-
|
8156
7412
|
/** @public */
|
8157
7413
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
8158
7414
|
|
8159
|
-
/**
|
8160
|
-
* @public
|
8161
|
-
*/
|
8162
|
-
export declare interface UiCanvasTexture {
|
8163
|
-
uiCanvasEntity: number;
|
8164
|
-
/** default = TextureWrapMode.Clamp */
|
8165
|
-
wrapMode?: TextureWrapMode | undefined;
|
8166
|
-
/** default = FilterMode.Bilinear */
|
8167
|
-
filterMode?: TextureFilterMode | undefined;
|
8168
|
-
}
|
8169
|
-
|
8170
|
-
/**
|
8171
|
-
* @public
|
8172
|
-
*/
|
8173
|
-
export declare namespace UiCanvasTexture {
|
8174
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8175
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8176
|
-
}
|
8177
|
-
|
8178
7415
|
/**
|
8179
7416
|
* @public
|
8180
7417
|
*/
|
@@ -8244,10 +7481,6 @@ export declare interface UiLabelProps {
|
|
8244
7481
|
textAlign?: TextAlignType | undefined;
|
8245
7482
|
/** Label font type. @defaultValue 'sans-serif' */
|
8246
7483
|
font?: UiFontType | undefined;
|
8247
|
-
/** Outline width of the text. @defaultValue 0 */
|
8248
|
-
outlineWidth?: number | undefined;
|
8249
|
-
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8250
|
-
outlineColor?: PBColor4 | undefined;
|
8251
7484
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
8252
7485
|
textWrap?: UiTextWrapType | undefined;
|
8253
7486
|
}
|
@@ -8257,9 +7490,6 @@ export declare interface UiLabelProps {
|
|
8257
7490
|
*/
|
8258
7491
|
export declare type uint32 = number;
|
8259
7492
|
|
8260
|
-
/** @public */
|
8261
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8262
|
-
|
8263
7493
|
/** @public */
|
8264
7494
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
8265
7495
|
|
@@ -8335,26 +7565,6 @@ export declare interface UiTransformProps {
|
|
8335
7565
|
borderColor?: Record<keyof Partial<Position>, PBColor4> | PBColor4 | undefined;
|
8336
7566
|
borderRadius?: Partial<BorderRadius> | PositionUnit;
|
8337
7567
|
borderWidth?: Partial<Position> | PositionUnit;
|
8338
|
-
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
8339
|
-
opacity?: number;
|
8340
|
-
/** A reference value to identify the element, default empty */
|
8341
|
-
elementId?: string;
|
8342
|
-
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8343
|
-
scrollPosition?: PBVector2 | string;
|
8344
|
-
/** default ShowScrollBar.SSB_BOTH */
|
8345
|
-
scrollVisible?: ScrollVisibleType;
|
8346
|
-
/** default 0 */
|
8347
|
-
zIndex?: number;
|
8348
|
-
}
|
8349
|
-
|
8350
|
-
/**
|
8351
|
-
* Texture
|
8352
|
-
* @public
|
8353
|
-
*/
|
8354
|
-
export declare interface UiVideoTexture {
|
8355
|
-
videoPlayerEntity: Entity;
|
8356
|
-
wrapMode?: TextureWrapType;
|
8357
|
-
filterMode?: TextureFilterType;
|
8358
7568
|
}
|
8359
7569
|
|
8360
7570
|
/**
|