StageDirection

namespace Griff.Modules.VisualNovels;

public sealed class StageDirection

One direction to a Stage, as a dialogue line’s tag says it: “[show Ava left happy]” is Show, Who “Ava”, Position “Left” and Expression “Happy”; “[background Park fade]” is Background “Park” with a fade. Words it doesn’t know are kept in Unknown, so the game and the editor can say so.

Properties

Background

public string? Background { get; init; }

Expression

public string? Expression { get; init; }

IsEveryone

public bool IsEveryone { get; }

True for “[hide all]”: everyone leaves.

Kind

public DirectionKind Kind { get; init; }

Position

public string? Position { get; init; }

Transition

public StageTransition? Transition { get; init; }

Unknown

public IReadOnlyList<string> Unknown { get; init; }

Words that are none of the stage’s characters, positions, expressions, backgrounds or transitions.

Who

public string? Who { get; init; }

Word

public string Word { get; }

The word a tag starts with for it: “show”, “hide”, “move” or “background”.

Methods

Deconstruct

public void Deconstruct(out DirectionKind Kind, out string? Who, out string? Position, out string? Expression, out string? Background, out StageTransition? Transition)

Describe

public string Describe()

What it does, in a few words: “Show Ava at Left, Happy (fade)”.

Equals

public override bool Equals(object? obj)

Equals

public bool Equals(StageDirection? other)

GetHashCode

public override int GetHashCode()

ToString

public override string ToString()

ToTag

public string ToTag()

The tag as it’s written on a line, e.g. “[show Ava left happy fade]”.