sitemap.xml llms.txt
Skip to main content

World Entities

These entities are used by the World adapter functions and encapsulate data objects used by Epicenter World API.

Constants​

OBJECTIVE​

The OBJECTIVE constant object defines the assignment goal for automatic user assignments.

Properties:

  • MINIMUM: 'MINIMUM': Assign the minimum number of users for each world persona.
  • MAXIMUM: 'MAXIMUM': Assign the maximum number of users for each persona.
  • MARGINAL: 'MARGINAL': (Deprecated) Assign the marginal number of users.
  • OPTIMAL: 'OPTIMAL': Assign the optimal number of users.
warning

The MARGINAL property is deprecated. Use OPTIMAL instead.

Types​

WorldRole​

WorldRole is an alias type for string. It describes the role of a user in a world.

OrbitType​

The OrbitType type defines the types of orbits that a world can belong to.

Type:

  • 'GROUP' - The world belongs to a group.
  • 'EPISODE' - The world belongs to an episode.

WorldNameGenerator​

The WorldNameGenerator type defines the methods available for generating world names.

Type:

AssignmentMap​

AssignmentMap is a generic mapped type. It defines a mapping of world keys to assignment creation inputs.

Type:

  • Record<string, AssignmentCreateInView<R>[]>

Interfaces​

WorldReadOutView​

The WorldReadOutView interface defines the structure for the World adapter functions to return world data.

Generics​

  • R extends WorldRole = WorldRole: The role type.

Properties​

  • lastUpdated (string): Timestamp of the last update.
  • personae (PersonaReadOutView<R>[]): The list of personas.
  • assignments (AssignmentReadOutView<R>[]): The list of assignments.
  • orbitKey (string): Identifier of the orbit.
  • worldKey (string): Unique identifier of the world.
  • created (string): Timestamp when the world was created.
  • orbitType (OrbitType): The type of orbit the world belongs to.
  • runKey (string): Identifier of the run.
  • displayName (string): Display name of the world.
  • allowChannel (boolean): Indicates whether push channels are allowed for the world.
  • name (string): Internal name of the world.
  • room (string): Room identifier associated with the world.

ColorAnimalWorldNameGenerator​

The ColorAnimalWorldNameGenerator interface defines a world name generator that uses color-animal combinations.

Properties​

  • objectType ('colorAnimal'): Identifies the generator type.

SequentialWorldNameGenerator​

The SequentialWorldNameGenerator interface defines a sequential world name generator.

Properties​

  • objectType ('sequential'): Identifies the generator type.
  • prefix? (string): (Optional) Prefix to prepend to generated names.

AssignmentReadOutView​

The AssignmentReadOutView interface describes an assignment of a user to a world persona. Used as function return value.

Generics​

  • R extends WorldRole = WorldRole: The role type.

Properties​

AssignmentCreateInView​

The AssignmentCreateInView interface describes an assignment of a user to a world persona. Used for function input parameters.

Generics​

  • R extends WorldRole = WorldRole: The role type.

Properties​

  • role? (R): (Optional) The role to assign.
  • userKey (string): The user key.

PersonaReadOutView​

The PersonaReadOutView interface is used in functions to return a world persona.

Generics​

  • R extends WorldRole = WorldRole: The role type.

Properties​

  • role (R): The role represented by the persona.
  • minimum? (number): (Optional) The minimum number of users that must be assigned to a persona within a single world.
  • maximum? (number): (Optional) The maximum number of users that can be assigned to a persona within a single world. If the value is null, the number of users that can be assigned is unlimited.
  • marginal? (number): (Optional) The ideal number of users to be assigned to a persona within a single world.
  • insertionOrder? (number): (Optional) Order in which the persona is applied.

PersonaCreateInView​

The PersonaCreateInView is used in for function parameters. It describes a world persona.

Generics​

  • R extends WorldRole = WorldRole: The role type.

Properties​

  • role (R): The role represented by the persona.
  • minimum? (number): (Optional) The minimum number of users that must be assigned to a persona within a single world.
  • maximum? (number): (Optional) The maximum number of users that can be assigned to a persona within a single world. If the value is null, the number of users that can be assigned is unlimited.
  • marginal? (number): (Optional) The ideal number of users to be assigned to a persona within a single world
  • insertionOrder? (number): (Optional) Order in which the persona is applied.