Class GameOptions

Namespace

SurvivorsMaker.Presentation

Assembly

SurvivorsMaker.Presentation.dll

The device options in effect for this process. Presentation components read them when they play a sound, shake the camera, flash or show a damage number, so a change applies on the next use. Authored settings (PresentationSettings, UiTheme) are never modified.

public static class GameOptions

Inheritance

object

GameOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Applicator

Replaces how options reach the engine (e.g. platform-specific window handling). Null restores the default.

public static IOptionsApplicator Applicator { get; set; }

Property Value

IOptionsApplicator

Current

The options in effect. Treat as read-only; change them with Set(OptionsState).

public static OptionsState Current { get; }

Property Value

OptionsState

EffectsVolume

public static float EffectsVolume { get; }

Property Value

float

MasterVolume

public static float MasterVolume { get; }

Property Value

float

MusicVolume

public static float MusicVolume { get; }

Property Value

float

ReduceFlashes

public static bool ReduceFlashes { get; }

Property Value

bool

Revision

public static int Revision { get; }

Property Value

int

ShakeScale

Multiplier for camera shake strength: 0 when shake is off.

public static float ShakeScale { get; }

Property Value

float

ShowDamageNumbers

public static bool ShowDamageNumbers { get; }

Property Value

bool

Methods

FlashScale(AccessibilitySettings)

Strength of a flash effect given the authored reduced strength used while "reduce flashes" is on.

public static float FlashScale(AccessibilitySettings settings)

Parameters

settings AccessibilitySettings

Returns

float

Sanitize(OptionsState)

Copy with out-of-range values replaced; other choices are kept.

public static OptionsState Sanitize(OptionsState options)

Parameters

options OptionsState

Returns

OptionsState

Set(OptionsState)

Stores a sanitised copy, applies it to the engine and notifies listeners.

public static void Set(OptionsState options)

Parameters

options OptionsState

Events

Changed

Raised after Set(OptionsState) applied new options.

public static event Action Changed

Event Type

Action