mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-14 07:24:52 +09:00
bbassieandClaude Opus 5.5
b0e07ea73b
The controller merged uploads using the uploading instance's current config. An upload serialized under different settings, for example one sent from the save right after an admin turned on sync_inventories and restarted the instance, was then merged as if it held a character and wiped the stored one. Uploads now carry the components they were serialized with, the controller merges by those and drops the key before storing. The scenario keeps the components a player's synced session started with and serializes their upload with them, so changing the options while a player is online takes effect the next time they join. A player whose session lacks a component that is now synced downloads again even if the generation matches. Downloads snapshot the components when they start, so a change during a download can't mix two sets. A failed acquire unsyncs the player again regardless of the inventories setting, as before this branch. The god and dead player inventories move from the inventories component to the controller one, matching what the scenario syncs, which removes the special case in mergePlayerData. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
102 lines
3.4 KiB
TypeScript
102 lines
3.4 KiB
TypeScript
import type * as lib from "@clusterio/lib";
|
|
import type { IpcPlayerData } from "./messages.js";
|
|
|
|
/** Parts of the player data an instance can choose to sync, and the fields of the player data holding them. */
|
|
export const components = {
|
|
// inventories holds the god inventory and the hidden ghost inventory, both belong to the controller
|
|
controller: ["controller", "ticks_to_respawn", "cheat_mode", "inventories"],
|
|
force: ["force"],
|
|
appearance: ["color", "chat_color", "tag"],
|
|
inventories: ["character", "crafting_queue"],
|
|
logistics: ["personal_logistic_slots"],
|
|
quick_bar: ["quick_bar", "hotbar"],
|
|
settings: ["flashlight", "shortcuts", "game_view_settings"],
|
|
recipe_notifications: ["recipe_notifications"],
|
|
} as const;
|
|
|
|
export type Component = keyof typeof components;
|
|
|
|
// Fields only a player with a character has
|
|
const characterFields = ["character", "crafting_queue", "personal_logistic_slots"] as const;
|
|
|
|
/**
|
|
* Build the set of synced components.
|
|
*
|
|
* The controller is only synced together with the inventories, as
|
|
* switching controller can destroy the character holding them.
|
|
*/
|
|
function componentSet(isEnabled: (component: Component) => boolean) {
|
|
const enabled = new Set<Component>();
|
|
for (const component of Object.keys(components) as Component[]) {
|
|
if (isEnabled(component)) {
|
|
enabled.add(component);
|
|
}
|
|
}
|
|
if (!enabled.has("inventories")) {
|
|
enabled.delete("controller");
|
|
}
|
|
return enabled;
|
|
}
|
|
|
|
/** Components synced on an instance. */
|
|
export function enabledComponents(config: lib.InstanceConfig) {
|
|
return componentSet(component => Boolean(config.get(`player_sync.sync_${component}`)));
|
|
}
|
|
|
|
/**
|
|
* Components an upload was serialized with, all of them when not given.
|
|
*
|
|
* Lua may encode an empty table as an array, which reads as no components.
|
|
*/
|
|
export function uploadedComponents(uploaded: Record<string, boolean> | unknown[] | undefined) {
|
|
if (uploaded === undefined) {
|
|
return componentSet(() => true);
|
|
}
|
|
return componentSet(component => !Array.isArray(uploaded) && uploaded[component] === true);
|
|
}
|
|
|
|
/** Remove the fields of components which are not synced. */
|
|
export function stripPlayerData(playerData: IpcPlayerData, enabled: Set<Component>) {
|
|
const fields = playerData as Record<string, unknown>;
|
|
for (const [component, keys] of Object.entries(components)) {
|
|
if (!enabled.has(component as Component)) {
|
|
for (const key of keys) {
|
|
delete fields[key];
|
|
}
|
|
}
|
|
}
|
|
return playerData;
|
|
}
|
|
|
|
/**
|
|
* Combine data uploaded by an instance with the stored data.
|
|
*
|
|
* Components the upload was not serialized with keep the stored fields.
|
|
* Without the controller synced character fields are only taken from a
|
|
* player which has a character.
|
|
*/
|
|
export function mergePlayerData(stored: IpcPlayerData | undefined, uploaded: IpcPlayerData) {
|
|
const { components: uploadComponents, ...merged } = uploaded as IpcPlayerData & Record<string, unknown>;
|
|
const enabled = uploadedComponents(uploadComponents);
|
|
function keep(keys: readonly string[]) {
|
|
for (const key of keys) {
|
|
const value = (stored as Record<string, unknown> | undefined)?.[key];
|
|
if (value !== undefined) {
|
|
merged[key] = value;
|
|
} else {
|
|
delete merged[key];
|
|
}
|
|
}
|
|
}
|
|
|
|
for (const [component, keys] of Object.entries(components)) {
|
|
if (!enabled.has(component as Component)) {
|
|
keep(keys);
|
|
}
|
|
}
|
|
if (!enabled.has("controller") && !uploaded.character) {
|
|
keep(characterFields);
|
|
}
|
|
return merged as IpcPlayerData;
|
|
}
|