Vixen
02b45cc4
csharp
public record class YamlSerializerOptions

How the object mapper should behave.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

An unknown key is ignored rather than an error, and that is not laziness. A project opened in an older editor after someone added an import setting must still load: refusing would make every schema addition a flag day across a team. Dropping it silently is the other failure, so exists and the asset database uses it to warn — the caller decides whether an unknown key is news.

is off by default. A .meta file that listed only what differs from the defaults would change shape whenever a default changed, which is a diff on files nobody touched. Sparseness in doc 08 is a property of the per-target overrides block, which is a different mechanism.

Fields and properties (4)

  • public YamlNamingPolicy Naming

    What a key is called.

  • public bool OmitDefaults

    Whether a member whose value equals a freshly constructed instance's is left out.

  • public Action<string>? OnUnknownKey

    Called with the dotted path of every key that matched no member, or to say nothing.

  • public static YamlSerializerOptions Default

    camelCase keys, every member written, unknown keys ignored quietly.

Methods (2)

  • public YamlSerializerOptions(YamlNamingPolicy Naming = CamelCase, bool OmitDefaults = false, Action<string>? OnUnknownKey = null)

    How the object mapper should behave.

  • public string KeyFor(string memberName)

    What a member is called in a document.

Used by (5)

  • AssetMetaFileVixen.Core.Yaml
  • SerializerTestsVixen.Core.Yaml.Tests
  • YamlSerializerVixen.Core.Yaml
  • ImportSettingsDocumentVixen.Editor.AssetEditors
  • ProjectSettingsStoreVixen.Editor.Core