RTSDK
    Preparing search index...

    Class VisitorFactory

    Factory for creating Visitor instances. Use this factory to work with visitors in Topia worlds.

    This factory should be instantiated once per application and reused across your codebase. The Visitor controller represents a specific visitor/avatar instance in a world.

    visitor, factory, create, get, avatar, user, participant

    // In your initialization file (e.g., utils/topiaInit.ts)
    import { Topia, VisitorFactory } from "@rtsdk/topia";
    const topia = new Topia({ config });
    export const Visitor = new VisitorFactory(topia);
    Index

    Constructors

    constructor

    Properties

    topia

    Methods

    create get

    Constructors

    Properties

    topia: Topia

    Methods

    • Instantiate a new instance of Visitor class for an existing visitor in a world.

      Parameters

      Returns Visitor

      Returns a new Visitor object without fetching its properties.

      This method creates a controller instance for a visitor but does not fetch its properties. Use this when you need a lightweight instance and will fetch properties separately or when you already have the properties.

      create, instantiate, visitor, initialize, avatar, instance

      // Import the pre-initialized factory from your app's initialization file
      import { Visitor } from "utils/topiaInit.ts";

      // Create a Visitor instance with credentials
      const visitorInstance = Visitor.create(
        12345, // visitor ID
        "my-world-slug",
        {
          credentials: {
            interactiveNonce,
            interactivePublicKey,
            assetId,
            urlSlug,
            visitorId
          }
        }
      );

      // Later fetch visitor properties if needed
      await visitorInstance.fetchVisitor();

    • Instantiate a new instance of Visitor class and automatically fetch all its properties.

      Parameters

      Returns Promise<Visitor>

      Returns a new Visitor object with all properties already fetched.

      This method creates a controller instance and immediately fetches all properties of the visitor. It's a convenience method that combines creating an instance and calling fetchVisitor().

      get, fetch, retrieve, visitor, load, avatar, instance

      // Import the pre-initialized factory from your app's initialization file
      import { Visitor } from "utils/topiaInit.ts";

      // Get a fully populated Visitor instance
      const visitorInstance = await Visitor.get(
        12345, // visitor ID
        "my-world-slug",
        {
          credentials: {
            interactiveNonce,
            interactivePublicKey,
            assetId,
            urlSlug,
            visitorId
          }
        }
      );

      // The properties are already loaded, so you can use them immediately
      console.log(visitorInstance.username);
      console.log(visitorInstance.position);

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods