Class SyncTestOptions<TInput>

Namespace

Backdash.Options

Assembly

Backdash.dll

Configurations for INetcodeSession<TInput> in SyncTest mode.

public sealed record SyncTestOptions<TInput> : IEquatable<SyncTestOptions<TInput>> where TInput : unmanaged

Type Parameters

TInput

Inheritance

object

SyncTestOptions<TInput>

Implements

IEquatable<SyncTestOptions<TInput>>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

SyncTestOptions()

public SyncTestOptions()

Properties

CheckDistanceFrames

Total forced rollback frames.

public int CheckDistanceFrames { get; set; }

Property Value

int

Defaults to 1

DesyncHandler

Sets desync handler for SyncTest sessions. Useful for showing smart state diff.

public IStateDesyncHandler? DesyncHandler { get; set; }

Property Value

IStateDesyncHandler

InputProvider

Input generator service for session.

public IInputProvider<TInput>? InputProvider { get; set; }

Property Value

IInputProvider<TInput>

LogStateOnDesync

If true, log state string on desync

public bool LogStateOnDesync { get; set; }

Property Value

bool

StateStringParser

Sets desync handler for SyncTest sessions. Useful for showing smart state diff.

public IStateStringParser? StateStringParser { get; set; }

Property Value

IStateStringParser

ThrowOnDesync

If true, throws on state de-synchronization.

public bool ThrowOnDesync { get; set; }

Property Value

bool

Methods

CheckDistance(int)

Total forced rollback frames.

public SyncTestOptions<TInput> CheckDistance(int frames)

Parameters

frames int

Returns

SyncTestOptions<TInput>

Defaults to 1

Equals(SyncTestOptions<TInput>?)

public bool Equals(SyncTestOptions<TInput>? other)

Parameters

other SyncTestOptions<TInput>

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

LogState(bool)

If true, log state string on desync

public SyncTestOptions<TInput> LogState(bool enabled = true)

Parameters

enabled bool

Returns

SyncTestOptions<TInput>

ThrowError(bool)

If true, throws on state de-synchronization.

public SyncTestOptions<TInput> ThrowError(bool enabled = true)

Parameters

enabled bool

Returns

SyncTestOptions<TInput>

ToString()

public override string ToString()

Returns

string

UseDesyncHandler<T>()

Sets desync handler for SyncTest sessions. Useful for showing smart state diff.

public SyncTestOptions<TInput> UseDesyncHandler<T>() where T : IStateDesyncHandler, new()

Returns

SyncTestOptions<TInput>

Type Parameters

T

UseInputProvider<T>()

Input generator service for session.

public SyncTestOptions<TInput> UseInputProvider<T>() where T : IInputProvider<TInput>, new()

Returns

SyncTestOptions<TInput>

Type Parameters

T

UseJsonStateParser(JsonSerializerOptions?)

Use JsonStateStringParser as state viewer.

public SyncTestOptions<TInput> UseJsonStateParser(JsonSerializerOptions? options = null)

Parameters

options JsonSerializerOptions

Returns

SyncTestOptions<TInput>

UseRandomInputProvider()

Use RandomInputProvider<TInput> as input provider.

public SyncTestOptions<TInput> UseRandomInputProvider()

Returns

SyncTestOptions<TInput>

See Also

InputProvider

UseStateStringParser<T>()

Sets desync handler for SyncTest sessions. Useful for showing smart state diff.

public SyncTestOptions<TInput> UseStateStringParser<T>() where T : IStateStringParser, new()

Returns

SyncTestOptions<TInput>

Type Parameters

T

Operators

operator ==(SyncTestOptions<TInput>?, SyncTestOptions<TInput>?)

public static bool operator ==(SyncTestOptions<TInput>? left, SyncTestOptions<TInput>? right)

Parameters

left SyncTestOptions<TInput>

right SyncTestOptions<TInput>

Returns

bool

operator !=(SyncTestOptions<TInput>?, SyncTestOptions<TInput>?)

public static bool operator !=(SyncTestOptions<TInput>? left, SyncTestOptions<TInput>? right)

Parameters

left SyncTestOptions<TInput>

right SyncTestOptions<TInput>

Returns

bool