Class WorldDataManager

constructor

• new WorldDataManager(): WorldDataManager

  Returns WorldDataManager

ReadonlyworldSaveVersion

deleteCharacters

• deleteCharacters(): Promise<void>

  Returns Promise<void>

deleteServerData

• deleteServerData(): Promise<void>

  Returns Promise<void>

deleteWorld

• deleteWorld(): Promise<void>

  Returns Promise<void>

fetchCharacterData

• fetchCharacterData(characterId: string): Promise<FullCharacterSaveData>

  Parameters

  • characterId: string

  Returns Promise<FullCharacterSaveData>

fetchWorldData

• fetchWorldData(): Promise<FetchedWorldData>

  Returns Promise<FetchedWorldData>

getServerData

• getServerData(serverId: number): Promise<ServerSaveData | null>

  Parameters

  • serverId: number

  Returns Promise<ServerSaveData | null>

initialize

• initialize(worldId: number, mongoAddress: string): Promise<void>

  Parameters

  • worldId: number
  • mongoAddress: string

  Returns Promise<void>

insertWorld

• insertWorld(lastItemGuid: bigint): Promise<void>

  Parameters

  • lastItemGuid: bigint

  Returns Promise<void>

loadConstructionData

• loadConstructionData(): Promise<ConstructionParentSaveData[] | undefined>

  Returns Promise<ConstructionParentSaveData[] | undefined>

loadCropData

• loadCropData(): Promise<PlantingDiameterSaveData[] | undefined>

  Returns Promise<PlantingDiameterSaveData[] | undefined>

loadTrapData

• loadTrapData(): Promise<TrapSaveData[] | undefined>

  Returns Promise<TrapSaveData[] | undefined>

loadVehiclesData

• loadVehiclesData(): Promise<FullVehicleSaveData[] | undefined>

  Returns Promise<FullVehicleSaveData[] | undefined>

loadWorldFreeplaceConstruction

• loadWorldFreeplaceConstruction(): Promise<
      LootableConstructionSaveData[]
      | undefined,
  >

  Returns Promise<LootableConstructionSaveData[] | undefined>

saveCharacterData

• saveCharacterData(
      characterSaveData: CharacterUpdateSaveData,
      lastItemGuid?: bigint,
  ): Promise<void>

  Parameters

  • characterSaveData: CharacterUpdateSaveData
  • OptionallastItemGuid: bigint

  Returns Promise<void>

saveCharacters

• saveCharacters(characters: CharacterUpdateSaveData[]): Promise<void>

  Parameters

  • characters: CharacterUpdateSaveData[]

  Returns Promise<void>

saveConstructionData

• saveConstructionData(
      constructions: ConstructionParentSaveData[],
      retainIds?: string[],
  ): Promise<void>

  Parameters

  • constructions: ConstructionParentSaveData[]
  • retainIds: string[] = []

  Returns Promise<void>

saveCropData

• saveCropData(crops: PlantingDiameterSaveData[]): Promise<void>

  Parameters

  • crops: PlantingDiameterSaveData[]

  Returns Promise<void>

saveTrapData

• saveTrapData(traps: TrapSaveData[]): Promise<void>

  Parameters

  • traps: TrapSaveData[]

  Returns Promise<void>

saveVehicles

• saveVehicles(vehicles: FullVehicleSaveData[]): Promise<void>

  Parameters

  • vehicles: FullVehicleSaveData[]

  Returns Promise<void>

saveWorld

• saveWorld(world: WorldArg): Promise<void>

  Parameters

  • world: WorldArg

  Returns Promise<void>

saveWorldFreeplaceConstruction

• saveWorldFreeplaceConstruction(
      freeplaces: LootableConstructionSaveData[],
      retainIds?: string[],
  ): Promise<void>

  Parameters

  • freeplaces: LootableConstructionSaveData[]
  • retainIds: string[] = []

  Returns Promise<void>

StaticconvertCharactersToSaveData

• convertCharactersToSaveData(
      characters: Character2016[],
      worldId: number,
  ): CharacterUpdateSaveData[]

  Parameters

  • characters: Character2016[]
  • worldId: number

  Returns CharacterUpdateSaveData[]

StaticconvertToCharacterSaveData

• convertToCharacterSaveData(
      character: Character2016,
      worldId: number,
  ): CharacterUpdateSaveData

  Parameters

  • character: Character2016
  • worldId: number

  Returns CharacterUpdateSaveData

StaticconvertToVehicleSaveData

• convertToVehicleSaveData(
      vehicle: Vehicle2016,
      worldId: number,
  ): FullVehicleSaveData

  Parameters

  • vehicle: Vehicle2016
  • worldId: number

  Returns FullVehicleSaveData

StaticconvertVehiclesToSaveData

• convertVehiclesToSaveData(
      characters: Vehicle2016[],
      worldId: number,
  ): FullVehicleSaveData[]

  Parameters

  • characters: Vehicle2016[]
  • worldId: number

  Returns FullVehicleSaveData[]

StaticgetBaseConstructionSaveData

• getBaseConstructionSaveData(
      entity: ConstructionEntity,
      serverId: number,
  ): BaseConstructionSaveData

  Parameters

  • entity: ConstructionEntity
  • serverId: number

  Returns BaseConstructionSaveData

StaticgetBaseEntityUpdateSaveData

• getBaseEntityUpdateSaveData(entity: BaseEntity): BaseEntityUpdateSaveData

  Parameters

  • entity: BaseEntity

  Returns BaseEntityUpdateSaveData

StaticgetBaseFullCharacterUpdateSaveData

• getBaseFullCharacterUpdateSaveData(
      entity: BaseFullCharacter,
      worldSaveVersion: number,
  ): BaseFullCharacterUpdateSaveData

  Parameters

  • entity: BaseFullCharacter
  • worldSaveVersion: number

  Returns BaseFullCharacterUpdateSaveData

StaticgetBaseFullEntitySaveData

• getBaseFullEntitySaveData(
      entity: BaseEntity,
      serverId: number,
  ): BaseFullEntitySaveData

  Parameters

  • entity: BaseEntity
  • serverId: number

  Returns BaseFullEntitySaveData

StaticgetBaseSaveData

• getBaseSaveData(serverId: number): BaseSaveData

  Parameters

  • serverId: number

  Returns BaseSaveData

StaticgetConstructionChildSaveData

• getConstructionChildSaveData(
      entity: ConstructionChildEntity,
      serverId: number,
  ): ConstructionChildSaveData

  Parameters

  • entity: ConstructionChildEntity
  • serverId: number

  Returns ConstructionChildSaveData

StaticgetConstructionDoorSaveData

• getConstructionDoorSaveData(
      entity: ConstructionDoor,
      serverId: number,
  ): ConstructionDoorSaveData

  Parameters

  • entity: ConstructionDoor
  • serverId: number

  Returns ConstructionDoorSaveData

StaticgetConstructionParentSaveData

• getConstructionParentSaveData(
      entity: ConstructionParentEntity,
      serverId: number,
  ): ConstructionParentSaveData

  Parameters

  • entity: ConstructionParentEntity
  • serverId: number

  Returns ConstructionParentSaveData

StaticgetDatabase

• getDatabase(mongoAddress: string): Promise<[Db, MongoClient]>

  MANAGED BY CONFIGMANAGER - See defaultConfig.yaml for more information

  Parameters

  • mongoAddress: string

  Returns Promise<[Db, MongoClient]>

StaticgetItemSaveData

• getItemSaveData(item: BaseItem): ItemSaveData

  Parameters

  • item: BaseItem

  Returns ItemSaveData

StaticgetLoadoutContainerSaveData

• getLoadoutContainerSaveData(
      container: LoadoutContainer,
  ): LoadoutContainerSaveData

  Parameters

  • container: LoadoutContainer

  Returns LoadoutContainerSaveData

StaticgetLoadoutItemSaveData

• getLoadoutItemSaveData(item: LoadoutItem): LoadoutItemSaveData

  Parameters

  • item: LoadoutItem

  Returns LoadoutItemSaveData

StaticgetLootableConstructionSaveData

• getLootableConstructionSaveData(
      entity: LootableConstructionEntity,
      serverId: number,
  ): LootableConstructionSaveData

  Parameters

  • entity: LootableConstructionEntity
  • serverId: number

  Returns LootableConstructionSaveData

StaticgetPlantingDiameterSaveData

• getPlantingDiameterSaveData(
      entity: PlantingDiameter,
      serverId: number,
  ): PlantingDiameterSaveData

  Parameters

  • entity: PlantingDiameter
  • serverId: number

  Returns PlantingDiameterSaveData

StaticgetPlantSaveData

• getPlantSaveData(entity: Plant, serverId: number): PlantSaveData

  Parameters

  • entity: Plant
  • serverId: number

  Returns PlantSaveData

StaticgetPositionUpdateSaveData

• getPositionUpdateSaveData(entity: Vehicle2016): positionUpdate

  Parameters

  • entity: Vehicle2016

  Returns positionUpdate

StaticgetTrapSaveData

• getTrapSaveData(
      entity: ExplosiveEntity | TrapEntity,
      serverId: number,
  ): TrapSaveData

  Parameters

  • entity: ExplosiveEntity | TrapEntity
  • serverId: number

  Returns TrapSaveData

StaticgetWeaponSaveData

• getWeaponSaveData(weapon: Weapon): WeaponSaveData

  Parameters

  • weapon: Weapon

  Returns WeaponSaveData

StaticloadConstructionChildEntity

• loadConstructionChildEntity(
      server: ZoneServer2016,
      entityData: ConstructionChildSaveData,
  ): ConstructionChildEntity

  Parameters

  • server: ZoneServer2016
  • entityData: ConstructionChildSaveData

  Returns ConstructionChildEntity

StaticloadConstructionChildSlots

• loadConstructionChildSlots(
      server: ZoneServer2016,
      parent: ConstructionChildEntity,
      entityData: ConstructionChildSaveData,
  ): void

  Parameters

  • server: ZoneServer2016
  • parent: ConstructionChildEntity
  • entityData: ConstructionChildSaveData

  Returns void

StaticloadConstructionDoorEntity

• loadConstructionDoorEntity(
      server: ZoneServer2016,
      entityData: ConstructionDoorSaveData,
  ): ConstructionDoor

  Parameters

  • server: ZoneServer2016
  • entityData: ConstructionDoorSaveData

  Returns ConstructionDoor

StaticloadConstructionParentEntities

• loadConstructionParentEntities(
      constructionParents: ConstructionParentSaveData[],
      server: ZoneServer2016,
  ): void

  Parameters

  • constructionParents: ConstructionParentSaveData[]
  • server: ZoneServer2016

  Returns void

StaticloadConstructionParentEntity

• loadConstructionParentEntity(
      server: ZoneServer2016,
      entityData: ConstructionParentSaveData,
  ): ConstructionParentEntity

  Parameters

  • server: ZoneServer2016
  • entityData: ConstructionParentSaveData

  Returns ConstructionParentEntity

StaticloadLootableConstructionEntity

• loadLootableConstructionEntity(
      server: ZoneServer2016,
      entityData: LootableConstructionSaveData,
      isWorldConstruction?: boolean,
  ): LootableConstructionEntity

  Parameters

  • server: ZoneServer2016
  • entityData: LootableConstructionSaveData
  • isWorldConstruction: boolean = false

  Returns LootableConstructionEntity

StaticloadPlant

• loadPlant(
      server: ZoneServer2016,
      parent: PlantingDiameter,
      entityData: PlantSaveData,
  ): Plant

  Parameters

  • server: ZoneServer2016
  • parent: PlantingDiameter
  • entityData: PlantSaveData

  Returns Plant

StaticloadPlantingDiameter

• loadPlantingDiameter(
      server: ZoneServer2016,
      entityData: PlantingDiameterSaveData,
  ): void

  Parameters

  • server: ZoneServer2016
  • entityData: PlantingDiameterSaveData

  Returns void

StaticloadTraps

• loadTraps(server: ZoneServer2016, entityData: TrapSaveData): void

  Parameters

  • server: ZoneServer2016
  • entityData: TrapSaveData

  Returns void

StaticloadVehicles

• loadVehicles(server: ZoneServer2016, entityData: FullVehicleSaveData): void

  Parameters

  • server: ZoneServer2016
  • entityData: FullVehicleSaveData

  Returns void

StaticrehomeChildrenToFoundation

• rehomeChildrenToFoundation(
      server: ZoneServer2016,
      foundation: ConstructionParentEntity,
      entity: ConstructionParentEntity,
      seen?: Set<string>,
  ): void

  #1467 (H4): move a construction entity's direct children onto the given foundation's freeplaceEntities so they stay reachable from the save graph, then drop the now-childless shell from the world dictionary. Used at load time when a child-parent (e.g. an expansion) cannot be placed into a slot, so its shelters/gates/loot are preserved instead of orphaned. Nested subtrees follow automatically (a re-homed shelter is serialized with its own children). A child-parent that itself nests expansions (only reachable from corrupt/garbled slot data) is drained recursively so those subtrees are re-homed too; seen guards against a cyclic shell graph.

  Parameters

  • server: ZoneServer2016
  • foundation: ConstructionParentEntity
  • entity: ConstructionParentEntity
  • seen: Set<string> = ...

  Returns void