@dcl/playground-assets 7.20.1-21915113771.commit-e132905 → 7.20.1-21975617794.commit-7189140
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 +119 -830
- package/dist/beta.d.ts +119 -830
- package/dist/index.bundled.d.ts +119 -830
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/apis.d.ts +0 -17
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +119 -830
- package/etc/playground-assets.api.json +5283 -12296
- package/etc/playground-assets.api.md +89 -544
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
|
@@ -163,6 +163,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
163
163
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
164
164
|
}
|
|
165
165
|
|
|
166
|
+
/**
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
173
|
+
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
174
|
+
*
|
|
175
|
+
* @param entity - Uint32 number of the entity
|
|
176
|
+
* @param componentId - Uint32 number of id
|
|
177
|
+
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
178
|
+
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
export declare type AuthoritativePutComponentMessageBody = {
|
|
182
|
+
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
183
|
+
entityId: Entity;
|
|
184
|
+
componentId: number;
|
|
185
|
+
timestamp: number;
|
|
186
|
+
data: Uint8Array;
|
|
187
|
+
};
|
|
188
|
+
|
|
189
|
+
/**
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
export declare namespace AuthoritativePutComponentOperation {
|
|
193
|
+
const MESSAGE_HEADER_LENGTH = 16;
|
|
194
|
+
/**
|
|
195
|
+
* Call this function for an optimal writing data passing the ByteBuffer
|
|
196
|
+
* already allocated
|
|
197
|
+
*/
|
|
198
|
+
export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
199
|
+
export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
200
|
+
}
|
|
201
|
+
|
|
166
202
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
167
203
|
/**
|
|
168
204
|
* @public
|
|
@@ -203,36 +239,12 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
|
|
|
203
239
|
/** @public */
|
|
204
240
|
export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
|
|
205
241
|
|
|
206
|
-
/**
|
|
207
|
-
* @public
|
|
208
|
-
*/
|
|
209
|
-
export declare const enum AvatarControlType {
|
|
210
|
-
/** CCT_NONE - avatar cannot move */
|
|
211
|
-
CCT_NONE = 0,
|
|
212
|
-
/** CCT_RELATIVE - avatar moves relative to the camera origin */
|
|
213
|
-
CCT_RELATIVE = 1,
|
|
214
|
-
/** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
|
|
215
|
-
CCT_TANK = 2
|
|
216
|
-
}
|
|
217
|
-
|
|
218
242
|
/** @public */
|
|
219
243
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
220
244
|
|
|
221
245
|
/** @public */
|
|
222
246
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
223
247
|
|
|
224
|
-
/**
|
|
225
|
-
* @public
|
|
226
|
-
*/
|
|
227
|
-
export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
|
|
228
|
-
|
|
229
|
-
export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
|
|
230
|
-
forceRender?: string[] | undefined;
|
|
231
|
-
};
|
|
232
|
-
|
|
233
|
-
/** @public */
|
|
234
|
-
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
235
|
-
|
|
236
248
|
/** @public */
|
|
237
249
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
238
250
|
|
|
@@ -247,49 +259,9 @@ export declare const enum AvatarModifierType {
|
|
|
247
259
|
AMT_DISABLE_PASSPORTS = 1
|
|
248
260
|
}
|
|
249
261
|
|
|
250
|
-
/**
|
|
251
|
-
* @public
|
|
252
|
-
*/
|
|
253
|
-
export declare interface AvatarMovementSettings {
|
|
254
|
-
controlMode?: AvatarControlType | undefined;
|
|
255
|
-
/** if not explicitly set, the following properties default to user's preference settings */
|
|
256
|
-
runSpeed?: number | undefined;
|
|
257
|
-
/** how fast the player gets up to speed or comes to rest. higher = more responsive */
|
|
258
|
-
friction?: number | undefined;
|
|
259
|
-
/** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
|
|
260
|
-
gravity?: number | undefined;
|
|
261
|
-
/** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
|
|
262
|
-
jumpHeight?: number | undefined;
|
|
263
|
-
/** max fall speed in m/s. should normally be negative */
|
|
264
|
-
maxFallSpeed?: number | undefined;
|
|
265
|
-
/** speed the player turns in tank mode, in radians/s */
|
|
266
|
-
turnSpeed?: number | undefined;
|
|
267
|
-
/** speed the player walks at, in m/s */
|
|
268
|
-
walkSpeed?: number | undefined;
|
|
269
|
-
/** 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 */
|
|
270
|
-
allowWeightedMovement?: boolean | undefined;
|
|
271
|
-
}
|
|
272
|
-
|
|
273
|
-
/**
|
|
274
|
-
* @public
|
|
275
|
-
*/
|
|
276
|
-
export declare namespace AvatarMovementSettings {
|
|
277
|
-
export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
|
|
278
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
|
279
|
-
}
|
|
280
|
-
|
|
281
262
|
/** @public */
|
|
282
263
|
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
|
283
264
|
|
|
284
|
-
/**
|
|
285
|
-
* @public
|
|
286
|
-
*/
|
|
287
|
-
export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
|
|
288
|
-
|
|
289
|
-
export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
|
|
290
|
-
forceRender?: string[] | undefined;
|
|
291
|
-
};
|
|
292
|
-
|
|
293
265
|
/**
|
|
294
266
|
* @public
|
|
295
267
|
*/
|
|
@@ -386,6 +358,22 @@ export declare interface BaseComponent<T> {
|
|
|
386
358
|
* If the value is undefined, the component was deleted.
|
|
387
359
|
*/
|
|
388
360
|
onChange(entity: Entity, cb: (value: T | undefined) => void): void;
|
|
361
|
+
/**
|
|
362
|
+
* @public
|
|
363
|
+
*
|
|
364
|
+
*/
|
|
365
|
+
validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
|
|
366
|
+
validateBeforeChange(cb: ValidateCallback<T>): void;
|
|
367
|
+
/**
|
|
368
|
+
* Get the CRDT state for an entity (serialized data and timestamp)
|
|
369
|
+
* @param entity - Entity to get the CRDT state for
|
|
370
|
+
* @returns Object with serialized data and timestamp, or null if entity doesn't have the component
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
373
|
+
getCrdtState(entity: Entity): {
|
|
374
|
+
data: Uint8Array;
|
|
375
|
+
timestamp: number;
|
|
376
|
+
} | null;
|
|
389
377
|
}
|
|
390
378
|
|
|
391
379
|
/** @public */
|
|
@@ -557,19 +545,11 @@ export declare interface ByteBuffer {
|
|
|
557
545
|
}
|
|
558
546
|
|
|
559
547
|
/**
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
* @public @deprecated This type is no longer used in the sdk api, EventSystemCallback is
|
|
563
|
-
* used for listeners instead
|
|
548
|
+
* Callback function to be triggered on a specified event
|
|
549
|
+
* @public
|
|
564
550
|
*/
|
|
565
551
|
export declare type Callback = () => void;
|
|
566
552
|
|
|
567
|
-
/** @public */
|
|
568
|
-
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
|
569
|
-
|
|
570
|
-
/** @public */
|
|
571
|
-
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
|
572
|
-
|
|
573
553
|
/** @public */
|
|
574
554
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
|
575
555
|
|
|
@@ -627,39 +607,6 @@ export declare const enum CameraType {
|
|
|
627
607
|
|
|
628
608
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
|
629
609
|
|
|
630
|
-
/**
|
|
631
|
-
* @public
|
|
632
|
-
*/
|
|
633
|
-
export declare interface CinematicSettings {
|
|
634
|
-
/** Entity that defines the cinematic camera transform. */
|
|
635
|
-
cameraEntity: number;
|
|
636
|
-
/**
|
|
637
|
-
* Position -> camera's position
|
|
638
|
-
* Rotation -> camera's direction
|
|
639
|
-
* scale.z -> zoom level
|
|
640
|
-
* scale.x and scale.y -> unused
|
|
641
|
-
*/
|
|
642
|
-
allowManualRotation?: boolean | undefined;
|
|
643
|
-
/** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
|
|
644
|
-
yawRange?: number | undefined;
|
|
645
|
-
/** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
|
|
646
|
-
pitchRange?: number | undefined;
|
|
647
|
-
/** note: cameras can never look up/down further than Vec3::Y */
|
|
648
|
-
rollRange?: number | undefined;
|
|
649
|
-
/** minimum zoom level. must be greater than 0. defaults to the input zoom level */
|
|
650
|
-
zoomMin?: number | undefined;
|
|
651
|
-
/** maximum zoom level. must be greater than 0. defaults to the input zoom level */
|
|
652
|
-
zoomMax?: number | undefined;
|
|
653
|
-
}
|
|
654
|
-
|
|
655
|
-
/**
|
|
656
|
-
* @public
|
|
657
|
-
*/
|
|
658
|
-
export declare namespace CinematicSettings {
|
|
659
|
-
export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
|
|
660
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
|
|
661
|
-
}
|
|
662
|
-
|
|
663
610
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
|
664
611
|
/**
|
|
665
612
|
* @public
|
|
@@ -1433,21 +1380,15 @@ export declare const componentDefinitionByName: {
|
|
|
1433
1380
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1434
1381
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1435
1382
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1436
|
-
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1437
1383
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1438
1384
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1439
1385
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
1440
|
-
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
|
1441
|
-
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
|
1442
1386
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
|
1443
1387
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
|
1444
1388
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
|
1445
|
-
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
|
1446
1389
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
|
1447
1390
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
|
1448
|
-
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
|
1449
1391
|
"core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
|
|
1450
|
-
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
|
1451
1392
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
|
1452
1393
|
"core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
|
|
1453
1394
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
|
@@ -1465,20 +1406,17 @@ export declare const componentDefinitionByName: {
|
|
|
1465
1406
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1466
1407
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1467
1408
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1468
|
-
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
|
1469
1409
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1470
1410
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
1471
1411
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
|
1472
1412
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
|
1473
1413
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
|
1474
1414
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
|
1475
|
-
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
|
1476
1415
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
|
1477
1416
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1478
1417
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1479
1418
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1480
1419
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1481
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
|
1482
1420
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1483
1421
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
1484
1422
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
|
@@ -1644,12 +1582,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1644
1582
|
/**
|
|
1645
1583
|
* @public
|
|
1646
1584
|
*/
|
|
1647
|
-
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1585
|
+
export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1648
1586
|
|
|
1649
1587
|
/**
|
|
1650
1588
|
* @public
|
|
1651
1589
|
*/
|
|
1652
|
-
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1590
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1653
1591
|
|
|
1654
1592
|
/**
|
|
1655
1593
|
* Min length = 8 bytes
|
|
@@ -1704,7 +1642,8 @@ export declare enum CrdtMessageType {
|
|
|
1704
1642
|
PUT_COMPONENT_NETWORK = 5,
|
|
1705
1643
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1706
1644
|
DELETE_ENTITY_NETWORK = 7,
|
|
1707
|
-
|
|
1645
|
+
AUTHORITATIVE_PUT_COMPONENT = 8,
|
|
1646
|
+
MAX_MESSAGE_TYPE = 9
|
|
1708
1647
|
}
|
|
1709
1648
|
|
|
1710
1649
|
/**
|
|
@@ -1712,6 +1651,8 @@ export declare enum CrdtMessageType {
|
|
|
1712
1651
|
*/
|
|
1713
1652
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1714
1653
|
|
|
1654
|
+
export declare const CreatedBy: ICreatedBy;
|
|
1655
|
+
|
|
1715
1656
|
/**
|
|
1716
1657
|
* @public
|
|
1717
1658
|
*/
|
|
@@ -2066,18 +2007,10 @@ export declare type EntityComponents = {
|
|
|
2066
2007
|
uiBackground: PBUiBackground;
|
|
2067
2008
|
uiInput: PBUiInput;
|
|
2068
2009
|
uiDropdown: PBUiDropdown;
|
|
2069
|
-
onMouseDown:
|
|
2070
|
-
onMouseUp:
|
|
2071
|
-
onMouseEnter:
|
|
2072
|
-
onMouseLeave:
|
|
2073
|
-
onMouseDrag: EventSystemCallback;
|
|
2074
|
-
onMouseDragLocked: EventSystemCallback;
|
|
2075
|
-
onMouseDragEnd: EventSystemCallback;
|
|
2076
|
-
onInputDown: MultiCallback;
|
|
2077
|
-
onInputUp: MultiCallback;
|
|
2078
|
-
onInputDrag: MultiCallback;
|
|
2079
|
-
onInputDragLocked: MultiCallback;
|
|
2080
|
-
onInputDragEnd: MultiCallback;
|
|
2010
|
+
onMouseDown: Callback;
|
|
2011
|
+
onMouseUp: Callback;
|
|
2012
|
+
onMouseEnter: Callback;
|
|
2013
|
+
onMouseLeave: Callback;
|
|
2081
2014
|
};
|
|
2082
2015
|
|
|
2083
2016
|
/** @public */
|
|
@@ -2156,13 +2089,6 @@ export declare type EventSystemOptions = {
|
|
|
2156
2089
|
maxPlayerDistance?: number;
|
|
2157
2090
|
};
|
|
2158
2091
|
|
|
2159
|
-
/**
|
|
2160
|
-
* @public
|
|
2161
|
-
*/
|
|
2162
|
-
export declare type EventSystemOptionsCallback = EventSystemOptions & {
|
|
2163
|
-
cb: EventSystemCallback;
|
|
2164
|
-
};
|
|
2165
|
-
|
|
2166
2092
|
/**
|
|
2167
2093
|
* Excludes property keys from T where the property is assignable to U
|
|
2168
2094
|
* @public
|
|
@@ -2332,16 +2258,6 @@ export declare const getDefaultOpts: (opts?: Partial<EventSystemOptions>) => Eve
|
|
|
2332
2258
|
*/
|
|
2333
2259
|
export declare function getEntitiesWithParent(engine: Pick<IEngine, 'getEntitiesWith' | 'defineComponentFromSchema'>, parent: Entity): Entity[];
|
|
2334
2260
|
|
|
2335
|
-
/**
|
|
2336
|
-
* Utilities for standardized globalThis access.
|
|
2337
|
-
* @public
|
|
2338
|
-
*/
|
|
2339
|
-
/**
|
|
2340
|
-
* Type-safe globalThis property access.
|
|
2341
|
-
* @public
|
|
2342
|
-
*/
|
|
2343
|
-
export declare function getGlobal<T>(key: string): T | undefined;
|
|
2344
|
-
|
|
2345
2261
|
/**
|
|
2346
2262
|
* Get the world position of an entity, taking into account the full parent hierarchy.
|
|
2347
2263
|
* This computes the world-space position by accumulating all parent transforms
|
|
@@ -2391,9 +2307,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
|
2391
2307
|
direction?: PBVector3;
|
|
2392
2308
|
};
|
|
2393
2309
|
|
|
2394
|
-
/** @public */
|
|
2395
|
-
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
|
2396
|
-
|
|
2397
2310
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
|
2398
2311
|
|
|
2399
2312
|
export declare type GlobalTargetRaycastSystemOptions = {
|
|
@@ -2406,24 +2319,9 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
|
2406
2319
|
/** @public */
|
|
2407
2320
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
|
2408
2321
|
|
|
2409
|
-
/** @public */
|
|
2410
|
-
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
|
2411
|
-
|
|
2412
2322
|
/** @public */
|
|
2413
2323
|
export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
|
|
2414
2324
|
|
|
2415
|
-
/** @public */
|
|
2416
|
-
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
|
2417
|
-
|
|
2418
|
-
/**
|
|
2419
|
-
* @public
|
|
2420
|
-
*/
|
|
2421
|
-
export declare const enum GltfNodeStateValue {
|
|
2422
|
-
GNSV_PENDING = 0,
|
|
2423
|
-
GNSV_FAILED = 1,
|
|
2424
|
-
GNSV_READY = 2
|
|
2425
|
-
}
|
|
2426
|
-
|
|
2427
2325
|
/**
|
|
2428
2326
|
* @public
|
|
2429
2327
|
*/
|
|
@@ -2447,6 +2345,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2447
2345
|
|
|
2448
2346
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2449
2347
|
|
|
2348
|
+
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2349
|
+
|
|
2350
|
+
export declare interface ICreatedByType {
|
|
2351
|
+
address: string;
|
|
2352
|
+
}
|
|
2353
|
+
|
|
2450
2354
|
/**
|
|
2451
2355
|
* @public
|
|
2452
2356
|
*/
|
|
@@ -2778,12 +2682,6 @@ export declare type IInputSystem = {
|
|
|
2778
2682
|
* @returns the input command info or undefined if there is no command in the last tick-update
|
|
2779
2683
|
*/
|
|
2780
2684
|
getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
|
|
2781
|
-
/**
|
|
2782
|
-
* @public
|
|
2783
|
-
* Get an ordered iterator over events received within the current frame.
|
|
2784
|
-
* @returns the iterator
|
|
2785
|
-
*/
|
|
2786
|
-
getInputCommands: () => Generator<PBPointerEventsResult>;
|
|
2787
2685
|
};
|
|
2788
2686
|
|
|
2789
2687
|
/**
|
|
@@ -2896,6 +2794,35 @@ export declare type InstanceCompositeOptions = {
|
|
|
2896
2794
|
alreadyRequestedSrc?: Set<string>;
|
|
2897
2795
|
};
|
|
2898
2796
|
|
|
2797
|
+
/**
|
|
2798
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
2799
|
+
* This is not exposed to users, only for internal SDK operations
|
|
2800
|
+
*/
|
|
2801
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
2802
|
+
/**
|
|
2803
|
+
* @public
|
|
2804
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
2805
|
+
*/
|
|
2806
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
2807
|
+
/**
|
|
2808
|
+
* @public
|
|
2809
|
+
* Get the iterator to every entity has the component
|
|
2810
|
+
*/
|
|
2811
|
+
iterator(): Iterable<[Entity, any]>;
|
|
2812
|
+
/**
|
|
2813
|
+
* @public
|
|
2814
|
+
*/
|
|
2815
|
+
dirtyIterator(): Iterable<Entity>;
|
|
2816
|
+
/**
|
|
2817
|
+
* @public
|
|
2818
|
+
*/
|
|
2819
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
2820
|
+
/**
|
|
2821
|
+
* @public
|
|
2822
|
+
*/
|
|
2823
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
2824
|
+
}
|
|
2825
|
+
|
|
2899
2826
|
/**
|
|
2900
2827
|
* @public
|
|
2901
2828
|
*/
|
|
@@ -3079,29 +3006,13 @@ export declare interface LightSourceHelper {
|
|
|
3079
3006
|
*/
|
|
3080
3007
|
export declare type Listeners = {
|
|
3081
3008
|
/** triggered on mouse down event */
|
|
3082
|
-
onMouseDown?:
|
|
3009
|
+
onMouseDown?: Callback;
|
|
3083
3010
|
/** triggered on mouse up event */
|
|
3084
|
-
onMouseUp?:
|
|
3011
|
+
onMouseUp?: Callback;
|
|
3085
3012
|
/** triggered on mouse hover event */
|
|
3086
|
-
onMouseEnter?:
|
|
3013
|
+
onMouseEnter?: Callback;
|
|
3087
3014
|
/** triggered on mouse leave event */
|
|
3088
|
-
onMouseLeave?:
|
|
3089
|
-
/** triggered on mouse drag event */
|
|
3090
|
-
onMouseDrag?: EventSystemCallback;
|
|
3091
|
-
/** triggered on mouse drag event */
|
|
3092
|
-
onMouseDragLocked?: EventSystemCallback;
|
|
3093
|
-
/** triggered on mouse drag event */
|
|
3094
|
-
onMouseDragEnd?: EventSystemCallback;
|
|
3095
|
-
/** triggered on input down event */
|
|
3096
|
-
onInputDown?: MultiCallback;
|
|
3097
|
-
/** triggered on input up event */
|
|
3098
|
-
onInputUp?: MultiCallback;
|
|
3099
|
-
/** triggered on input drag event */
|
|
3100
|
-
onInputDrag?: MultiCallback;
|
|
3101
|
-
/** triggered on input drag event */
|
|
3102
|
-
onInputDragLocked?: MultiCallback;
|
|
3103
|
-
/** triggered on input drag event */
|
|
3104
|
-
onInputDragEnd?: MultiCallback;
|
|
3015
|
+
onMouseLeave?: Callback;
|
|
3105
3016
|
};
|
|
3106
3017
|
|
|
3107
3018
|
/**
|
|
@@ -4006,14 +3917,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4006
3917
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4007
3918
|
*/
|
|
4008
3919
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4009
|
-
/**
|
|
4010
|
-
* @public
|
|
4011
|
-
* Set a gltf internal mesh in the MeshCollider component
|
|
4012
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4013
|
-
* @param source - the path to the gltf
|
|
4014
|
-
* @param meshName - the name of the mesh in the gltf
|
|
4015
|
-
*/
|
|
4016
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4017
3920
|
}
|
|
4018
3921
|
|
|
4019
3922
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4050,14 +3953,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4050
3953
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4051
3954
|
*/
|
|
4052
3955
|
setSphere(entity: Entity): void;
|
|
4053
|
-
/**
|
|
4054
|
-
* @public
|
|
4055
|
-
* Set a gltf internal mesh in the MeshRenderer component
|
|
4056
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4057
|
-
* @param source - the path to the gltf
|
|
4058
|
-
* @param meshName - the name of the mesh in the gltf
|
|
4059
|
-
*/
|
|
4060
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
4061
3956
|
}
|
|
4062
3957
|
|
|
4063
3958
|
/**
|
|
@@ -4106,19 +4001,6 @@ export declare namespace MoveContinuous {
|
|
|
4106
4001
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4107
4002
|
}
|
|
4108
4003
|
|
|
4109
|
-
/**
|
|
4110
|
-
* a record object mapping `InputAction`s to functions.
|
|
4111
|
-
*
|
|
4112
|
-
* @example
|
|
4113
|
-
* onInputDown={{
|
|
4114
|
-
* [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
|
|
4115
|
-
* [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
|
|
4116
|
-
* }}
|
|
4117
|
-
*
|
|
4118
|
-
* @public
|
|
4119
|
-
*/
|
|
4120
|
-
export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
|
|
4121
|
-
|
|
4122
4004
|
export declare const Name: NameComponent;
|
|
4123
4005
|
|
|
4124
4006
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4499,25 +4381,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4499
4381
|
totalVideoLength: number;
|
|
4500
4382
|
}>;
|
|
4501
4383
|
|
|
4502
|
-
/**
|
|
4503
|
-
* @public
|
|
4504
|
-
*/
|
|
4505
|
-
export declare interface Orthographic {
|
|
4506
|
-
/**
|
|
4507
|
-
* vertical extent of the visible range in meters
|
|
4508
|
-
* defaults to 4m
|
|
4509
|
-
*/
|
|
4510
|
-
verticalRange?: number | undefined;
|
|
4511
|
-
}
|
|
4512
|
-
|
|
4513
|
-
/**
|
|
4514
|
-
* @public
|
|
4515
|
-
*/
|
|
4516
|
-
export declare namespace Orthographic {
|
|
4517
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4518
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4519
|
-
}
|
|
4520
|
-
|
|
4521
4384
|
/**
|
|
4522
4385
|
* @public
|
|
4523
4386
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -4795,8 +4658,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
4795
4658
|
export declare interface PBAvatarEquippedData {
|
|
4796
4659
|
wearableUrns: string[];
|
|
4797
4660
|
emoteUrns: string[];
|
|
4798
|
-
/** slots that will render even if hidden */
|
|
4799
|
-
forceRender: string[];
|
|
4800
4661
|
}
|
|
4801
4662
|
|
|
4802
4663
|
/**
|
|
@@ -4807,36 +4668,6 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4807
4668
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4808
4669
|
}
|
|
4809
4670
|
|
|
4810
|
-
/**
|
|
4811
|
-
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4812
|
-
* as the avatar movement speed, jump height etc.
|
|
4813
|
-
*/
|
|
4814
|
-
/**
|
|
4815
|
-
* @public
|
|
4816
|
-
*/
|
|
4817
|
-
export declare interface PBAvatarLocomotionSettings {
|
|
4818
|
-
/** Maximum speed when walking (in meters per second) */
|
|
4819
|
-
walkSpeed?: number | undefined;
|
|
4820
|
-
/** Maximum speed when jogging (in meters per second) */
|
|
4821
|
-
jogSpeed?: number | undefined;
|
|
4822
|
-
/** Maximum speed when running (in meters per second) */
|
|
4823
|
-
runSpeed?: number | undefined;
|
|
4824
|
-
/** Height of a regular jump (in meters) */
|
|
4825
|
-
jumpHeight?: number | undefined;
|
|
4826
|
-
/** Height of a jump while running (in meters) */
|
|
4827
|
-
runJumpHeight?: number | undefined;
|
|
4828
|
-
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4829
|
-
hardLandingCooldown?: number | undefined;
|
|
4830
|
-
}
|
|
4831
|
-
|
|
4832
|
-
/**
|
|
4833
|
-
* @public
|
|
4834
|
-
*/
|
|
4835
|
-
export declare namespace PBAvatarLocomotionSettings {
|
|
4836
|
-
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4837
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4838
|
-
}
|
|
4839
|
-
|
|
4840
4671
|
/**
|
|
4841
4672
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4842
4673
|
* avatar behavior changes.
|
|
@@ -4861,9 +4692,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
4861
4692
|
excludeIds: string[];
|
|
4862
4693
|
/** list of modifiers to apply */
|
|
4863
4694
|
modifiers: AvatarModifierType[];
|
|
4864
|
-
movementSettings?: AvatarMovementSettings | undefined;
|
|
4865
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
4866
|
-
useColliderRange?: boolean | undefined;
|
|
4867
4695
|
}
|
|
4868
4696
|
|
|
4869
4697
|
/**
|
|
@@ -4922,8 +4750,6 @@ export declare interface PBAvatarShape {
|
|
|
4922
4750
|
emotes: string[];
|
|
4923
4751
|
/** hides the skin + hair + facial features (default: false) */
|
|
4924
4752
|
showOnlyWearables?: boolean | undefined;
|
|
4925
|
-
/** slots that will render even if hidden */
|
|
4926
|
-
forceRender: string[];
|
|
4927
4753
|
}
|
|
4928
4754
|
|
|
4929
4755
|
/**
|
|
@@ -4958,51 +4784,6 @@ export declare namespace PBBillboard {
|
|
|
4958
4784
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
4959
4785
|
}
|
|
4960
4786
|
|
|
4961
|
-
/**
|
|
4962
|
-
* @public
|
|
4963
|
-
*/
|
|
4964
|
-
export declare interface PBCameraLayer {
|
|
4965
|
-
/**
|
|
4966
|
-
* layer to which these settings apply. must be > 0
|
|
4967
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
4968
|
-
*/
|
|
4969
|
-
layer: number;
|
|
4970
|
-
/** should the sun light affect this layer? default false */
|
|
4971
|
-
directionalLight?: boolean | undefined;
|
|
4972
|
-
/** should this layer show player avatars? default false */
|
|
4973
|
-
showAvatars?: boolean | undefined;
|
|
4974
|
-
/** should this layer show the sky? default false */
|
|
4975
|
-
showSkybox?: boolean | undefined;
|
|
4976
|
-
/** should this layer show distance fog? default false */
|
|
4977
|
-
showFog?: boolean | undefined;
|
|
4978
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
4979
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
4980
|
-
ambientBrightnessOverride?: number | undefined;
|
|
4981
|
-
}
|
|
4982
|
-
|
|
4983
|
-
/**
|
|
4984
|
-
* @public
|
|
4985
|
-
*/
|
|
4986
|
-
export declare namespace PBCameraLayer {
|
|
4987
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
4988
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
4989
|
-
}
|
|
4990
|
-
|
|
4991
|
-
/**
|
|
4992
|
-
* @public
|
|
4993
|
-
*/
|
|
4994
|
-
export declare interface PBCameraLayers {
|
|
4995
|
-
layers: number[];
|
|
4996
|
-
}
|
|
4997
|
-
|
|
4998
|
-
/**
|
|
4999
|
-
* @public
|
|
5000
|
-
*/
|
|
5001
|
-
export declare namespace PBCameraLayers {
|
|
5002
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5003
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5004
|
-
}
|
|
5005
|
-
|
|
5006
4787
|
/**
|
|
5007
4788
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5008
4789
|
* third-person view.
|
|
@@ -5025,7 +4806,7 @@ export declare namespace PBCameraMode {
|
|
|
5025
4806
|
|
|
5026
4807
|
/**
|
|
5027
4808
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
|
5028
|
-
* the player's camera mode (1st-person
|
|
4809
|
+
* the player's camera mode (1st-person or 3rd-person) is overridden.
|
|
5029
4810
|
*
|
|
5030
4811
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
|
5031
4812
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
|
@@ -5035,8 +4816,6 @@ export declare namespace PBCameraMode {
|
|
|
5035
4816
|
*
|
|
5036
4817
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
|
5037
4818
|
* is actually a 3D volume.
|
|
5038
|
-
*
|
|
5039
|
-
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
|
5040
4819
|
*/
|
|
5041
4820
|
/**
|
|
5042
4821
|
* @public
|
|
@@ -5046,9 +4825,6 @@ export declare interface PBCameraModeArea {
|
|
|
5046
4825
|
area: PBVector3 | undefined;
|
|
5047
4826
|
/** the camera mode to enforce */
|
|
5048
4827
|
mode: CameraType;
|
|
5049
|
-
cinematicSettings?: CinematicSettings | undefined;
|
|
5050
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5051
|
-
useColliderRange?: boolean | undefined;
|
|
5052
4828
|
}
|
|
5053
4829
|
|
|
5054
4830
|
/**
|
|
@@ -5120,39 +4896,6 @@ export declare namespace PBEngineInfo {
|
|
|
5120
4896
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
5121
4897
|
}
|
|
5122
4898
|
|
|
5123
|
-
/**
|
|
5124
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5125
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5126
|
-
*/
|
|
5127
|
-
/**
|
|
5128
|
-
* @public
|
|
5129
|
-
*/
|
|
5130
|
-
export declare interface PBGlobalLight {
|
|
5131
|
-
/**
|
|
5132
|
-
* the direction the directional light shines in.
|
|
5133
|
-
* default depends on time of day and explorer implementation
|
|
5134
|
-
*/
|
|
5135
|
-
direction?: PBVector3 | undefined;
|
|
5136
|
-
/**
|
|
5137
|
-
* ambient light color
|
|
5138
|
-
* default: White
|
|
5139
|
-
*/
|
|
5140
|
-
ambientColor?: PBColor3 | undefined;
|
|
5141
|
-
/**
|
|
5142
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5143
|
-
* default 1
|
|
5144
|
-
*/
|
|
5145
|
-
ambientBrightness?: number | undefined;
|
|
5146
|
-
}
|
|
5147
|
-
|
|
5148
|
-
/**
|
|
5149
|
-
* @public
|
|
5150
|
-
*/
|
|
5151
|
-
export declare namespace PBGlobalLight {
|
|
5152
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5153
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5154
|
-
}
|
|
5155
|
-
|
|
5156
4899
|
/**
|
|
5157
4900
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5158
4901
|
*
|
|
@@ -5188,25 +4931,6 @@ export declare namespace PBGltfContainer {
|
|
|
5188
4931
|
*/
|
|
5189
4932
|
export declare interface PBGltfContainerLoadingState {
|
|
5190
4933
|
currentState: LoadingState;
|
|
5191
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5192
|
-
nodePaths: string[];
|
|
5193
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5194
|
-
meshNames: string[];
|
|
5195
|
-
/**
|
|
5196
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5197
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5198
|
-
*/
|
|
5199
|
-
materialNames: string[];
|
|
5200
|
-
/**
|
|
5201
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5202
|
-
* sure all your materials are explicitly named.
|
|
5203
|
-
*/
|
|
5204
|
-
skinNames: string[];
|
|
5205
|
-
/**
|
|
5206
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5207
|
-
* your skins are explicitly named.
|
|
5208
|
-
*/
|
|
5209
|
-
animationNames: string[];
|
|
5210
4934
|
}
|
|
5211
4935
|
|
|
5212
4936
|
/**
|
|
@@ -5217,57 +4941,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5217
4941
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5218
4942
|
}
|
|
5219
4943
|
|
|
5220
|
-
/**
|
|
5221
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5222
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5223
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5224
|
-
* in the parent.
|
|
5225
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5226
|
-
*
|
|
5227
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5228
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5229
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5230
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5231
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5232
|
-
*
|
|
5233
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5234
|
-
*
|
|
5235
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5236
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5237
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5238
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5239
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5240
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5241
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5242
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5243
|
-
* 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
|
|
5244
|
-
* PBMaterial will be maintained.
|
|
5245
|
-
*
|
|
5246
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5247
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5248
|
-
* change the state to `GNS_FAILED`.
|
|
5249
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5250
|
-
*
|
|
5251
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5252
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5253
|
-
* the gltf node will also be displayed.
|
|
5254
|
-
*/
|
|
5255
|
-
/**
|
|
5256
|
-
* @public
|
|
5257
|
-
*/
|
|
5258
|
-
export declare interface PBGltfNode {
|
|
5259
|
-
/** the path of the target node in the Gltf. */
|
|
5260
|
-
path: string;
|
|
5261
|
-
}
|
|
5262
|
-
|
|
5263
|
-
/**
|
|
5264
|
-
* @public
|
|
5265
|
-
*/
|
|
5266
|
-
export declare namespace PBGltfNode {
|
|
5267
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5268
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5269
|
-
}
|
|
5270
|
-
|
|
5271
4944
|
/**
|
|
5272
4945
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5273
4946
|
*
|
|
@@ -5313,26 +4986,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5313
4986
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5314
4987
|
}
|
|
5315
4988
|
|
|
5316
|
-
/**
|
|
5317
|
-
* The state of a linked gltf node.
|
|
5318
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5319
|
-
*/
|
|
5320
|
-
/**
|
|
5321
|
-
* @public
|
|
5322
|
-
*/
|
|
5323
|
-
export declare interface PBGltfNodeState {
|
|
5324
|
-
state: GltfNodeStateValue;
|
|
5325
|
-
error?: string | undefined;
|
|
5326
|
-
}
|
|
5327
|
-
|
|
5328
|
-
/**
|
|
5329
|
-
* @public
|
|
5330
|
-
*/
|
|
5331
|
-
export declare namespace PBGltfNodeState {
|
|
5332
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5333
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5334
|
-
}
|
|
5335
|
-
|
|
5336
4989
|
/**
|
|
5337
4990
|
* @public
|
|
5338
4991
|
*/
|
|
@@ -5468,14 +5121,6 @@ export declare interface PBMaterial {
|
|
|
5468
5121
|
$case: "pbr";
|
|
5469
5122
|
pbr: PBMaterial_PbrMaterial;
|
|
5470
5123
|
} | undefined;
|
|
5471
|
-
/**
|
|
5472
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
5473
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
5474
|
-
* supported by the PbMaterial.
|
|
5475
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
5476
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
5477
|
-
*/
|
|
5478
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
5479
5124
|
}
|
|
5480
5125
|
|
|
5481
5126
|
/**
|
|
@@ -5486,22 +5131,6 @@ export declare namespace PBMaterial {
|
|
|
5486
5131
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
5487
5132
|
}
|
|
5488
5133
|
|
|
5489
|
-
/**
|
|
5490
|
-
* @public
|
|
5491
|
-
*/
|
|
5492
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
5493
|
-
gltfSrc: string;
|
|
5494
|
-
name: string;
|
|
5495
|
-
}
|
|
5496
|
-
|
|
5497
|
-
/**
|
|
5498
|
-
* @public
|
|
5499
|
-
*/
|
|
5500
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
5501
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
5502
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
5503
|
-
}
|
|
5504
|
-
|
|
5505
5134
|
/**
|
|
5506
5135
|
* @public
|
|
5507
5136
|
*/
|
|
@@ -5598,9 +5227,6 @@ export declare interface PBMeshCollider {
|
|
|
5598
5227
|
} | {
|
|
5599
5228
|
$case: "plane";
|
|
5600
5229
|
plane: PBMeshCollider_PlaneMesh;
|
|
5601
|
-
} | {
|
|
5602
|
-
$case: "gltf";
|
|
5603
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
5604
5230
|
} | undefined;
|
|
5605
5231
|
}
|
|
5606
5232
|
|
|
@@ -5646,25 +5272,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
5646
5272
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
5647
5273
|
}
|
|
5648
5274
|
|
|
5649
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
5650
|
-
/**
|
|
5651
|
-
* @public
|
|
5652
|
-
*/
|
|
5653
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
5654
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
5655
|
-
gltfSrc: string;
|
|
5656
|
-
/** the name of the mesh asset */
|
|
5657
|
-
name: string;
|
|
5658
|
-
}
|
|
5659
|
-
|
|
5660
|
-
/**
|
|
5661
|
-
* @public
|
|
5662
|
-
*/
|
|
5663
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
5664
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5665
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
5666
|
-
}
|
|
5667
|
-
|
|
5668
5275
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
5669
5276
|
/**
|
|
5670
5277
|
* @public
|
|
@@ -5697,11 +5304,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
5697
5304
|
|
|
5698
5305
|
/**
|
|
5699
5306
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
5700
|
-
* plane, a sphere
|
|
5307
|
+
* plane, a sphere or a cylinder.
|
|
5701
5308
|
*
|
|
5702
5309
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
5703
5310
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
5704
5311
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5312
|
+
*
|
|
5313
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
|
5705
5314
|
*/
|
|
5706
5315
|
/**
|
|
5707
5316
|
* @public
|
|
@@ -5719,9 +5328,6 @@ export declare interface PBMeshRenderer {
|
|
|
5719
5328
|
} | {
|
|
5720
5329
|
$case: "plane";
|
|
5721
5330
|
plane: PBMeshRenderer_PlaneMesh;
|
|
5722
|
-
} | {
|
|
5723
|
-
$case: "gltf";
|
|
5724
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
5725
5331
|
} | undefined;
|
|
5726
5332
|
}
|
|
5727
5333
|
|
|
@@ -5769,25 +5375,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
5769
5375
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
5770
5376
|
}
|
|
5771
5377
|
|
|
5772
|
-
/** A mesh from a Gltf. */
|
|
5773
|
-
/**
|
|
5774
|
-
* @public
|
|
5775
|
-
*/
|
|
5776
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
5777
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
5778
|
-
gltfSrc: string;
|
|
5779
|
-
/** the name of the mesh asset */
|
|
5780
|
-
name: string;
|
|
5781
|
-
}
|
|
5782
|
-
|
|
5783
|
-
/**
|
|
5784
|
-
* @public
|
|
5785
|
-
*/
|
|
5786
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
5787
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5788
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
5789
|
-
}
|
|
5790
|
-
|
|
5791
5378
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
5792
5379
|
/**
|
|
5793
5380
|
* @public
|
|
@@ -6061,10 +5648,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
6061
5648
|
screenCoordinates?: PBVector2 | undefined;
|
|
6062
5649
|
/** Movement since last frame (pixels) */
|
|
6063
5650
|
screenDelta?: PBVector2 | undefined;
|
|
6064
|
-
/**
|
|
6065
|
-
* ray direction that can be used with the primary camera origin for
|
|
6066
|
-
* raycasting from the cursor into the world
|
|
6067
|
-
*/
|
|
5651
|
+
/** Direction vector for 3D ray casting */
|
|
6068
5652
|
worldRayDirection?: PBVector3 | undefined;
|
|
6069
5653
|
}
|
|
6070
5654
|
|
|
@@ -6290,46 +5874,6 @@ export declare namespace PBTextShape {
|
|
|
6290
5874
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
6291
5875
|
}
|
|
6292
5876
|
|
|
6293
|
-
/**
|
|
6294
|
-
* @public
|
|
6295
|
-
*/
|
|
6296
|
-
export declare interface PBTextureCamera {
|
|
6297
|
-
/** rendered texture width */
|
|
6298
|
-
width?: number | undefined;
|
|
6299
|
-
/** rendered texture height */
|
|
6300
|
-
height?: number | undefined;
|
|
6301
|
-
/**
|
|
6302
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
6303
|
-
* defaults to 0
|
|
6304
|
-
*/
|
|
6305
|
-
layer?: number | undefined;
|
|
6306
|
-
/** default black */
|
|
6307
|
-
clearColor?: PBColor4 | undefined;
|
|
6308
|
-
/** default infinity */
|
|
6309
|
-
farPlane?: number | undefined;
|
|
6310
|
-
mode?: {
|
|
6311
|
-
$case: "perspective";
|
|
6312
|
-
perspective: Perspective;
|
|
6313
|
-
} | {
|
|
6314
|
-
$case: "orthographic";
|
|
6315
|
-
orthographic: Orthographic;
|
|
6316
|
-
} | undefined;
|
|
6317
|
-
/**
|
|
6318
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
6319
|
-
* range: 0 (off) - 1 (full volume)
|
|
6320
|
-
* default: 0
|
|
6321
|
-
*/
|
|
6322
|
-
volume?: number | undefined;
|
|
6323
|
-
}
|
|
6324
|
-
|
|
6325
|
-
/**
|
|
6326
|
-
* @public
|
|
6327
|
-
*/
|
|
6328
|
-
export declare namespace PBTextureCamera {
|
|
6329
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
6330
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
6331
|
-
}
|
|
6332
|
-
|
|
6333
5877
|
/**
|
|
6334
5878
|
* The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
|
|
6335
5879
|
* when entities enter this component's defined area.
|
|
@@ -6508,25 +6052,6 @@ export declare namespace PBUiBackground {
|
|
|
6508
6052
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
6509
6053
|
}
|
|
6510
6054
|
|
|
6511
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
6512
|
-
/**
|
|
6513
|
-
* @public
|
|
6514
|
-
*/
|
|
6515
|
-
export declare interface PBUiCanvas {
|
|
6516
|
-
width: number;
|
|
6517
|
-
height: number;
|
|
6518
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
6519
|
-
color?: PBColor4 | undefined;
|
|
6520
|
-
}
|
|
6521
|
-
|
|
6522
|
-
/**
|
|
6523
|
-
* @public
|
|
6524
|
-
*/
|
|
6525
|
-
export declare namespace PBUiCanvas {
|
|
6526
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
6527
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
6528
|
-
}
|
|
6529
|
-
|
|
6530
6055
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
6531
6056
|
/**
|
|
6532
6057
|
* @public
|
|
@@ -6643,21 +6168,6 @@ export declare namespace PBUiInputResult {
|
|
|
6643
6168
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
6644
6169
|
}
|
|
6645
6170
|
|
|
6646
|
-
/**
|
|
6647
|
-
* @public
|
|
6648
|
-
*/
|
|
6649
|
-
export declare interface PBUiScrollResult {
|
|
6650
|
-
value: PBVector2 | undefined;
|
|
6651
|
-
}
|
|
6652
|
-
|
|
6653
|
-
/**
|
|
6654
|
-
* @public
|
|
6655
|
-
*/
|
|
6656
|
-
export declare namespace PBUiScrollResult {
|
|
6657
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
6658
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
6659
|
-
}
|
|
6660
|
-
|
|
6661
6171
|
/**
|
|
6662
6172
|
* @public
|
|
6663
6173
|
*/
|
|
@@ -6674,10 +6184,6 @@ export declare interface PBUiText {
|
|
|
6674
6184
|
fontSize?: number | undefined;
|
|
6675
6185
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
|
6676
6186
|
textWrap?: TextWrap | undefined;
|
|
6677
|
-
/** width of the outline (default: 0) */
|
|
6678
|
-
outlineWidth?: number | undefined;
|
|
6679
|
-
/** RGBA color of the outline (default: opaque black) */
|
|
6680
|
-
outlineColor?: PBColor4 | undefined;
|
|
6681
6187
|
}
|
|
6682
6188
|
|
|
6683
6189
|
/**
|
|
@@ -6805,12 +6311,6 @@ export declare interface PBUiTransform {
|
|
|
6805
6311
|
borderRightColor?: PBColor4 | undefined;
|
|
6806
6312
|
/** default: 1 */
|
|
6807
6313
|
opacity?: number | undefined;
|
|
6808
|
-
/** reference for scroll_position. default empty */
|
|
6809
|
-
elementId?: string | undefined;
|
|
6810
|
-
/** default position=(0,0) */
|
|
6811
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
6812
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
6813
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
6814
6314
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
6815
6315
|
zIndex?: number | undefined;
|
|
6816
6316
|
}
|
|
@@ -6960,25 +6460,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
6960
6460
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6961
6461
|
}
|
|
6962
6462
|
|
|
6963
|
-
/**
|
|
6964
|
-
* @public
|
|
6965
|
-
*/
|
|
6966
|
-
export declare interface Perspective {
|
|
6967
|
-
/**
|
|
6968
|
-
* vertical field of view in radians
|
|
6969
|
-
* defaults to pi/4 = 45 degrees
|
|
6970
|
-
*/
|
|
6971
|
-
fieldOfView?: number | undefined;
|
|
6972
|
-
}
|
|
6973
|
-
|
|
6974
|
-
/**
|
|
6975
|
-
* @public
|
|
6976
|
-
*/
|
|
6977
|
-
export declare namespace Perspective {
|
|
6978
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
6979
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
6980
|
-
}
|
|
6981
|
-
|
|
6982
6463
|
/**
|
|
6983
6464
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6984
6465
|
* @public
|
|
@@ -7134,37 +6615,11 @@ export declare interface PointerEventsSystem {
|
|
|
7134
6615
|
* @param entity - Entity where the callback was attached
|
|
7135
6616
|
*/
|
|
7136
6617
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
7137
|
-
/**
|
|
7138
|
-
* @public
|
|
7139
|
-
* Remove the callback for onPointerDrag event
|
|
7140
|
-
* @param entity - Entity where the callback was attached
|
|
7141
|
-
*/
|
|
7142
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
7143
|
-
/**
|
|
7144
|
-
* @public
|
|
7145
|
-
* Remove the callback for onPointerDragLocked event
|
|
7146
|
-
* @param entity - Entity where the callback was attached
|
|
7147
|
-
*/
|
|
7148
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
7149
|
-
/**
|
|
7150
|
-
* @public
|
|
7151
|
-
* Remove the callback for onPointerDragEnd event
|
|
7152
|
-
* @param entity - Entity where the callback was attached
|
|
7153
|
-
*/
|
|
7154
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
7155
|
-
/**
|
|
7156
|
-
* @public
|
|
7157
|
-
* Execute callbacks when the user presses one of the InputButtons pointing at the entity
|
|
7158
|
-
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7159
|
-
*/
|
|
7160
|
-
onPointerDown(pointerData: {
|
|
7161
|
-
entity: Entity;
|
|
7162
|
-
optsList: EventSystemOptionsCallback[];
|
|
7163
|
-
}): void;
|
|
7164
6618
|
/**
|
|
7165
6619
|
* @public
|
|
7166
6620
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
7167
6621
|
* @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
|
|
6622
|
+
* @param cb - Function to execute when click fires
|
|
7168
6623
|
*/
|
|
7169
6624
|
onPointerDown(pointerData: {
|
|
7170
6625
|
entity: Entity;
|
|
@@ -7177,15 +6632,6 @@ export declare interface PointerEventsSystem {
|
|
|
7177
6632
|
* @param opts - Opts to trigger Feedback and Button
|
|
7178
6633
|
*/
|
|
7179
6634
|
onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
|
|
7180
|
-
/**
|
|
7181
|
-
* @public
|
|
7182
|
-
* Execute callbacks when the user releases one of the InputButtons pointing at the entity
|
|
7183
|
-
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7184
|
-
*/
|
|
7185
|
-
onPointerUp(pointerData: {
|
|
7186
|
-
entity: Entity;
|
|
7187
|
-
optsList: EventSystemOptionsCallback[];
|
|
7188
|
-
}): void;
|
|
7189
6635
|
/**
|
|
7190
6636
|
* @public
|
|
7191
6637
|
* Execute callback when the user releases the InputButton pointing at the entity
|
|
@@ -7223,64 +6669,6 @@ export declare interface PointerEventsSystem {
|
|
|
7223
6669
|
entity: Entity;
|
|
7224
6670
|
opts?: Partial<EventSystemOptions>;
|
|
7225
6671
|
}, cb: EventSystemCallback): void;
|
|
7226
|
-
/**
|
|
7227
|
-
* @public
|
|
7228
|
-
* Execute callbacks when the user drags the pointer from inside the entity
|
|
7229
|
-
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7230
|
-
*/
|
|
7231
|
-
onPointerDrag(pointerData: {
|
|
7232
|
-
entity: Entity;
|
|
7233
|
-
optsList: EventSystemOptionsCallback[];
|
|
7234
|
-
}): void;
|
|
7235
|
-
/**
|
|
7236
|
-
* @public
|
|
7237
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity
|
|
7238
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7239
|
-
* @param cb - Function to execute when click fires
|
|
7240
|
-
*/
|
|
7241
|
-
onPointerDrag(pointerData: {
|
|
7242
|
-
entity: Entity;
|
|
7243
|
-
opts?: Partial<EventSystemOptions>;
|
|
7244
|
-
}, cb: EventSystemCallback): void;
|
|
7245
|
-
/**
|
|
7246
|
-
* @public
|
|
7247
|
-
* Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
|
|
7248
|
-
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7249
|
-
*/
|
|
7250
|
-
onPointerDragLocked(pointerData: {
|
|
7251
|
-
entity: Entity;
|
|
7252
|
-
optsList: EventSystemOptionsCallback[];
|
|
7253
|
-
}): void;
|
|
7254
|
-
/**
|
|
7255
|
-
* @public
|
|
7256
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
|
7257
|
-
* locking the cursor in place
|
|
7258
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7259
|
-
* @param cb - Function to execute when click fires
|
|
7260
|
-
*/
|
|
7261
|
-
onPointerDragLocked(pointerData: {
|
|
7262
|
-
entity: Entity;
|
|
7263
|
-
opts?: Partial<EventSystemOptions>;
|
|
7264
|
-
}, cb: EventSystemCallback): void;
|
|
7265
|
-
/**
|
|
7266
|
-
* @public
|
|
7267
|
-
* Execute callbacks when the user releases a button after a drag
|
|
7268
|
-
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7269
|
-
*/
|
|
7270
|
-
onPointerDragEnd(pointerData: {
|
|
7271
|
-
entity: Entity;
|
|
7272
|
-
optsList: EventSystemOptionsCallback[];
|
|
7273
|
-
}): void;
|
|
7274
|
-
/**
|
|
7275
|
-
* @public
|
|
7276
|
-
* Execute callback when the user releases the button after a drag
|
|
7277
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7278
|
-
* @param cb - Function to execute when click fires
|
|
7279
|
-
*/
|
|
7280
|
-
onPointerDragEnd(pointerData: {
|
|
7281
|
-
entity: Entity;
|
|
7282
|
-
opts?: Partial<EventSystemOptions>;
|
|
7283
|
-
}, cb: EventSystemCallback): void;
|
|
7284
6672
|
}
|
|
7285
6673
|
|
|
7286
6674
|
/**
|
|
@@ -7297,10 +6685,7 @@ export declare const enum PointerEventType {
|
|
|
7297
6685
|
PET_UP = 0,
|
|
7298
6686
|
PET_DOWN = 1,
|
|
7299
6687
|
PET_HOVER_ENTER = 2,
|
|
7300
|
-
PET_HOVER_LEAVE = 3
|
|
7301
|
-
PET_DRAG_LOCKED = 4,
|
|
7302
|
-
PET_DRAG = 5,
|
|
7303
|
-
PET_DRAG_END = 6
|
|
6688
|
+
PET_HOVER_LEAVE = 3
|
|
7304
6689
|
}
|
|
7305
6690
|
|
|
7306
6691
|
/**
|
|
@@ -7331,10 +6716,7 @@ export declare const enum PointerType {
|
|
|
7331
6716
|
/** POT_NONE - No pointer input */
|
|
7332
6717
|
POT_NONE = 0,
|
|
7333
6718
|
/** POT_MOUSE - Traditional mouse input */
|
|
7334
|
-
POT_MOUSE = 1
|
|
7335
|
-
POT_PAD = 2,
|
|
7336
|
-
POT_TOUCH = 3,
|
|
7337
|
-
POT_WAND = 4
|
|
6719
|
+
POT_MOUSE = 1
|
|
7338
6720
|
}
|
|
7339
6721
|
|
|
7340
6722
|
/**
|
|
@@ -7937,11 +7319,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
7937
7319
|
* Set the main UI renderer. Optional virtual size defines the global UI scale factor.
|
|
7938
7320
|
*/
|
|
7939
7321
|
setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
|
|
7940
|
-
/**
|
|
7941
|
-
* Set a texture renderer for a specific entity.
|
|
7942
|
-
* @deprecated Use addUiRenderer instead
|
|
7943
|
-
*/
|
|
7944
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
7945
7322
|
/**
|
|
7946
7323
|
* Add a UI renderer associated with an entity. The UI will be automatically cleaned up
|
|
7947
7324
|
* when the entity is removed from the engine.
|
|
@@ -8525,49 +7902,6 @@ export declare namespace Schemas {
|
|
|
8525
7902
|
}) => void;
|
|
8526
7903
|
}
|
|
8527
7904
|
|
|
8528
|
-
/**
|
|
8529
|
-
* @public
|
|
8530
|
-
*/
|
|
8531
|
-
export declare interface ScrollPositionValue {
|
|
8532
|
-
value?: {
|
|
8533
|
-
$case: "position";
|
|
8534
|
-
position: PBVector2;
|
|
8535
|
-
} | {
|
|
8536
|
-
$case: "reference";
|
|
8537
|
-
reference: string;
|
|
8538
|
-
} | undefined;
|
|
8539
|
-
}
|
|
8540
|
-
|
|
8541
|
-
/**
|
|
8542
|
-
* @public
|
|
8543
|
-
*/
|
|
8544
|
-
export declare namespace ScrollPositionValue {
|
|
8545
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
8546
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
8547
|
-
}
|
|
8548
|
-
|
|
8549
|
-
/**
|
|
8550
|
-
* @public
|
|
8551
|
-
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
|
8552
|
-
*/
|
|
8553
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
8554
|
-
|
|
8555
|
-
/**
|
|
8556
|
-
* Sets a globalThis property as a polyfill (only if undefined/null).
|
|
8557
|
-
* @public
|
|
8558
|
-
*/
|
|
8559
|
-
export declare function setGlobalPolyfill<T>(key: string, value: T): void;
|
|
8560
|
-
|
|
8561
|
-
/**
|
|
8562
|
-
* @public
|
|
8563
|
-
*/
|
|
8564
|
-
export declare const enum ShowScrollBar {
|
|
8565
|
-
SSB_BOTH = 0,
|
|
8566
|
-
SSB_ONLY_VERTICAL = 1,
|
|
8567
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
8568
|
-
SSB_HIDDEN = 3
|
|
8569
|
-
}
|
|
8570
|
-
|
|
8571
7905
|
/** @public */
|
|
8572
7906
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
8573
7907
|
|
|
@@ -8679,9 +8013,6 @@ export declare namespace Texture {
|
|
|
8679
8013
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
8680
8014
|
}
|
|
8681
8015
|
|
|
8682
|
-
/** @public */
|
|
8683
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
8684
|
-
|
|
8685
8016
|
/**
|
|
8686
8017
|
* @public
|
|
8687
8018
|
*/
|
|
@@ -8792,9 +8123,6 @@ export declare interface TextureUnion {
|
|
|
8792
8123
|
} | {
|
|
8793
8124
|
$case: "videoTexture";
|
|
8794
8125
|
videoTexture: VideoTexture;
|
|
8795
|
-
} | {
|
|
8796
|
-
$case: "uiTexture";
|
|
8797
|
-
uiTexture: UiCanvasTexture;
|
|
8798
8126
|
} | undefined;
|
|
8799
8127
|
}
|
|
8800
8128
|
|
|
@@ -9272,8 +8600,6 @@ export declare interface UiBackgroundProps {
|
|
|
9272
8600
|
uvs?: number[];
|
|
9273
8601
|
/** AvatarTexture for the background */
|
|
9274
8602
|
avatarTexture?: UiAvatarTexture;
|
|
9275
|
-
/** VideoTexture for the background */
|
|
9276
|
-
videoTexture?: UiVideoTexture;
|
|
9277
8603
|
/** Texture for the background */
|
|
9278
8604
|
texture?: UiTexture;
|
|
9279
8605
|
}
|
|
@@ -9293,31 +8619,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
9293
8619
|
disabled?: boolean;
|
|
9294
8620
|
}
|
|
9295
8621
|
|
|
9296
|
-
/** @public */
|
|
9297
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
9298
|
-
|
|
9299
8622
|
/** @public */
|
|
9300
8623
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
9301
8624
|
|
|
9302
|
-
/**
|
|
9303
|
-
* @public
|
|
9304
|
-
*/
|
|
9305
|
-
export declare interface UiCanvasTexture {
|
|
9306
|
-
uiCanvasEntity: number;
|
|
9307
|
-
/** default = TextureWrapMode.Clamp */
|
|
9308
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
9309
|
-
/** default = FilterMode.Bilinear */
|
|
9310
|
-
filterMode?: TextureFilterMode | undefined;
|
|
9311
|
-
}
|
|
9312
|
-
|
|
9313
|
-
/**
|
|
9314
|
-
* @public
|
|
9315
|
-
*/
|
|
9316
|
-
export declare namespace UiCanvasTexture {
|
|
9317
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
9318
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
9319
|
-
}
|
|
9320
|
-
|
|
9321
8625
|
/**
|
|
9322
8626
|
* @public
|
|
9323
8627
|
*/
|
|
@@ -9387,10 +8691,6 @@ export declare interface UiLabelProps {
|
|
|
9387
8691
|
textAlign?: TextAlignType | undefined;
|
|
9388
8692
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
9389
8693
|
font?: UiFontType | undefined;
|
|
9390
|
-
/** Outline width of the text. @defaultValue 0 */
|
|
9391
|
-
outlineWidth?: number | undefined;
|
|
9392
|
-
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
|
9393
|
-
outlineColor?: PBColor4 | undefined;
|
|
9394
8694
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
9395
8695
|
textWrap?: UiTextWrapType | undefined;
|
|
9396
8696
|
}
|
|
@@ -9408,9 +8708,6 @@ export declare type UiRendererOptions = {
|
|
|
9408
8708
|
virtualHeight: number;
|
|
9409
8709
|
};
|
|
9410
8710
|
|
|
9411
|
-
/** @public */
|
|
9412
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
9413
|
-
|
|
9414
8711
|
/** @public */
|
|
9415
8712
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
9416
8713
|
|
|
@@ -9488,31 +8785,23 @@ export declare interface UiTransformProps {
|
|
|
9488
8785
|
borderWidth?: Partial<Position> | PositionUnit;
|
|
9489
8786
|
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
|
9490
8787
|
opacity?: number;
|
|
9491
|
-
/** A reference value to identify the element, default empty */
|
|
9492
|
-
elementId?: string;
|
|
9493
|
-
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
|
9494
|
-
scrollPosition?: PBVector2 | string;
|
|
9495
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
9496
|
-
scrollVisible?: ScrollVisibleType;
|
|
9497
8788
|
/** default 0 */
|
|
9498
8789
|
zIndex?: number;
|
|
9499
8790
|
}
|
|
9500
8791
|
|
|
9501
|
-
/**
|
|
9502
|
-
* Texture
|
|
9503
|
-
* @public
|
|
9504
|
-
*/
|
|
9505
|
-
export declare interface UiVideoTexture {
|
|
9506
|
-
videoPlayerEntity: Entity;
|
|
9507
|
-
wrapMode?: TextureWrapType;
|
|
9508
|
-
filterMode?: TextureFilterType;
|
|
9509
|
-
}
|
|
9510
|
-
|
|
9511
8792
|
/**
|
|
9512
8793
|
* @public
|
|
9513
8794
|
*/
|
|
9514
8795
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
9515
8796
|
|
|
8797
|
+
export declare type ValidateCallback<T> = (value: {
|
|
8798
|
+
entity: Entity;
|
|
8799
|
+
currentValue: T | undefined;
|
|
8800
|
+
newValue: T | undefined;
|
|
8801
|
+
senderAddress: string;
|
|
8802
|
+
createdBy: string;
|
|
8803
|
+
}) => boolean;
|
|
8804
|
+
|
|
9516
8805
|
/**
|
|
9517
8806
|
* @public
|
|
9518
8807
|
*/
|