Skip to content
ConsoleMonster
Class

ReplayOptionsFluent

ConsoleMonster.Replay

Namespace
ConsoleMonster.Replay
Assembly
ConsoleMonster
Modifiers
static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of ReplayOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • ReplayOptionsFluent

Methods

AutoPlay 2 overloads
public static ReplayOptions AutoPlay(ReplayOptions replayOptions, bool value) #

Sets ReplayOptions.AutoPlay: Starts playing at once (default true); false opens paused at the start.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value bool required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { AutoPlay = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().AutoPlay(value);
public static ReplayOptions AutoPlay(ReplayOptions replayOptions) #

Sets ReplayOptions.AutoPlay to true.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance to configure.

Returns

ReplayOptions The same instance.
public static ReplayOptions FramesPerSecond(ReplayOptions replayOptions, double value) #

Sets ReplayOptions.FramesPerSecond: How often the recording is sampled, in frames per second (default 10; identical frames are merged).

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value double required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { FramesPerSecond = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().FramesPerSecond(value);
public static ReplayOptions Height(ReplayOptions replayOptions, int? value) #

Sets ReplayOptions.Height: The height of the recorded screen in rows, or null: the window (full screen) or the dashboard's own height (inline).

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value int? required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { Height = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().Height(value);
Inline 2 overloads
public static ReplayOptions Inline(ReplayOptions replayOptions, bool value) #

Sets ReplayOptions.Inline: Plays inline, below the cursor, instead of on the whole window.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value bool required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { Inline = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().Inline(value);
public static ReplayOptions Inline(ReplayOptions replayOptions) #

Sets ReplayOptions.Inline to true.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance to configure.

Returns

ReplayOptions The same instance.
Interactive 2 overloads
public static ReplayOptions Interactive(ReplayOptions replayOptions, InteractiveOptions? value) #

Sets ReplayOptions.Interactive: Input, target, language and other interactive settings, or null for the defaults.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value ConsoleMonster.Interactive.InteractiveOptions? required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { Interactive = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().Interactive(value);
public static ReplayOptions Interactive(ReplayOptions replayOptions, Action<InteractiveOptions> configure) #

Configures ReplayOptions.Interactive in place (creating it when not set): Input, target, language and other interactive settings, or null for the defaults.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
configure System.Action<ConsoleMonster.Interactive.InteractiveOptions> required
Configures the value.

Returns

ReplayOptions The same instance.
public static ReplayOptions MaxFrames(ReplayOptions replayOptions, int value) #

Sets ReplayOptions.MaxFrames: The most frames kept; a longer recording is sampled less often (default 3000).

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value int required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { MaxFrames = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().MaxFrames(value);
public static ReplayOptions PlaybackMode(ReplayOptions replayOptions, PlaybackMode value) #

Sets ReplayOptions.PlaybackMode: The playback job; interactive controls by default.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value ConsoleMonster.Replay.PlaybackMode required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { PlaybackMode = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().PlaybackMode(value);
Session 2 overloads
public static ReplayOptions Session(ReplayOptions replayOptions, LiveSessionOptions? value) #

Sets ReplayOptions.Session: Session configuration for automatic playback, including a deterministic delay or host output.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value ConsoleMonster.Live.LiveSessionOptions? required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { Session = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().Session(value);
public static ReplayOptions Session(ReplayOptions replayOptions, Action<LiveSessionOptions> configure) #

Configures ReplayOptions.Session in place (creating it when not set): Session configuration for automatic playback, including a deterministic delay or host output.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required
Configures the value.

Returns

ReplayOptions The same instance.
public static ReplayOptions Speed(ReplayOptions replayOptions, double value) #

Sets ReplayOptions.Speed: The starting speed (0.25 to 16, default 1).

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value double required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { Speed = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().Speed(value);
public static ReplayOptions Title(ReplayOptions replayOptions, string? value) #

Sets ReplayOptions.Title: The run name shown in the header (default the recorded dashboard title, or "Replay"). A recorded Dashboard's own header and footer are not replayed: its title (when it adds to this name), subtitle and status show in the player's header.

Parameters

replayOptions ConsoleMonster.Replay.ReplayOptions required
The instance.
value string? required
The value.

Returns

ReplayOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Replay.ReplayOptions { Title = value };    Ui.Options<global::ConsoleMonster.Replay.ReplayOptions>().Title(value);