@dcl/playground-assets 7.22.4-24525731607.commit-cda77a9 → 7.22.5-24776890516.commit-b10e9ab
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 +99 -660
- package/dist/beta.d.ts +99 -660
- package/dist/index.bundled.d.ts +99 -660
- package/dist/index.js +9 -9
- package/dist/index.js.map +8 -0
- package/dist/playground/sdk/apis.d.ts +0 -11
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground/snippets/pointer-events.ts +7 -14
- package/dist/playground-assets.d.ts +99 -660
- package/dist/tsdoc-metadata.json +1 -1
- package/etc/playground-assets.api.json +6281 -12203
- package/etc/playground-assets.api.md +75 -409
- package/package.json +6 -5
package/dist/beta.d.ts
CHANGED
|
@@ -115,61 +115,6 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
|
|
|
115
115
|
*/
|
|
116
116
|
export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
|
|
117
117
|
|
|
118
|
-
export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
|
|
119
|
-
|
|
120
|
-
export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
|
|
121
|
-
/**
|
|
122
|
-
* Reads the component data of `entity` into the provided `out` view.
|
|
123
|
-
*
|
|
124
|
-
* @throws Error if the entity does not have an AudioAnalysis component.
|
|
125
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
126
|
-
* @param out - An existing AudioAnalysisView to populate with the latest values.
|
|
127
|
-
*/
|
|
128
|
-
readIntoView(entity: Entity, out: AudioAnalysisView): void;
|
|
129
|
-
/**
|
|
130
|
-
* Attempts to read the component data of `entity` into the provided `out` view.
|
|
131
|
-
*
|
|
132
|
-
* @returns `true` if the component exists and data was written into `out`,
|
|
133
|
-
* `false` if the entity does not have an AudioAnalysis component.
|
|
134
|
-
* @param entity - The entity whose AudioAnalysis data will be read.
|
|
135
|
-
* @param out - An existing AudioAnalysisView to populate.
|
|
136
|
-
*/
|
|
137
|
-
tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
|
|
138
|
-
/**
|
|
139
|
-
* Creates an AudioAnalysis component for the given `entity`.
|
|
140
|
-
*
|
|
141
|
-
* If a component already exists on the entity, this call fails (does not replace).
|
|
142
|
-
*
|
|
143
|
-
* @param entity - The entity to attach the component to.
|
|
144
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
145
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
146
|
-
* @param bandsGain - Optional gain multiplier applied to all frequency bands.
|
|
147
|
-
*/
|
|
148
|
-
createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
149
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
150
|
-
/**
|
|
151
|
-
* Creates the AudioAnalysis component if missing, or replaces the existing one.
|
|
152
|
-
*
|
|
153
|
-
* @param entity - The target entity.
|
|
154
|
-
* @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
|
|
155
|
-
* @param amplitudeGain - Optional amplitude gain multiplier.
|
|
156
|
-
* @param bandsGain - Optional gain multiplier applied to the frequency bands.
|
|
157
|
-
*/
|
|
158
|
-
createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
|
|
159
|
-
amplitudeGain?: number, bandsGain?: number): void;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* A read-only JavaScript-friendly view of AudioAnalysis ECS data.
|
|
164
|
-
*
|
|
165
|
-
* `amplitude` represents the aggregated signal strength.
|
|
166
|
-
* `bands` represents the processed frequency bands.
|
|
167
|
-
*/
|
|
168
|
-
export declare type AudioAnalysisView = {
|
|
169
|
-
amplitude: number;
|
|
170
|
-
bands: number[];
|
|
171
|
-
};
|
|
172
|
-
|
|
173
118
|
/** @public */
|
|
174
119
|
export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
|
|
175
120
|
|
|
@@ -218,6 +163,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
218
163
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
219
164
|
}
|
|
220
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
|
+
|
|
221
202
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
222
203
|
/**
|
|
223
204
|
* @public
|
|
@@ -261,21 +242,9 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
261
242
|
/** @public */
|
|
262
243
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
263
244
|
|
|
264
|
-
/** Mask for which bones an animation applies to. */
|
|
265
|
-
/**
|
|
266
|
-
* @public
|
|
267
|
-
*/
|
|
268
|
-
export declare const enum AvatarEmoteMask {
|
|
269
|
-
AEM_FULL_BODY = 0,
|
|
270
|
-
AEM_UPPER_BODY = 1
|
|
271
|
-
}
|
|
272
|
-
|
|
273
245
|
/** @public */
|
|
274
246
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
275
247
|
|
|
276
|
-
/** @public */
|
|
277
|
-
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
278
|
-
|
|
279
248
|
/** @public */
|
|
280
249
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
281
250
|
|
|
@@ -389,6 +358,22 @@ export declare interface BaseComponent<T> {
|
|
|
389
358
|
* If the value is undefined, the component was deleted.
|
|
390
359
|
*/
|
|
391
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;
|
|
392
377
|
}
|
|
393
378
|
|
|
394
379
|
/** @public */
|
|
@@ -1355,23 +1340,6 @@ export declare type Color4Type = {
|
|
|
1355
1340
|
a: number;
|
|
1356
1341
|
};
|
|
1357
1342
|
|
|
1358
|
-
/** A range of Color4 values. Randomized or lerped between start and end. */
|
|
1359
|
-
/**
|
|
1360
|
-
* @public
|
|
1361
|
-
*/
|
|
1362
|
-
export declare interface ColorRange {
|
|
1363
|
-
start: PBColor4 | undefined;
|
|
1364
|
-
end: PBColor4 | undefined;
|
|
1365
|
-
}
|
|
1366
|
-
|
|
1367
|
-
/**
|
|
1368
|
-
* @public
|
|
1369
|
-
*/
|
|
1370
|
-
export declare namespace ColorRange {
|
|
1371
|
-
export function encode(message: ColorRange, writer?: _m0.Writer): _m0.Writer;
|
|
1372
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ColorRange;
|
|
1373
|
-
}
|
|
1374
|
-
|
|
1375
1343
|
/**
|
|
1376
1344
|
* @public
|
|
1377
1345
|
*/
|
|
@@ -1405,7 +1373,6 @@ export declare const componentDefinitionByName: {
|
|
|
1405
1373
|
"core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
|
|
1406
1374
|
"core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
|
|
1407
1375
|
"core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
|
|
1408
|
-
"core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
|
|
1409
1376
|
"core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
|
|
1410
1377
|
"core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
|
|
1411
1378
|
"core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
|
|
@@ -1413,7 +1380,6 @@ export declare const componentDefinitionByName: {
|
|
|
1413
1380
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1414
1381
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1415
1382
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1416
|
-
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1417
1383
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1418
1384
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1419
1385
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
@@ -1430,7 +1396,6 @@ export declare const componentDefinitionByName: {
|
|
|
1430
1396
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
|
1431
1397
|
"core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
|
|
1432
1398
|
"core::NftShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBNftShape>>;
|
|
1433
|
-
"core::ParticleSystem": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBParticleSystem>>;
|
|
1434
1399
|
"core::PhysicsCombinedForce": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>>;
|
|
1435
1400
|
"core::PhysicsCombinedImpulse": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>>;
|
|
1436
1401
|
"core::PlayerIdentityData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPlayerIdentityData>>;
|
|
@@ -1619,12 +1584,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1619
1584
|
/**
|
|
1620
1585
|
* @public
|
|
1621
1586
|
*/
|
|
1622
|
-
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1587
|
+
export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1623
1588
|
|
|
1624
1589
|
/**
|
|
1625
1590
|
* @public
|
|
1626
1591
|
*/
|
|
1627
|
-
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1592
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1628
1593
|
|
|
1629
1594
|
/**
|
|
1630
1595
|
* Min length = 8 bytes
|
|
@@ -1679,7 +1644,8 @@ export declare enum CrdtMessageType {
|
|
|
1679
1644
|
PUT_COMPONENT_NETWORK = 5,
|
|
1680
1645
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1681
1646
|
DELETE_ENTITY_NETWORK = 7,
|
|
1682
|
-
|
|
1647
|
+
AUTHORITATIVE_PUT_COMPONENT = 8,
|
|
1648
|
+
MAX_MESSAGE_TYPE = 9
|
|
1683
1649
|
}
|
|
1684
1650
|
|
|
1685
1651
|
/**
|
|
@@ -1687,6 +1653,8 @@ export declare enum CrdtMessageType {
|
|
|
1687
1653
|
*/
|
|
1688
1654
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1689
1655
|
|
|
1656
|
+
export declare const CreatedBy: ICreatedBy;
|
|
1657
|
+
|
|
1690
1658
|
/**
|
|
1691
1659
|
* @public
|
|
1692
1660
|
*/
|
|
@@ -2121,7 +2089,6 @@ export declare type EventSystemOptions = {
|
|
|
2121
2089
|
showFeedback?: boolean;
|
|
2122
2090
|
showHighlight?: boolean;
|
|
2123
2091
|
maxPlayerDistance?: number;
|
|
2124
|
-
priority?: number;
|
|
2125
2092
|
};
|
|
2126
2093
|
|
|
2127
2094
|
/**
|
|
@@ -2235,23 +2202,6 @@ export declare type FlexWrapType = 'wrap' | 'nowrap' | 'wrap-reverse';
|
|
|
2235
2202
|
/** @public */
|
|
2236
2203
|
export declare type FloatArray = number[];
|
|
2237
2204
|
|
|
2238
|
-
/** A range of float values. Randomized or lerped between start and end. */
|
|
2239
|
-
/**
|
|
2240
|
-
* @public
|
|
2241
|
-
*/
|
|
2242
|
-
export declare interface FloatRange {
|
|
2243
|
-
start: number;
|
|
2244
|
-
end: number;
|
|
2245
|
-
}
|
|
2246
|
-
|
|
2247
|
-
/**
|
|
2248
|
-
* @public
|
|
2249
|
-
*/
|
|
2250
|
-
export declare namespace FloatRange {
|
|
2251
|
-
export function encode(message: FloatRange, writer?: _m0.Writer): _m0.Writer;
|
|
2252
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): FloatRange;
|
|
2253
|
-
}
|
|
2254
|
-
|
|
2255
2205
|
/**
|
|
2256
2206
|
* @public
|
|
2257
2207
|
*/
|
|
@@ -2406,6 +2356,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2406
2356
|
|
|
2407
2357
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2408
2358
|
|
|
2359
|
+
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2360
|
+
|
|
2361
|
+
export declare interface ICreatedByType {
|
|
2362
|
+
address: string;
|
|
2363
|
+
}
|
|
2364
|
+
|
|
2409
2365
|
/**
|
|
2410
2366
|
* @public
|
|
2411
2367
|
*/
|
|
@@ -2792,8 +2748,7 @@ export declare const enum InputAction {
|
|
|
2792
2748
|
IA_ACTION_3 = 10,
|
|
2793
2749
|
IA_ACTION_4 = 11,
|
|
2794
2750
|
IA_ACTION_5 = 12,
|
|
2795
|
-
IA_ACTION_6 = 13
|
|
2796
|
-
IA_MODIFIER = 14
|
|
2751
|
+
IA_ACTION_6 = 13
|
|
2797
2752
|
}
|
|
2798
2753
|
|
|
2799
2754
|
export declare const InputModifier: InputModifierComponentDefinitionExtended;
|
|
@@ -2842,11 +2797,32 @@ export declare type InstanceCompositeOptions = {
|
|
|
2842
2797
|
};
|
|
2843
2798
|
|
|
2844
2799
|
/**
|
|
2845
|
-
*
|
|
2800
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
2801
|
+
* This is not exposed to users, only for internal SDK operations
|
|
2846
2802
|
*/
|
|
2847
|
-
export declare
|
|
2848
|
-
|
|
2849
|
-
|
|
2803
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
2804
|
+
/**
|
|
2805
|
+
* @public
|
|
2806
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
2807
|
+
*/
|
|
2808
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
2809
|
+
/**
|
|
2810
|
+
* @public
|
|
2811
|
+
* Get the iterator to every entity has the component
|
|
2812
|
+
*/
|
|
2813
|
+
iterator(): Iterable<[Entity, any]>;
|
|
2814
|
+
/**
|
|
2815
|
+
* @public
|
|
2816
|
+
*/
|
|
2817
|
+
dirtyIterator(): Iterable<Entity>;
|
|
2818
|
+
/**
|
|
2819
|
+
* @public
|
|
2820
|
+
*/
|
|
2821
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
2822
|
+
/**
|
|
2823
|
+
* @public
|
|
2824
|
+
*/
|
|
2825
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
2850
2826
|
}
|
|
2851
2827
|
|
|
2852
2828
|
/**
|
|
@@ -2927,19 +2903,6 @@ export declare type JustifyType = 'flex-start' | 'center' | 'flex-end' | 'space-
|
|
|
2927
2903
|
*/
|
|
2928
2904
|
export declare type Key = number | string;
|
|
2929
2905
|
|
|
2930
|
-
/**
|
|
2931
|
-
* @public
|
|
2932
|
-
* Falloff mode for knockback force over distance.
|
|
2933
|
-
*/
|
|
2934
|
-
export declare enum KnockbackFalloff {
|
|
2935
|
-
/** Same force at any distance within radius */
|
|
2936
|
-
CONSTANT = 0,
|
|
2937
|
-
/** Smooth linear decrease to 0 at radius edge: F = magnitude * (1 - distance / radius) */
|
|
2938
|
-
LINEAR = 1,
|
|
2939
|
-
/** Sharp drop-off, physically realistic: F = magnitude / (distance^2 + 1) */
|
|
2940
|
-
INVERSE_SQUARE = 2
|
|
2941
|
-
}
|
|
2942
|
-
|
|
2943
2906
|
/**
|
|
2944
2907
|
*
|
|
2945
2908
|
* @public
|
|
@@ -4450,30 +4413,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4450
4413
|
*/
|
|
4451
4414
|
export declare type OverflowType = 'hidden' | 'scroll' | 'visible';
|
|
4452
4415
|
|
|
4453
|
-
export declare const ParticleSystem: ParticleSystemComponentDefinitionExtended;
|
|
4454
|
-
|
|
4455
|
-
/**
|
|
4456
|
-
* @public
|
|
4457
|
-
*/
|
|
4458
|
-
export declare interface ParticleSystemComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBParticleSystem> {
|
|
4459
|
-
/** Helpers for constructing emitter shapes */
|
|
4460
|
-
Shape: ParticleSystemHelper;
|
|
4461
|
-
}
|
|
4462
|
-
|
|
4463
|
-
/**
|
|
4464
|
-
* @public
|
|
4465
|
-
*/
|
|
4466
|
-
export declare interface ParticleSystemHelper {
|
|
4467
|
-
/** Emit from a single point */
|
|
4468
|
-
Point: (point?: PBParticleSystem_Point) => PBParticleSystem['shape'];
|
|
4469
|
-
/** Emit from the surface or volume of a sphere */
|
|
4470
|
-
Sphere: (sphere?: PBParticleSystem_Sphere) => PBParticleSystem['shape'];
|
|
4471
|
-
/** Emit from the base of a cone, projecting outward */
|
|
4472
|
-
Cone: (cone?: PBParticleSystem_Cone) => PBParticleSystem['shape'];
|
|
4473
|
-
/** Emit from the surface or volume of a box */
|
|
4474
|
-
Box: (box?: PBParticleSystem_Box) => PBParticleSystem['shape'];
|
|
4475
|
-
}
|
|
4476
|
-
|
|
4477
4416
|
/** AnimationState indicates the status and configuration of one available animation. */
|
|
4478
4417
|
/**
|
|
4479
4418
|
* @public
|
|
@@ -4566,45 +4505,6 @@ export declare namespace PBAssetLoadLoadingState {
|
|
|
4566
4505
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
|
|
4567
4506
|
}
|
|
4568
4507
|
|
|
4569
|
-
/**
|
|
4570
|
-
* @public
|
|
4571
|
-
*/
|
|
4572
|
-
export declare interface PBAudioAnalysis {
|
|
4573
|
-
/** Parameters section */
|
|
4574
|
-
mode: PBAudioAnalysisMode;
|
|
4575
|
-
/** Used only when mode == MODE_LOGARITHMIC */
|
|
4576
|
-
amplitudeGain?: number | undefined;
|
|
4577
|
-
/** End when mode == MODE_LOGARITHMIC */
|
|
4578
|
-
bandsGain?: number | undefined;
|
|
4579
|
-
/** Result section */
|
|
4580
|
-
amplitude: number;
|
|
4581
|
-
/** Protobuf doesn't support fixed arrays -> 8 band fields */
|
|
4582
|
-
band0: number;
|
|
4583
|
-
band1: number;
|
|
4584
|
-
band2: number;
|
|
4585
|
-
band3: number;
|
|
4586
|
-
band4: number;
|
|
4587
|
-
band5: number;
|
|
4588
|
-
band6: number;
|
|
4589
|
-
band7: number;
|
|
4590
|
-
}
|
|
4591
|
-
|
|
4592
|
-
/**
|
|
4593
|
-
* @public
|
|
4594
|
-
*/
|
|
4595
|
-
export declare namespace PBAudioAnalysis {
|
|
4596
|
-
export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
|
|
4597
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
|
|
4598
|
-
}
|
|
4599
|
-
|
|
4600
|
-
/**
|
|
4601
|
-
* @public
|
|
4602
|
-
*/
|
|
4603
|
-
export declare const enum PBAudioAnalysisMode {
|
|
4604
|
-
MODE_RAW = 0,
|
|
4605
|
-
MODE_LOGARITHMIC = 1
|
|
4606
|
-
}
|
|
4607
|
-
|
|
4608
4508
|
/**
|
|
4609
4509
|
* @public
|
|
4610
4510
|
*/
|
|
@@ -4794,42 +4694,6 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4794
4694
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4795
4695
|
}
|
|
4796
4696
|
|
|
4797
|
-
/**
|
|
4798
|
-
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4799
|
-
* as the avatar movement speed, jump height etc.
|
|
4800
|
-
*/
|
|
4801
|
-
/**
|
|
4802
|
-
* @public
|
|
4803
|
-
*/
|
|
4804
|
-
export declare interface PBAvatarLocomotionSettings {
|
|
4805
|
-
/** Maximum speed when walking (in meters per second) */
|
|
4806
|
-
walkSpeed?: number | undefined;
|
|
4807
|
-
/** Maximum speed when jogging (in meters per second) */
|
|
4808
|
-
jogSpeed?: number | undefined;
|
|
4809
|
-
/** Maximum speed when running (in meters per second) */
|
|
4810
|
-
runSpeed?: number | undefined;
|
|
4811
|
-
/** Height of a regular jump (in meters) */
|
|
4812
|
-
jumpHeight?: number | undefined;
|
|
4813
|
-
/** Height of a jump while running (in meters) */
|
|
4814
|
-
runJumpHeight?: number | undefined;
|
|
4815
|
-
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4816
|
-
hardLandingCooldown?: number | undefined;
|
|
4817
|
-
/** Height of the double jump (in meters) */
|
|
4818
|
-
doubleJumpHeight?: number | undefined;
|
|
4819
|
-
/** Maximum speed when gliding (in meters per second) */
|
|
4820
|
-
glidingSpeed?: number | undefined;
|
|
4821
|
-
/** Maximum falling speed when gliding (in meters per second) */
|
|
4822
|
-
glidingFallingSpeed?: number | undefined;
|
|
4823
|
-
}
|
|
4824
|
-
|
|
4825
|
-
/**
|
|
4826
|
-
* @public
|
|
4827
|
-
*/
|
|
4828
|
-
export declare namespace PBAvatarLocomotionSettings {
|
|
4829
|
-
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4830
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4831
|
-
}
|
|
4832
|
-
|
|
4833
4697
|
/**
|
|
4834
4698
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4835
4699
|
* avatar behavior changes.
|
|
@@ -5600,267 +5464,6 @@ export declare namespace PBNftShape {
|
|
|
5600
5464
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
|
|
5601
5465
|
}
|
|
5602
5466
|
|
|
5603
|
-
/**
|
|
5604
|
-
* @public
|
|
5605
|
-
*/
|
|
5606
|
-
export declare interface PBParticleSystem {
|
|
5607
|
-
/** --- Emission --- */
|
|
5608
|
-
active?: boolean | undefined;
|
|
5609
|
-
/** default = 10. Particles emitted per second. */
|
|
5610
|
-
rate?: number | undefined;
|
|
5611
|
-
/** default = 1000. Maximum number of live particles. */
|
|
5612
|
-
maxParticles?: number | undefined;
|
|
5613
|
-
/** default = 5. Particle lifetime in seconds. */
|
|
5614
|
-
lifetime?: number | undefined;
|
|
5615
|
-
/** --- Motion --- */
|
|
5616
|
-
gravity?: number | undefined;
|
|
5617
|
-
/** Constant force vector applied to each particle (world space). */
|
|
5618
|
-
additionalForce?: PBVector3 | undefined;
|
|
5619
|
-
/** --- Size --- */
|
|
5620
|
-
initialSize?: FloatRange | undefined;
|
|
5621
|
-
/** default = {1, 1}. Particle size lerped from start to end over its lifetime. */
|
|
5622
|
-
sizeOverTime?: FloatRange | undefined;
|
|
5623
|
-
/** --- Rotation --- */
|
|
5624
|
-
initialRotation?: PBQuaternion | undefined;
|
|
5625
|
-
/** default = identity (0,0,0,1). Per-axis angular velocity as quaternion; converted to Euler XYZ. */
|
|
5626
|
-
rotationOverTime?: PBQuaternion | undefined;
|
|
5627
|
-
/** default = false. Particles orient along their velocity direction. */
|
|
5628
|
-
faceTravelDirection?: boolean | undefined;
|
|
5629
|
-
/** --- Color --- */
|
|
5630
|
-
initialColor?: ColorRange | undefined;
|
|
5631
|
-
/** default = {white, white}. Particle color lerped from start to end over its lifetime. */
|
|
5632
|
-
colorOverTime?: ColorRange | undefined;
|
|
5633
|
-
/** --- Velocity --- */
|
|
5634
|
-
initialVelocitySpeed?: FloatRange | undefined;
|
|
5635
|
-
/** --- Rendering --- */
|
|
5636
|
-
texture?: Texture | undefined;
|
|
5637
|
-
/** default = PSB_ALPHA */
|
|
5638
|
-
blendMode?: PBParticleSystem_BlendMode | undefined;
|
|
5639
|
-
/** default = true */
|
|
5640
|
-
billboard?: boolean | undefined;
|
|
5641
|
-
/** --- Sprite Sheet Animation --- */
|
|
5642
|
-
spriteSheet?: PBParticleSystem_SpriteSheetAnimation | undefined;
|
|
5643
|
-
shape?: {
|
|
5644
|
-
$case: "point";
|
|
5645
|
-
point: PBParticleSystem_Point;
|
|
5646
|
-
} | {
|
|
5647
|
-
$case: "sphere";
|
|
5648
|
-
sphere: PBParticleSystem_Sphere;
|
|
5649
|
-
} | {
|
|
5650
|
-
$case: "cone";
|
|
5651
|
-
cone: PBParticleSystem_Cone;
|
|
5652
|
-
} | {
|
|
5653
|
-
$case: "box";
|
|
5654
|
-
box: PBParticleSystem_Box;
|
|
5655
|
-
} | undefined;
|
|
5656
|
-
/** --- Simulation --- */
|
|
5657
|
-
loop?: boolean | undefined;
|
|
5658
|
-
/** default = false. Start as if already simulated for one full loop cycle. Requires loop = true. */
|
|
5659
|
-
prewarm?: boolean | undefined;
|
|
5660
|
-
/** default = PSS_LOCAL. Controls whether particles simulate in local or world space. */
|
|
5661
|
-
simulationSpace?: PBParticleSystem_SimulationSpace | undefined;
|
|
5662
|
-
/** --- Limit Velocity Over Lifetime --- */
|
|
5663
|
-
limitVelocity?: PBParticleSystem_LimitVelocity | undefined;
|
|
5664
|
-
/** --- Playback --- */
|
|
5665
|
-
playbackState?: PBParticleSystem_PlaybackState | undefined;
|
|
5666
|
-
/** --- Emission Bursts --- */
|
|
5667
|
-
bursts?: PBParticleSystem_BurstConfiguration | undefined;
|
|
5668
|
-
}
|
|
5669
|
-
|
|
5670
|
-
/**
|
|
5671
|
-
* @public
|
|
5672
|
-
*/
|
|
5673
|
-
export declare namespace PBParticleSystem {
|
|
5674
|
-
export function encode(message: PBParticleSystem, writer?: _m0.Writer): _m0.Writer;
|
|
5675
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem;
|
|
5676
|
-
}
|
|
5677
|
-
|
|
5678
|
-
/**
|
|
5679
|
-
* @public
|
|
5680
|
-
*/
|
|
5681
|
-
declare const enum PBParticleSystem_BlendMode {
|
|
5682
|
-
/** PSB_ALPHA - Standard alpha transparency. */
|
|
5683
|
-
PSB_ALPHA = 0,
|
|
5684
|
-
/** PSB_ADD - Additive blending (brightens underlying pixels). */
|
|
5685
|
-
PSB_ADD = 1,
|
|
5686
|
-
/** PSB_MULTIPLY - Multiply blending (darkens underlying pixels). */
|
|
5687
|
-
PSB_MULTIPLY = 2
|
|
5688
|
-
}
|
|
5689
|
-
export { PBParticleSystem_BlendMode }
|
|
5690
|
-
export { PBParticleSystem_BlendMode as ParticleSystemBlendMode }
|
|
5691
|
-
|
|
5692
|
-
/** Emitter spawns particles from the surface or volume of a box. */
|
|
5693
|
-
/**
|
|
5694
|
-
* @public
|
|
5695
|
-
*/
|
|
5696
|
-
export declare interface PBParticleSystem_Box {
|
|
5697
|
-
/** default = {1, 1, 1} */
|
|
5698
|
-
size?: PBVector3 | undefined;
|
|
5699
|
-
}
|
|
5700
|
-
|
|
5701
|
-
/**
|
|
5702
|
-
* @public
|
|
5703
|
-
*/
|
|
5704
|
-
export declare namespace PBParticleSystem_Box {
|
|
5705
|
-
export function encode(message: PBParticleSystem_Box, writer?: _m0.Writer): _m0.Writer;
|
|
5706
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Box;
|
|
5707
|
-
}
|
|
5708
|
-
|
|
5709
|
-
/**
|
|
5710
|
-
* @public
|
|
5711
|
-
*/
|
|
5712
|
-
export declare interface PBParticleSystem_Burst {
|
|
5713
|
-
/** Seconds from start of cycle. */
|
|
5714
|
-
time: number;
|
|
5715
|
-
/** Particles to emit. */
|
|
5716
|
-
count: number;
|
|
5717
|
-
/** default = 1. Repeat count (0 = infinite). */
|
|
5718
|
-
cycles?: number | undefined;
|
|
5719
|
-
/** default = 0.01. Seconds between cycles. */
|
|
5720
|
-
interval?: number | undefined;
|
|
5721
|
-
/** default = 1.0. Emission chance [0,1]. */
|
|
5722
|
-
probability?: number | undefined;
|
|
5723
|
-
}
|
|
5724
|
-
|
|
5725
|
-
/**
|
|
5726
|
-
* @public
|
|
5727
|
-
*/
|
|
5728
|
-
export declare namespace PBParticleSystem_Burst {
|
|
5729
|
-
export function encode(message: PBParticleSystem_Burst, writer?: _m0.Writer): _m0.Writer;
|
|
5730
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Burst;
|
|
5731
|
-
}
|
|
5732
|
-
|
|
5733
|
-
/** Emission burst configuration. */
|
|
5734
|
-
/**
|
|
5735
|
-
* @public
|
|
5736
|
-
*/
|
|
5737
|
-
export declare interface PBParticleSystem_BurstConfiguration {
|
|
5738
|
-
values: PBParticleSystem_Burst[];
|
|
5739
|
-
}
|
|
5740
|
-
|
|
5741
|
-
/**
|
|
5742
|
-
* @public
|
|
5743
|
-
*/
|
|
5744
|
-
export declare namespace PBParticleSystem_BurstConfiguration {
|
|
5745
|
-
export function encode(message: PBParticleSystem_BurstConfiguration, writer?: _m0.Writer): _m0.Writer;
|
|
5746
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_BurstConfiguration;
|
|
5747
|
-
}
|
|
5748
|
-
|
|
5749
|
-
/** Emitter spawns particles from the base of a cone and projects them outward. */
|
|
5750
|
-
/**
|
|
5751
|
-
* @public
|
|
5752
|
-
*/
|
|
5753
|
-
export declare interface PBParticleSystem_Cone {
|
|
5754
|
-
/** default = 25. Half-angle of the cone in degrees. */
|
|
5755
|
-
angle?: number | undefined;
|
|
5756
|
-
/** default = 1. Base radius in meters. */
|
|
5757
|
-
radius?: number | undefined;
|
|
5758
|
-
}
|
|
5759
|
-
|
|
5760
|
-
/**
|
|
5761
|
-
* @public
|
|
5762
|
-
*/
|
|
5763
|
-
export declare namespace PBParticleSystem_Cone {
|
|
5764
|
-
export function encode(message: PBParticleSystem_Cone, writer?: _m0.Writer): _m0.Writer;
|
|
5765
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Cone;
|
|
5766
|
-
}
|
|
5767
|
-
|
|
5768
|
-
/** Clamps particle speed over lifetime. */
|
|
5769
|
-
/**
|
|
5770
|
-
* @public
|
|
5771
|
-
*/
|
|
5772
|
-
export declare interface PBParticleSystem_LimitVelocity {
|
|
5773
|
-
/** Maximum particle speed (m/s). */
|
|
5774
|
-
speed: number;
|
|
5775
|
-
/** default = 1. Fraction (0–1) of excess velocity removed per frame. 1 = hard clamp. */
|
|
5776
|
-
dampen?: number | undefined;
|
|
5777
|
-
}
|
|
5778
|
-
|
|
5779
|
-
/**
|
|
5780
|
-
* @public
|
|
5781
|
-
*/
|
|
5782
|
-
export declare namespace PBParticleSystem_LimitVelocity {
|
|
5783
|
-
export function encode(message: PBParticleSystem_LimitVelocity, writer?: _m0.Writer): _m0.Writer;
|
|
5784
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_LimitVelocity;
|
|
5785
|
-
}
|
|
5786
|
-
|
|
5787
|
-
/**
|
|
5788
|
-
* @public
|
|
5789
|
-
*/
|
|
5790
|
-
declare const enum PBParticleSystem_PlaybackState {
|
|
5791
|
-
/** PS_PLAYING - Particle system is emitting and simulating. */
|
|
5792
|
-
PS_PLAYING = 0,
|
|
5793
|
-
/** PS_PAUSED - Simulation is frozen; no new particles are emitted. */
|
|
5794
|
-
PS_PAUSED = 1,
|
|
5795
|
-
/** PS_STOPPED - Simulation stopped and existing particles cleared. */
|
|
5796
|
-
PS_STOPPED = 2
|
|
5797
|
-
}
|
|
5798
|
-
export { PBParticleSystem_PlaybackState }
|
|
5799
|
-
export { PBParticleSystem_PlaybackState as ParticleSystemPlaybackState }
|
|
5800
|
-
|
|
5801
|
-
/** Emitter spawns particles from a single point. */
|
|
5802
|
-
/**
|
|
5803
|
-
* @public
|
|
5804
|
-
*/
|
|
5805
|
-
export declare interface PBParticleSystem_Point {
|
|
5806
|
-
}
|
|
5807
|
-
|
|
5808
|
-
/**
|
|
5809
|
-
* @public
|
|
5810
|
-
*/
|
|
5811
|
-
export declare namespace PBParticleSystem_Point {
|
|
5812
|
-
export function encode(_: PBParticleSystem_Point, writer?: _m0.Writer): _m0.Writer;
|
|
5813
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Point;
|
|
5814
|
-
}
|
|
5815
|
-
|
|
5816
|
-
/**
|
|
5817
|
-
* @public
|
|
5818
|
-
*/
|
|
5819
|
-
export declare const enum PBParticleSystem_SimulationSpace {
|
|
5820
|
-
/** PSS_LOCAL - Particles move with the entity transform. */
|
|
5821
|
-
PSS_LOCAL = 0,
|
|
5822
|
-
/** PSS_WORLD - Particles stay in world position after emission. */
|
|
5823
|
-
PSS_WORLD = 1
|
|
5824
|
-
}
|
|
5825
|
-
|
|
5826
|
-
/** Emitter spawns particles from the surface or volume of a sphere. */
|
|
5827
|
-
/**
|
|
5828
|
-
* @public
|
|
5829
|
-
*/
|
|
5830
|
-
export declare interface PBParticleSystem_Sphere {
|
|
5831
|
-
/** default = 1 */
|
|
5832
|
-
radius?: number | undefined;
|
|
5833
|
-
}
|
|
5834
|
-
|
|
5835
|
-
/**
|
|
5836
|
-
* @public
|
|
5837
|
-
*/
|
|
5838
|
-
export declare namespace PBParticleSystem_Sphere {
|
|
5839
|
-
export function encode(message: PBParticleSystem_Sphere, writer?: _m0.Writer): _m0.Writer;
|
|
5840
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Sphere;
|
|
5841
|
-
}
|
|
5842
|
-
|
|
5843
|
-
/** Sprite sheet (texture atlas) animation settings. */
|
|
5844
|
-
/**
|
|
5845
|
-
* @public
|
|
5846
|
-
*/
|
|
5847
|
-
export declare interface PBParticleSystem_SpriteSheetAnimation {
|
|
5848
|
-
/** Number of columns in the sprite sheet. */
|
|
5849
|
-
tilesX: number;
|
|
5850
|
-
/** Number of rows in the sprite sheet. */
|
|
5851
|
-
tilesY: number;
|
|
5852
|
-
/** default = 30. Playback speed in frames per second. */
|
|
5853
|
-
framesPerSecond?: number | undefined;
|
|
5854
|
-
}
|
|
5855
|
-
|
|
5856
|
-
/**
|
|
5857
|
-
* @public
|
|
5858
|
-
*/
|
|
5859
|
-
export declare namespace PBParticleSystem_SpriteSheetAnimation {
|
|
5860
|
-
export function encode(message: PBParticleSystem_SpriteSheetAnimation, writer?: _m0.Writer): _m0.Writer;
|
|
5861
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_SpriteSheetAnimation;
|
|
5862
|
-
}
|
|
5863
|
-
|
|
5864
5467
|
/**
|
|
5865
5468
|
* This component applies a continuous physics force.
|
|
5866
5469
|
*
|
|
@@ -5998,8 +5601,6 @@ export declare interface PBPointerEvents_Entry {
|
|
|
5998
5601
|
eventType: PointerEventType;
|
|
5999
5602
|
/** additional configuration for this detection */
|
|
6000
5603
|
eventInfo: PBPointerEvents_Info | undefined;
|
|
6001
|
-
/** the type of interaction source (default 0 == CURSOR) */
|
|
6002
|
-
interactionType?: InteractionType | undefined;
|
|
6003
5604
|
}
|
|
6004
5605
|
|
|
6005
5606
|
/**
|
|
@@ -6026,8 +5627,6 @@ export declare interface PBPointerEvents_Info {
|
|
|
6026
5627
|
showHighlight?: boolean | undefined;
|
|
6027
5628
|
/** range of interaction from the avatar's position (default 0) */
|
|
6028
5629
|
maxPlayerDistance?: number | undefined;
|
|
6029
|
-
/** resolution order when multiple events overlap, higher wins (default 0) */
|
|
6030
|
-
priority?: number | undefined;
|
|
6031
5630
|
}
|
|
6032
5631
|
|
|
6033
5632
|
/**
|
|
@@ -6904,7 +6503,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6904
6503
|
* an 'instant' transition (like using speed/time = 0)
|
|
6905
6504
|
* * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
|
|
6906
6505
|
* the holding entity transform).
|
|
6907
|
-
* * The fov defines the Field of View of the virtual camera
|
|
6908
6506
|
*/
|
|
6909
6507
|
/**
|
|
6910
6508
|
* @public
|
|
@@ -6912,8 +6510,6 @@ export declare namespace PBVideoPlayer {
|
|
|
6912
6510
|
export declare interface PBVirtualCamera {
|
|
6913
6511
|
defaultTransition?: CameraTransition | undefined;
|
|
6914
6512
|
lookAtEntity?: number | undefined;
|
|
6915
|
-
/** default: 60 */
|
|
6916
|
-
fov?: number | undefined;
|
|
6917
6513
|
}
|
|
6918
6514
|
|
|
6919
6515
|
/**
|
|
@@ -6948,92 +6544,12 @@ export declare namespace PBVisibilityComponent {
|
|
|
6948
6544
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6949
6545
|
}
|
|
6950
6546
|
|
|
6951
|
-
/**
|
|
6952
|
-
* @public
|
|
6953
|
-
* Physics helpers for applying impulses and forces to the player.
|
|
6954
|
-
*/
|
|
6955
|
-
export declare const Physics: PhysicsSystem;
|
|
6956
|
-
|
|
6957
6547
|
/** @public */
|
|
6958
6548
|
export declare const PhysicsCombinedForce: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>;
|
|
6959
6549
|
|
|
6960
6550
|
/** @public */
|
|
6961
6551
|
export declare const PhysicsCombinedImpulse: LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>;
|
|
6962
6552
|
|
|
6963
|
-
/**
|
|
6964
|
-
* @public
|
|
6965
|
-
*/
|
|
6966
|
-
export declare interface PhysicsSystem {
|
|
6967
|
-
/**
|
|
6968
|
-
* Apply a one-shot impulse to the player entity.
|
|
6969
|
-
* Multiple calls within the same frame are accumulated (summed).
|
|
6970
|
-
*
|
|
6971
|
-
* @param vector - a single `vector` whose length encodes the strength.
|
|
6972
|
-
* or use overload for `direction` with a separate `magnitude` — the direction will be normalized before scaling.
|
|
6973
|
-
*/
|
|
6974
|
-
applyImpulseToPlayer(vector: Vector3Type): void;
|
|
6975
|
-
applyImpulseToPlayer(direction: Vector3Type, magnitude: number): void;
|
|
6976
|
-
/**
|
|
6977
|
-
* Apply a continuous force to the player from a given source entity.
|
|
6978
|
-
* Multiple sources are accumulated: the registry sums all active forces
|
|
6979
|
-
* and writes a single PBPhysicsCombinedForce component.
|
|
6980
|
-
* Calling again with the same source replaces its previous force.
|
|
6981
|
-
*
|
|
6982
|
-
* @param source - Entity key identifying this force source
|
|
6983
|
-
* @param vector - single `vector` whose length encodes the strength
|
|
6984
|
-
* or use overload for `direction` with a separate `magnitude` — the direction will be normalized before scaling.
|
|
6985
|
-
*/
|
|
6986
|
-
applyForceToPlayer(source: Entity, vector: Vector3Type): void;
|
|
6987
|
-
applyForceToPlayer(source: Entity, direction: Vector3Type, magnitude: number): void;
|
|
6988
|
-
/**
|
|
6989
|
-
* Remove a continuous force from the player. Remaining sources are
|
|
6990
|
-
* re-summed; if none remain the force is cleared. No-op if the source
|
|
6991
|
-
* is not registered.
|
|
6992
|
-
*
|
|
6993
|
-
* @param source - Entity key identifying the force source to remove
|
|
6994
|
-
*/
|
|
6995
|
-
removeForceFromPlayer(source: Entity): void;
|
|
6996
|
-
/**
|
|
6997
|
-
* Push the player away from a point. Computes direction from
|
|
6998
|
-
* `fromPosition` to the player, applies falloff, and delegates
|
|
6999
|
-
* to applyImpulseToPlayer.
|
|
7000
|
-
*
|
|
7001
|
-
* If the player is exactly at `fromPosition`, pushes upward.
|
|
7002
|
-
*
|
|
7003
|
-
* @param fromPosition - world-space origin of the knockback (explosion center, enemy position, etc.)
|
|
7004
|
-
* @param magnitude - base impulse strength
|
|
7005
|
-
* @param radius - max distance of effect (default: Infinity)
|
|
7006
|
-
* @param falloff - how force decreases with distance (default: CONSTANT)
|
|
7007
|
-
*/
|
|
7008
|
-
applyKnockbackToPlayer(fromPosition: Vector3Type, magnitude: number, radius?: number, falloff?: KnockbackFalloff): void;
|
|
7009
|
-
/**
|
|
7010
|
-
* Apply a continuous force to the player for a limited duration.
|
|
7011
|
-
* After `duration` seconds the force is automatically removed.
|
|
7012
|
-
* Calling again with the same source resets the timer.
|
|
7013
|
-
*
|
|
7014
|
-
* @param source - Entity key identifying this force source
|
|
7015
|
-
* @param duration - how long the force lasts, in seconds
|
|
7016
|
-
* @param vector - single `vector` whose length encodes the strength
|
|
7017
|
-
* or use overload for `direction` with a separate `magnitude` — the direction will be normalized before scaling.
|
|
7018
|
-
*/
|
|
7019
|
-
applyForceToPlayerForDuration(source: Entity, duration: number, vector: Vector3Type): void;
|
|
7020
|
-
applyForceToPlayerForDuration(source: Entity, duration: number, direction: Vector3Type, magnitude: number): void;
|
|
7021
|
-
/**
|
|
7022
|
-
* Apply a continuous repulsion force that pushes the player away from a point,
|
|
7023
|
-
* recalculating direction every tick as the player moves.
|
|
7024
|
-
* Remove with `removeForceFromPlayer(source)`.
|
|
7025
|
-
*
|
|
7026
|
-
* Negative magnitude = attraction (pulls toward the source).
|
|
7027
|
-
*
|
|
7028
|
-
* @param source - Entity key identifying this force source
|
|
7029
|
-
* @param fromPosition - world-space origin of repulsion
|
|
7030
|
-
* @param magnitude - base force strength
|
|
7031
|
-
* @param radius - max distance of effect (default: Infinity)
|
|
7032
|
-
* @param falloff - how force decreases with distance (default: CONSTANT)
|
|
7033
|
-
*/
|
|
7034
|
-
applyRepulsionForceToPlayer(source: Entity, fromPosition: Vector3Type, magnitude: number, radius?: number, falloff?: KnockbackFalloff): void;
|
|
7035
|
-
}
|
|
7036
|
-
|
|
7037
6553
|
/**
|
|
7038
6554
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
7039
6555
|
* @public
|
|
@@ -7189,30 +6705,6 @@ export declare interface PointerEventsSystem {
|
|
|
7189
6705
|
* @param entity - Entity where the callback was attached
|
|
7190
6706
|
*/
|
|
7191
6707
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
7192
|
-
/**
|
|
7193
|
-
* @public
|
|
7194
|
-
* Remove the callback for onProximityDown event
|
|
7195
|
-
* @param entity - Entity where the callback was attached
|
|
7196
|
-
*/
|
|
7197
|
-
removeOnProximityDown(entity: Entity): void;
|
|
7198
|
-
/**
|
|
7199
|
-
* @public
|
|
7200
|
-
* Remove the callback for onProximityUp event
|
|
7201
|
-
* @param entity - Entity where the callback was attached
|
|
7202
|
-
*/
|
|
7203
|
-
removeOnProximityUp(entity: Entity): void;
|
|
7204
|
-
/**
|
|
7205
|
-
* @public
|
|
7206
|
-
* Remove the callback for onProximityEnter event
|
|
7207
|
-
* @param entity - Entity where the callback was attached
|
|
7208
|
-
*/
|
|
7209
|
-
removeOnProximityEnter(entity: Entity): void;
|
|
7210
|
-
/**
|
|
7211
|
-
* @public
|
|
7212
|
-
* Remove the callback for onProximityLeave event
|
|
7213
|
-
* @param entity - Entity where the callback was attached
|
|
7214
|
-
*/
|
|
7215
|
-
removeOnProximityLeave(entity: Entity): void;
|
|
7216
6708
|
/**
|
|
7217
6709
|
* @public
|
|
7218
6710
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
@@ -7267,46 +6759,6 @@ export declare interface PointerEventsSystem {
|
|
|
7267
6759
|
entity: Entity;
|
|
7268
6760
|
opts?: Partial<EventSystemOptions>;
|
|
7269
6761
|
}, cb: EventSystemCallback): void;
|
|
7270
|
-
/**
|
|
7271
|
-
* @public
|
|
7272
|
-
* Execute callback when the user presses the proximity button on the entity
|
|
7273
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7274
|
-
* @param cb - Function to execute when click fires
|
|
7275
|
-
*/
|
|
7276
|
-
onProximityDown(pointerData: {
|
|
7277
|
-
entity: Entity;
|
|
7278
|
-
opts?: Partial<EventSystemOptions>;
|
|
7279
|
-
}, cb: EventSystemCallback): void;
|
|
7280
|
-
/**
|
|
7281
|
-
* @public
|
|
7282
|
-
* Execute callback when the user releases the proximity button on the entity
|
|
7283
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7284
|
-
* @param cb - Function to execute when event fires
|
|
7285
|
-
*/
|
|
7286
|
-
onProximityUp(pointerData: {
|
|
7287
|
-
entity: Entity;
|
|
7288
|
-
opts?: Partial<EventSystemOptions>;
|
|
7289
|
-
}, cb: EventSystemCallback): void;
|
|
7290
|
-
/**
|
|
7291
|
-
* @public
|
|
7292
|
-
* Execute callback when the entity enters the proximity zone of the user
|
|
7293
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7294
|
-
* @param cb - Function to execute when event fires
|
|
7295
|
-
*/
|
|
7296
|
-
onProximityEnter(pointerData: {
|
|
7297
|
-
entity: Entity;
|
|
7298
|
-
opts?: Partial<EventSystemOptions>;
|
|
7299
|
-
}, cb: EventSystemCallback): void;
|
|
7300
|
-
/**
|
|
7301
|
-
* @public
|
|
7302
|
-
* Execute callback when the entity leaves the proximity zone of the user
|
|
7303
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7304
|
-
* @param cb - Function to execute when event fires
|
|
7305
|
-
*/
|
|
7306
|
-
onProximityLeave(pointerData: {
|
|
7307
|
-
entity: Entity;
|
|
7308
|
-
opts?: Partial<EventSystemOptions>;
|
|
7309
|
-
}, cb: EventSystemCallback): void;
|
|
7310
6762
|
}
|
|
7311
6763
|
|
|
7312
6764
|
/**
|
|
@@ -7323,9 +6775,7 @@ export declare const enum PointerEventType {
|
|
|
7323
6775
|
PET_UP = 0,
|
|
7324
6776
|
PET_DOWN = 1,
|
|
7325
6777
|
PET_HOVER_ENTER = 2,
|
|
7326
|
-
PET_HOVER_LEAVE = 3
|
|
7327
|
-
PET_PROXIMITY_ENTER = 4,
|
|
7328
|
-
PET_PROXIMITY_LEAVE = 5
|
|
6778
|
+
PET_HOVER_LEAVE = 3
|
|
7329
6779
|
}
|
|
7330
6780
|
|
|
7331
6781
|
/**
|
|
@@ -8220,13 +7670,6 @@ export declare namespace RotateContinuous {
|
|
|
8220
7670
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): RotateContinuous;
|
|
8221
7671
|
}
|
|
8222
7672
|
|
|
8223
|
-
/**
|
|
8224
|
-
* @public
|
|
8225
|
-
* Rotate a vector by a quaternion
|
|
8226
|
-
* Uses the formula: v' = q * v * q^(-1), optimized version
|
|
8227
|
-
*/
|
|
8228
|
-
export declare function rotateVectorByQuaternion(v: Vector3Type, q: QuaternionType): Vector3Type;
|
|
8229
|
-
|
|
8230
7673
|
export declare type RPCSendableMessage = {
|
|
8231
7674
|
jsonrpc: '2.0';
|
|
8232
7675
|
id: number;
|
|
@@ -8918,18 +8361,6 @@ export declare type TransformComponent = LastWriteWinElementSetComponentDefiniti
|
|
|
8918
8361
|
export declare interface TransformComponentExtended extends TransformComponent {
|
|
8919
8362
|
create(entity: Entity, val?: TransformTypeWithOptionals): TransformType;
|
|
8920
8363
|
createOrReplace(entity: Entity, val?: TransformTypeWithOptionals): TransformType;
|
|
8921
|
-
/**
|
|
8922
|
-
* Transforms a direction vector from an entity's local coordinate space
|
|
8923
|
-
* to world space, accounting for the full parent hierarchy.
|
|
8924
|
-
*
|
|
8925
|
-
* This applies only rotation (not translation or scale) — suitable for
|
|
8926
|
-
* direction vectors like force/impulse directions.
|
|
8927
|
-
*
|
|
8928
|
-
* @param entity - The source entity whose local space defines the direction
|
|
8929
|
-
* @param localDirection - Direction vector in the entity's local coordinates
|
|
8930
|
-
* @returns The direction vector in world coordinates
|
|
8931
|
-
*/
|
|
8932
|
-
localToWorldDirection(entity: Entity, localDirection: Vector3Type): Vector3Type;
|
|
8933
8364
|
}
|
|
8934
8365
|
|
|
8935
8366
|
/**
|
|
@@ -9480,6 +8911,14 @@ export declare interface UiTransformProps {
|
|
|
9480
8911
|
*/
|
|
9481
8912
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
9482
8913
|
|
|
8914
|
+
export declare type ValidateCallback<T> = (value: {
|
|
8915
|
+
entity: Entity;
|
|
8916
|
+
currentValue: T | undefined;
|
|
8917
|
+
newValue: T | undefined;
|
|
8918
|
+
senderAddress: string;
|
|
8919
|
+
createdBy: string;
|
|
8920
|
+
}) => boolean;
|
|
8921
|
+
|
|
9483
8922
|
/**
|
|
9484
8923
|
* @public
|
|
9485
8924
|
*/
|