@dcl/playground-assets 7.27.0 → 7.27.1-33247605236.commit-732120a

package/dist/beta.d.ts

@@ -279,6 +279,39 @@ export declare const enum AvatarAnchorPointType {
     AAPT_RIGHT_TOE_BASE = 25
 }
 
+/**
+ * Mirror of the scene-driven movement animation currently playing, reported by the engine.
+ * Readable by any scene (not just the controller) so niche effects (e.g. dust cloud on landing) can react.
+ * Active emotes are not represented here — scenes already have their own way to read them.
+ */
+/**
+ * @public
+ */
+export declare interface AvatarAnimationState {
+    /** same scene-relative path the controlling scene supplied */
+    src: string;
+    /** mirrors the request */
+    loop: boolean;
+    /** mirrors the request */
+    speed: number;
+    /** mirrors the request */
+    idle: boolean;
+    /** seconds into the clip; wraps on loop; frozen while an emote override is playing */
+    playbackTime: number;
+    /** total clip length in seconds */
+    duration: number;
+    /** how many times the clip has completed since it started */
+    loopCount: number;
+}
+
+/**
+ * @public
+ */
+export declare namespace AvatarAnimationState {
+    export function encode(message: AvatarAnimationState, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarAnimationState;
+}
+
 /** @public */
 export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBAvatarAttach>;
 
@@ -288,8 +321,21 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
 /** @public */
 export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
 
-/** @public */
-export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
+export declare const AvatarEquippedData: AvatarEquippedDataComponentDefinitionExtended;
+
+/**
+ * @public
+ */
+export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
+
+/**
+ * @public
+ * AvatarEquippedData with `forceRender` optional: the wire type is a repeated field (always present, so the
+ * generated type requires it), but a scene rarely needs it and shouldn't have to pass `[]`.
+ */
+export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
+    forceRender?: string[] | undefined;
+};
 
 /** @public */
 export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
@@ -319,7 +365,26 @@ export declare const enum AvatarModifierType {
 }
 
 /** @public */
-export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
+export declare const AvatarMovement: LastWriteWinElementSetComponentDefinition<PBAvatarMovement>;
+
+/** @public */
+export declare const AvatarMovementInfo: LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>;
+
+export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
+
+/**
+ * @public
+ */
+export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
+
+/**
+ * @public
+ * AvatarShape with `forceRender` optional: the wire type is a repeated field (always present, so the
+ * generated type requires it), but a scene rarely needs it and shouldn't have to pass `[]`.
+ */
+export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
+    forceRender?: string[] | undefined;
+};
 
 /**
  * @public
@@ -588,10 +653,17 @@ export declare interface ByteBuffer {
 }
 
 /**
- * Callback function to be triggered on a specified event
+ * Callback function to be triggered on a specified event. Receives the pointer event that
+ * fired it (button, hit, and for drags the pointer delta), which handlers may ignore.
  * @public
  */
-export declare type Callback = () => void;
+export declare type Callback = (event: PBPointerEventsResult) => void;
+
+/** @public */
+export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
+
+/** @public */
+export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
 
 /** @public */
 export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
@@ -1444,15 +1516,22 @@ export declare const componentDefinitionByName: {
     "core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
     "core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
     "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
+    "core::AvatarMovement": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovement>>;
+    "core::AvatarMovementInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>>;
     "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
     "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
+    "core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
+    "core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
     "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
     "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
     "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
     "core::ExplorerUiEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>>;
+    "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
     "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
     "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
+    "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
     "core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
+    "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
     "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
     "core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
     "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
@@ -1473,6 +1552,7 @@ export declare const componentDefinitionByName: {
     "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
     "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
     "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
+    "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
     "core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
     "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
     "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
@@ -1480,12 +1560,14 @@ export declare const componentDefinitionByName: {
     "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
     "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
     "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
+    "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
     "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
     "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
     "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
     "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
     "core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
     "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
+    "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
     "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
     "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
     "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -2105,6 +2187,9 @@ export declare type EntityComponents = {
     onMouseUp: Callback;
     onMouseEnter: Callback;
     onMouseLeave: Callback;
+    onMouseDrag: Callback;
+    onMouseDragLocked: Callback;
+    onMouseDragEnd: Callback;
 };
 
 /** @public */
@@ -2457,6 +2542,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
     direction?: PBVector3;
 };
 
+/** @public */
+export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
+
 export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
 
 export declare type GlobalTargetRaycastSystemOptions = {
@@ -2469,9 +2557,24 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
 /** @public */
 export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
 
+/** @public */
+export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
+
 /** @public */
 export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
 
+/** @public */
+export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
+
+/**
+ * @public
+ */
+export declare const enum GltfNodeStateValue {
+    GNSV_PENDING = 0,
+    GNSV_FAILED = 1,
+    GNSV_READY = 2
+}
+
 /**
  * @public
  */
@@ -3171,6 +3274,12 @@ export declare type Listeners = {
     onMouseEnter?: Callback;
     /** triggered on mouse leave event */
     onMouseLeave?: Callback;
+    /** triggered while the pointer is dragged after pressing on the element */
+    onMouseDrag?: Callback;
+    /** triggered while the pointer is dragged with the cursor locked in place */
+    onMouseDragLocked?: Callback;
+    /** triggered when a drag that started on the element ends */
+    onMouseDragEnd?: Callback;
 };
 
 /**
@@ -4075,6 +4184,15 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
      * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
      */
     setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
+    /**
+     * @public
+     * Set a mesh from inside a gltf in the MeshCollider component
+     * @param entity - entity to create or replace the MeshCollider component
+     * @param source - the path to the gltf
+     * @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
+     * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
+     */
+    setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
 }
 
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -4111,6 +4229,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
      * @param entity - entity to create or replace the MeshRenderer component
      */
     setSphere(entity: Entity): void;
+    /**
+     * @public
+     * Set a mesh from inside a gltf in the MeshRenderer component
+     * @param entity - entity to create or replace the MeshRenderer component
+     * @param source - the path to the gltf
+     * @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
+     */
+    setGltfMesh(entity: Entity, source: string, meshName: string): void;
 }
 
 /* Excluded from this release type: MessageBus */
@@ -4148,6 +4274,39 @@ export declare namespace MoveContinuous {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
 }
 
+/**
+ * Describes the animation the movement scene wants the avatar to play.
+ * One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
+ * When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
+ */
+/**
+ * @public
+ */
+export declare interface MovementAnimation {
+    /** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
+    src: string;
+    /** whether the clip repeats once it reaches the end */
+    loop: boolean;
+    /** playback speed multiplier (1.0 = clip's native rate) */
+    speed: number;
+    /** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
+    idle: boolean;
+    /** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
+    transitionSeconds?: number | undefined;
+    /** if set, the engine seeks to this position (in seconds) this frame. Clear on subsequent frames to allow normal playback. The scene can read `AvatarAnimationState.playback_time` first to decide. */
+    playbackTime?: number | undefined;
+    /** scene-relative paths to audio clips (.mp3/.ogg) to play this frame on the avatar audio bus. Fire-and-forget: each listed clip plays once per frame it appears; leaving a clip set for multiple frames re-triggers it. No stop mechanism. Use `AvatarAnimationState.playback_time` to trigger sounds at the right point in the clip (e.g. foot plants). */
+    sounds: string[];
+}
+
+/**
+ * @public
+ */
+export declare namespace MovementAnimation {
+    export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
+}
+
 /**
  * @public
  */
@@ -4563,6 +4722,25 @@ export declare const onVideoEvent: Observable<{
     totalVideoLength: number;
 }>;
 
+/**
+ * @public
+ */
+export declare interface Orthographic {
+    /**
+     * vertical extent of the visible range in meters
+     * defaults to 4m
+     */
+    verticalRange?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace Orthographic {
+    export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
+}
+
 /**
  * @public
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -4910,6 +5088,8 @@ export declare namespace PBAvatarEmoteCommand {
 export declare interface PBAvatarEquippedData {
     wearableUrns: string[];
     emoteUrns: string[];
+    /** slots that will render even if hidden */
+    forceRender: string[];
 }
 
 /**
@@ -4980,6 +5160,8 @@ export declare interface PBAvatarModifierArea {
     excludeIds: string[];
     /** list of modifiers to apply */
     modifiers: AvatarModifierType[];
+    /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
+    useColliderRange?: boolean | undefined;
 }
 
 /**
@@ -4990,6 +5172,64 @@ export declare namespace PBAvatarModifierArea {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
 }
 
+/**
+ * @public
+ */
+export declare interface PBAvatarMovement {
+    velocity: PBVector3 | undefined;
+    /** 0-360, yaw only; this is the authoritative facing (other clients read it, and physics treats the avatar as upright). Lean is expressed separately via tilt_pitch/tilt_roll. */
+    orientation: number;
+    groundDirection?: PBVector3 | undefined;
+    /** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
+    walkSuccess?: boolean | undefined;
+    /** if set, the engine plays this animation instead of selecting one from velocity heuristics */
+    animation?: MovementAnimation | undefined;
+    /** render-only forward/back lean in degrees, applied on top of `orientation` (rotation about the avatar's local X axis). Does not affect the physics capsule (stays upright) or the facing other clients read. Defaults to 0. */
+    tiltPitch?: number | undefined;
+    /** render-only sideways lean in degrees, applied on top of `orientation` (rotation about the avatar's local Z axis). Same constraints as tilt_pitch. Useful e.g. for glider banking. Defaults to 0. */
+    tiltRoll?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBAvatarMovement {
+    export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
+}
+
+/**
+ * @public
+ */
+export declare interface PBAvatarMovementInfo {
+    /** the length of time the current step velocity will apply for */
+    stepTime: number;
+    /** the length of time the previous step velocity applied for */
+    previousStepTime: number;
+    /** the velocity requested for the previous frame */
+    requestedVelocity: PBVector3 | undefined;
+    /** the resulting velocity taking collisions into account */
+    actualVelocity: PBVector3 | undefined;
+    /** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
+    externalVelocity: PBVector3 | undefined;
+    activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
+    activeInputModifier: PBInputModifier | undefined;
+    /** if set, the movement scene should walk the player to this scene-relative position */
+    walkTarget?: PBVector3 | undefined;
+    /** stop distance for walk_target; considered reached when within this distance */
+    walkThreshold?: number | undefined;
+    /** current state of a scene-driven movement animation. Absent when the engine is using its velocity-based fallback. `playback_time` freezes while a triggerSceneEmote is overriding the animation. */
+    activeAnimationState?: AvatarAnimationState | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBAvatarMovementInfo {
+    export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
+}
+
 /**
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
  * a simplified GLTF container for this specific case.
@@ -5038,6 +5278,8 @@ export declare interface PBAvatarShape {
     emotes: string[];
     /** hides the skin + hair + facial features (default: false) */
     showOnlyWearables?: boolean | undefined;
+    /** slots that will render even if hidden */
+    forceRender: string[];
 }
 
 /**
@@ -5079,6 +5321,51 @@ export declare namespace PBBillboard {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
 }
 
+/**
+ * @public
+ */
+export declare interface PBCameraLayer {
+    /**
+     * layer to which these settings apply. must be > 0
+     * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
+     */
+    layer: number;
+    /** should the sun light affect this layer? default false */
+    directionalLight?: boolean | undefined;
+    /** should this layer show player avatars? default false */
+    showAvatars?: boolean | undefined;
+    /** should this layer show the sky? default false */
+    showSkybox?: boolean | undefined;
+    /** should this layer show distance fog? default false */
+    showFog?: boolean | undefined;
+    /** ambient light overrides for this layer. default -> use same as main camera */
+    ambientColorOverride?: PBColor3 | undefined;
+    ambientBrightnessOverride?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBCameraLayer {
+    export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
+}
+
+/**
+ * @public
+ */
+export declare interface PBCameraLayers {
+    layers: number[];
+}
+
+/**
+ * @public
+ */
+export declare namespace PBCameraLayers {
+    export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
+}
+
 /**
  * The CameraMode component can be used to determine whether the player is using a first-person o
  * third-person view.
@@ -5120,6 +5407,8 @@ export declare interface PBCameraModeArea {
     area: PBVector3 | undefined;
     /** the camera mode to enforce */
     mode: CameraType;
+    /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
+    useColliderRange?: boolean | undefined;
 }
 
 /**
@@ -5253,6 +5542,39 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
 }
 
+/**
+ * defines the global scene light settings. must be added to the scene root.
+ * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
+ */
+/**
+ * @public
+ */
+export declare interface PBGlobalLight {
+    /**
+     * the direction the directional light shines in.
+     * default depends on time of day and explorer implementation
+     */
+    direction?: PBVector3 | undefined;
+    /**
+     * ambient light color
+     * default: White
+     */
+    ambientColor?: PBColor3 | undefined;
+    /**
+     * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
+     * default 1
+     */
+    ambientBrightness?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBGlobalLight {
+    export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
+}
+
 /**
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
  *
@@ -5288,6 +5610,25 @@ export declare namespace PBGltfContainer {
  */
 export declare interface PBGltfContainerLoadingState {
     currentState: LoadingState;
+    /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
+    nodePaths: string[];
+    /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
+    meshNames: string[];
+    /**
+     * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
+     * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
+     */
+    materialNames: string[];
+    /**
+     * X is the material index. note this may conflict with manually named materials - to avoid any issues make
+     * sure all your materials are explicitly named.
+     */
+    skinNames: string[];
+    /**
+     * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
+     * your skins are explicitly named.
+     */
+    animationNames: string[];
 }
 
 /**
@@ -5298,6 +5639,57 @@ export declare namespace PBGltfContainerLoadingState {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
 }
 
+/**
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
+ * This component must be added to a direct child of an entity with a PBGltfContainer component, or
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
+ * in the parent.
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
+ *
+ * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
+ *
+ * After creation, if an animation moves the node, the `Transform` will be updated.
+ *
+ * From the scene, you can modify various components to alter the gltf node:
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
+ *   regardless of any intermediate gltf node hierarchy.
+ *   If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
+ *   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
+ *   PBMaterial will be maintained.
+ *
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
+ *   change the state to `GNS_FAILED`.
+ * - deleting the scene entity will not delete the gltf node.
+ *
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
+ * the gltf node will also be displayed.
+ */
+/**
+ * @public
+ */
+export declare interface PBGltfNode {
+    /** the path of the target node in the Gltf. */
+    path: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBGltfNode {
+    export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
+}
+
 /**
  * GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
  *
@@ -5343,6 +5735,26 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
 }
 
+/**
+ * The state of a linked gltf node.
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
+ */
+/**
+ * @public
+ */
+export declare interface PBGltfNodeState {
+    state: GltfNodeStateValue;
+    error?: string | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBGltfNodeState {
+    export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
+}
+
 /**
  * @public
  */
@@ -5480,6 +5892,14 @@ export declare interface PBMaterial {
         $case: "pbr";
         pbr: PBMaterial_PbrMaterial;
     } | undefined;
+    /**
+     * A gltf material that may provide additional features not supported by the PbMaterial fields.
+     * If both gltf and material fields are provided, the gltf will be used only for extended features not
+     * supported by the PbMaterial.
+     * If this is provided and the `material` field is not provided, the renderer will update the material
+     * field with data that reflects the gltf material once it is loaded.
+     */
+    gltf?: PBMaterial_GltfMaterial | undefined;
 }
 
 /**
@@ -5490,6 +5910,22 @@ export declare namespace PBMaterial {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
 }
 
+/**
+ * @public
+ */
+export declare interface PBMaterial_GltfMaterial {
+    gltfSrc: string;
+    name: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBMaterial_GltfMaterial {
+    export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
+}
+
 /**
  * @public
  */
@@ -5586,6 +6022,9 @@ export declare interface PBMeshCollider {
     } | {
         $case: "plane";
         plane: PBMeshCollider_PlaneMesh;
+    } | {
+        $case: "gltf";
+        gltf: PBMeshCollider_GltfMesh;
     } | undefined;
 }
 
@@ -5631,6 +6070,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
 }
 
+/** A collider constructed from a Gltf Mesh. */
+/**
+ * @public
+ */
+export declare interface PBMeshCollider_GltfMesh {
+    /** the GLTF file path as listed in the scene's manifest. */
+    gltfSrc: string;
+    /** the name of the mesh asset */
+    name: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBMeshCollider_GltfMesh {
+    export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
+}
+
 /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
 /**
  * @public
@@ -5663,13 +6121,11 @@ export declare namespace PBMeshCollider_SphereMesh {
 
 /**
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
- * plane, a sphere or a cylinder.
+ * plane, a sphere, a cylinder, or a Gltf mesh.
  *
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
  * `float` coordinates, one for each corner of each side of each face.
- *
- * More complex shapes require the use of a `GltfContainer` component.
  */
 /**
  * @public
@@ -5687,6 +6143,9 @@ export declare interface PBMeshRenderer {
     } | {
         $case: "plane";
         plane: PBMeshRenderer_PlaneMesh;
+    } | {
+        $case: "gltf";
+        gltf: PBMeshRenderer_GltfMesh;
     } | undefined;
 }
 
@@ -5734,6 +6193,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
 }
 
+/** A mesh from a Gltf. */
+/**
+ * @public
+ */
+export declare interface PBMeshRenderer_GltfMesh {
+    /** the GLTF file path as listed in the scene's manifest. */
+    gltfSrc: string;
+    /** the name of the mesh asset */
+    name: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBMeshRenderer_GltfMesh {
+    export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
+}
+
 /** PlaneMesh renders a 2D rectangular shape. */
 /**
  * @public
@@ -6325,7 +6803,10 @@ export declare interface PBPrimaryPointerInfo {
     screenCoordinates?: PBVector2 | undefined;
     /** Movement since last frame (pixels) */
     screenDelta?: PBVector2 | undefined;
-    /** Direction vector for 3D ray casting */
+    /**
+     * ray direction that can be used with the primary camera origin for
+     * raycasting from the cursor into the world
+     */
     worldRayDirection?: PBVector3 | undefined;
 }
 
@@ -6396,6 +6877,10 @@ export declare interface PBRaycast {
     continuous?: boolean | undefined;
     /** Collision mask, by default CL_POINTER | CL_PHYSICS */
     collisionMask?: number | undefined;
+    /** shape to cast, default ray */
+    shape?: RaycastShape | undefined;
+    /** include hits with entities from other scenes */
+    includeWorld?: boolean | undefined;
 }
 
 /**
@@ -6551,6 +7036,46 @@ export declare namespace PBTextShape {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
 }
 
+/**
+ * @public
+ */
+export declare interface PBTextureCamera {
+    /** rendered texture width */
+    width?: number | undefined;
+    /** rendered texture height */
+    height?: number | undefined;
+    /**
+     * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
+     * defaults to 0
+     */
+    layer?: number | undefined;
+    /** default black */
+    clearColor?: PBColor4 | undefined;
+    /** default infinity */
+    farPlane?: number | undefined;
+    mode?: {
+        $case: "perspective";
+        perspective: Perspective;
+    } | {
+        $case: "orthographic";
+        orthographic: Orthographic;
+    } | undefined;
+    /**
+     * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
+     * range: 0 (off) - 1 (full volume)
+     * default: 0
+     */
+    volume?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBTextureCamera {
+    export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
+}
+
 /**
  * The TouchScreenControls component lets a scene configure the native on-screen touch
  * controls (the mobile joystick + gamepad). It must be set on the RootEntity.
@@ -6796,6 +7321,25 @@ export declare namespace PBUiBackground {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
 }
 
+/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
+/**
+ * @public
+ */
+export declare interface PBUiCanvas {
+    width: number;
+    height: number;
+    /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
+    color?: PBColor4 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBUiCanvas {
+    export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
+}
+
 /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
 /**
  * @public
@@ -6893,6 +7437,10 @@ export declare interface PBUiInput {
     /** default=10 */
     fontSize?: number | undefined;
     value?: string | undefined;
+    /** default=false; when true, the input accepts newlines and behaves as a textarea */
+    multiLine?: boolean | undefined;
+    /** default=true; when false, the input value is preserved after pressing Enter */
+    clearOnSubmit?: boolean | undefined;
 }
 
 /**
@@ -6956,6 +7504,21 @@ export declare namespace PBUiInputResult {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
 }
 
+/**
+ * @public
+ */
+export declare interface PBUiScrollResult {
+    value: PBVector2 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBUiScrollResult {
+    export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
+}
+
 /**
  * @public
  */
@@ -7099,6 +7662,12 @@ export declare interface PBUiTransform {
     borderRightColor?: PBColor4 | undefined;
     /** default: 1 */
     opacity?: number | undefined;
+    /** reference for scroll_position. default empty */
+    elementId?: string | undefined;
+    /** default position=(0,0) */
+    scrollPosition?: ScrollPositionValue | undefined;
+    /** default ShowScrollBar.SSB_BOTH */
+    scrollVisible?: ShowScrollBar | undefined;
     /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
     zIndex?: number | undefined;
 }
@@ -7251,6 +7820,25 @@ export declare namespace PBVisibilityComponent {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
 }
 
+/**
+ * @public
+ */
+export declare interface Perspective {
+    /**
+     * vertical field of view in radians
+     * defaults to pi/4 = 45 degrees
+     */
+    fieldOfView?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace Perspective {
+    export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
+}
+
 /**
  * @public
  * Physics helpers for applying impulses and forces to the player.
@@ -7492,6 +8080,24 @@ export declare interface PointerEventsSystem {
      * @param entity - Entity where the callback was attached
      */
     removeOnPointerHoverLeave(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerDrag event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnPointerDrag(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerDragLocked event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnPointerDragLocked(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerDragEnd event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnPointerDragEnd(entity: Entity): void;
     /**
      * @public
      * Remove the callback for onProximityDown event
@@ -7570,6 +8176,36 @@ export declare interface PointerEventsSystem {
         entity: Entity;
         opts?: Partial<EventSystemOptions>;
     }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute on every drag update
+     */
+    onPointerDrag(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute on every drag update
+     */
+    onPointerDragLocked(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callback when the user releases the button after a drag that started on the entity
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when the drag ends
+     */
+    onPointerDragEnd(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
     /**
      * @public
      * Execute callback when the user presses the proximity button on the entity
@@ -7628,7 +8264,10 @@ export declare const enum PointerEventType {
     PET_HOVER_ENTER = 2,
     PET_HOVER_LEAVE = 3,
     PET_PROXIMITY_ENTER = 4,
-    PET_PROXIMITY_LEAVE = 5
+    PET_PROXIMITY_LEAVE = 5,
+    PET_DRAG_LOCKED = 6,
+    PET_DRAG = 7,
+    PET_DRAG_END = 8
 }
 
 /**
@@ -7659,7 +8298,10 @@ export declare const enum PointerType {
     /** POT_NONE - No pointer input */
     POT_NONE = 0,
     /** POT_MOUSE - Traditional mouse input */
-    POT_MOUSE = 1
+    POT_MOUSE = 1,
+    POT_PAD = 2,
+    POT_TOUCH = 3,
+    POT_WAND = 4
 }
 
 /**
@@ -8116,6 +8758,16 @@ export declare const enum RaycastQueryType {
 /** @public */
 export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
 
+/**
+ * @public
+ */
+export declare const enum RaycastShape {
+    /** RS_RAY - cast a point, get collisions along a ray */
+    RS_RAY = 0,
+    /** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
+    RS_AVATAR = 1
+}
+
 /**
  * @public
  */
@@ -8248,6 +8900,10 @@ export declare type RaycastSystemOptions = {
     queryType: RaycastQueryType;
     continuous?: boolean | undefined;
     collisionMask?: number | undefined;
+    /** shape to sweep along the ray, default RS_RAY (a point) */
+    shape?: RaycastShape | undefined;
+    /** include colliders from other scenes, default false */
+    includeWorld?: boolean | undefined;
 };
 
 /**
@@ -8296,6 +8952,20 @@ export declare interface ReactBasedUiSystem {
      * @param entity - The entity whose UI renderer should be removed
      */
     removeUiRenderer(entity: Entity): void;
+    /**
+     * Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
+     * describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
+     * any texture renderer already set on the entity, and is torn down when the entity is removed.
+     *
+     * @param entity - The UiCanvas entity the UI tree hangs from
+     * @param ui - The UI component to render
+     */
+    setTextureRenderer(entity: Entity, ui: UiComponent): void;
+    /**
+     * Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
+     * @param entity - The UiCanvas entity the renderer was set on
+     */
+    removeTextureRenderer(entity: Entity): void;
 }
 
 /**
@@ -8886,6 +9556,33 @@ export declare namespace Schemas {
  */
 export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
 
+/**
+ * @public
+ */
+export declare interface ScrollPositionValue {
+    value?: {
+        $case: "position";
+        position: PBVector2;
+    } | {
+        $case: "reference";
+        reference: string;
+    } | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace ScrollPositionValue {
+    export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
+}
+
+/**
+ * Which scrollbars are shown when the overflow is scrollable
+ * @public
+ */
+export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
+
 /**
  * Register the composite provider used to resolve composite files. Also registers
  * any `provider.schemas` on the engine pre-seal so composites that reference those
@@ -8911,6 +9608,16 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
     easingFunction?: EasingFunction;
 }
 
+/**
+ * @public
+ */
+export declare const enum ShowScrollBar {
+    SSB_BOTH = 0,
+    SSB_ONLY_VERTICAL = 1,
+    SSB_ONLY_HORIZONTAL = 2,
+    SSB_HIDDEN = 3
+}
+
 /** @public */
 export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
 
@@ -9017,6 +9724,9 @@ export declare namespace Texture {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
 }
 
+/** @public */
+export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
+
 /**
  * @public
  */
@@ -9127,6 +9837,9 @@ export declare interface TextureUnion {
     } | {
         $case: "videoTexture";
         videoTexture: VideoTexture;
+    } | {
+        $case: "uiTexture";
+        uiTexture: UiCanvasTexture;
     } | undefined;
 }
 
@@ -9665,6 +10378,8 @@ export declare interface UiBackgroundProps {
     uvs?: number[];
     /** AvatarTexture for the background */
     avatarTexture?: UiAvatarTexture;
+    /** VideoTexture for the background: the frames of a VideoPlayer on another entity */
+    videoTexture?: UiVideoTexture;
     /** Texture for the background */
     texture?: UiTexture;
 }
@@ -9684,9 +10399,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
     disabled?: boolean;
 }
 
+/** @public */
+export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
+
 /** @public */
 export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
 
+/**
+ * @public
+ */
+export declare interface UiCanvasTexture {
+    uiCanvasEntity: number;
+    /** default = TextureWrapMode.Clamp */
+    wrapMode?: TextureWrapMode | undefined;
+    /** default = FilterMode.Bilinear */
+    filterMode?: TextureFilterMode | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace UiCanvasTexture {
+    export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
+}
+
 /**
  * @public
  */
@@ -9839,6 +10576,9 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
     uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
 };
 
+/** @public */
+export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 
@@ -9918,6 +10658,22 @@ export declare interface UiTransformProps {
     opacity?: number;
     /** default 0 */
     zIndex?: number;
+    /** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
+    elementId?: string;
+    /** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
+    scrollPosition?: PBVector2 | string;
+    /** Which scrollbars to show when overflow is 'scroll'. default 'both' */
+    scrollVisible?: ScrollVisibleType;
+}
+
+/**
+ * Video Texture
+ * @public
+ */
+export declare interface UiVideoTexture {
+    videoPlayerEntity: Entity;
+    wrapMode?: TextureWrapType;
+    filterMode?: TextureFilterType;
 }
 
 /**