Table of Contents

Class PlaybookDocument

Namespace
DialogueDown.Playbook
Assembly
DialogueDown.Playbook.dll

One compiled script: everything a runtime needs to play it, and nothing else.

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

Remarks

Named a document rather than a playbook because a type may not share its namespace's name without shadowing it.

Constructors

PlaybookDocument(PlaybookFormat, string, int, ImmutableSortedDictionary<string, int>, ImmutableArray<PlaybookSpeaker>, ImmutableArray<Node>, string?)

Initializes a new instance of the PlaybookDocument class.

Properties

Anchors

Gets every scene's slug, by node index — the targets a jump may name, and the named conversations a game may start at instead of the top.

Entry

Gets where a playthrough begins when nothing says otherwise.

Format

Gets whether a runtime can play this at all.

Nodes

Gets the steps of a playthrough, each at its own index.

Schema

Gets where an editor can find the schema, if the writer said.

Script

Gets the script this was compiled from.

Speakers

Gets everybody who speaks here.

Methods

Equals(PlaybookDocument?)

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

GetHashCode()

Serves as the default hash function.