Documentation
    Preparing search index...

    Interface SceneSerializationSupport

    Everything a §79 round trip of an engine scene needs.

    interface SceneSerializationSupport {
        components: ComponentSerializerRegistry;
        read: Required<Pick<InstantiateSceneOptions, "nodeFactory">>;
        write: Required<Pick<SerializeSceneOptions, "nodeTypeOf" | "nodeDataOf">>;
    }

    Hierarchy (View Summary)

    Index
    components read write
    components: ComponentSerializerRegistry

    The component serializers, seeded with PoseTarget (from @fourjs/serialization), MotionComponent (§11), KinematicController (§12), and the two physics components — RigidBody (§23) and Collider (§24).

    A fresh registry per call, never a shared singleton — registries are mutable, and two applications registering their own component types must not see each other's. Register more on it before use.

    read: Required<Pick<InstantiateSceneOptions, "nodeFactory">>

    Pass to instantiateScene / instantiateSceneNodes as their options.

    write: Required<Pick<SerializeSceneOptions, "nodeTypeOf" | "nodeDataOf">>

    Pass to serializeScene as its options.

    Settings
    Member Visibility

    On This Page
    Properties