Function csp::multiplayer::IsCompatible

Function Documentation

bool csp::multiplayer::IsCompatible(const ComponentSchema &Original, const ComponentSchema &Updated, csp::common::LogSystem *LogSystem = nullptr)

Checks whether a schema update is compatible with an existing schema.

Note

The check is conservative. The updated schema must be a superset of the original without altering any existing property definitions. This may be relaxed in future to permit changes that are unlikely to cause compatibility issues (e.g. updating a default value or exposing a property to scripting where it wasn’t previously).

Parameters

  • Original – The existing schema to check against.

  • Updated – The candidate updated schema.

  • LogSystem – Optional logger. If provided, logs the reason when incompatible.

Returns

True if the updated schema is a compatible update of the original, false otherwise.