Table of Contents

Class PlaybookFormat

Namespace
DialogueDown.Playbook
Assembly
DialogueDown.Playbook.dll

The compatibility header a reader checks before loading a playbook: the format version that wrote it, and the capabilities it needs.

[Equatable]
public sealed record PlaybookFormat : IEquatable<PlaybookFormat>
Inheritance
PlaybookFormat
Implements
Inherited Members

Remarks

Capabilities rather than the version number carry compatibility, so a new construct gates only the playbooks that actually use it.

Constructors

PlaybookFormat(int, ImmutableArray<string>, ImmutableArray<string>)

Initializes a new instance of the PlaybookFormat class.

Properties

Requires

Gets the capabilities a runtime must understand to play this playbook correctly. An unknown entry is a hard refusal, never a skipped construct.

Uses

Gets the capabilities the document uses but a runtime may ignore and still play the story correctly.

Version

Gets the playbook format version that wrote the document.

Methods

Equals(PlaybookFormat?)

Indicates whether the current object is equal to another object of the same type.

GetHashCode()

Serves as the default hash function.