Search Results for

    Show / Hide Table of Contents

    Class Options

    The game's options, which are displayed in the TinyLife.Uis.OptionsMenu.Initialize(MLEM.Ui.UiSystem,System.Boolean) menu and saved to disk

    Inheritance
    System.Object
    MLEM.Data.Json.JsonTypeSafeGenericDataHolder
    Options
    Implements
    MLEM.Misc.IGenericDataHolder
    Inherited Members
    MLEM.Data.Json.JsonTypeSafeGenericDataHolder.SetData(System.String, System.Object)
    MLEM.Data.Json.JsonTypeSafeGenericDataHolder.GetData<T>(System.String)
    MLEM.Data.Json.JsonTypeSafeGenericDataHolder.GetDataKeys()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: TinyLife
    Assembly: Tiny Life.dll
    Syntax
    [DataContract]
    public class Options : JsonTypeSafeGenericDataHolder, IGenericDataHolder

    Fields

    AutoSaveIntervalSeconds

    The auto-save interval in seconds. Note that this value should be set to 30, 60, 180, 300 or 600, as otherwise, the options menu will display it incorrectly.

    Declaration
    [DataMember]
    public int AutoSaveIntervalSeconds
    Field Value
    Type Description
    System.Int32

    BrightnessIncrease

    A percentage that the game's world's brightness is increased by, mainly intended for users with darker screens

    Declaration
    [DataMember]
    public float BrightnessIncrease
    Field Value
    Type Description
    System.Single

    CameraDownKeybind

    Declaration
    [DataMember]
    public readonly Keybind CameraDownKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    CameraLeftKeybind

    Declaration
    [DataMember]
    public readonly Keybind CameraLeftKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    CameraRightKeybind

    Declaration
    [DataMember]
    public readonly Keybind CameraRightKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    CameraRotation

    The game's camera rotation. To use this value effectively, you can use ToVisualY(Vector2), ApplyCameraRotation(Vector2, Boolean, Nullable<Direction2>) and ApplyInverseCameraRotation(Vector2, Nullable<Direction2>). When changing this value, OnCameraRotationChanged(Direction2, Direction2) should be called for the game's Map.

    Declaration
    [DataMember]
    public Direction2 CameraRotation
    Field Value
    Type Description
    MLEM.Misc.Direction2

    CameraUpKeybind

    Declaration
    [DataMember]
    public readonly Keybind CameraUpKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    CopyFurnitureKeybind

    Declaration
    [DataMember]
    public readonly Keybind CopyFurnitureKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    DecreaseSpeedKeybind

    Declaration
    [DataMember]
    public readonly Keybind DecreaseSpeedKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    DisplayedHints

    The InGameHint objects that have already been displayed

    Declaration
    [DataMember]
    public readonly HashSet<InGameHint> DisplayedHints
    Field Value
    Type Description
    System.Collections.Generic.HashSet<InGameHint>

    Fullscreen

    Whether the game is currently in fullscreen mode

    Declaration
    [DataMember]
    public bool Fullscreen
    Field Value
    Type Description
    System.Boolean

    GameSpeeds

    An array of all defined GameSpeed values

    Declaration
    public static readonly GameSpeed[] GameSpeeds
    Field Value
    Type Description
    GameSpeed[]

    GridKeybind

    Declaration
    [DataMember]
    public readonly Keybind GridKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    HideHangingObjects

    Whether hanging objects should be hidden in the world if walls are down. This property is automatically evaluated in Draw(GameTime, SpriteBatch, Vector2, Nullable<Color>).

    Declaration
    [DataMember]
    public bool HideHangingObjects
    Field Value
    Type Description
    System.Boolean

    IncreaseSpeedKeybind

    Declaration
    [DataMember]
    public readonly Keybind IncreaseSpeedKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    InteractKeybind

    Declaration
    [DataMember]
    public readonly Keybind InteractKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    Keybinds

    An array that contains all of the fields of type MLEM.Input.Keybind in the Options class

    Declaration
    public static readonly FieldInfo[] Keybinds
    Field Value
    Type Description
    System.Reflection.FieldInfo[]

    KeyboardLighting

    Whether keyboard lighting should be enabled. This setting defaults to false, but can be enabled regardless of whether keyboard lighting is supported by the user's devices.

    Declaration
    [DataMember]
    public bool KeyboardLighting
    Field Value
    Type Description
    System.Boolean

    Language

    The currently selected language's language code. Determines the language used by Localization.

    Declaration
    [DataMember]
    public string Language
    Field Value
    Type Description
    System.String

    MoveCameraKeybind

    Declaration
    [DataMember]
    public readonly Keybind MoveCameraKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    PauseGameKeybind

    Declaration
    [DataMember]
    public readonly Keybind PauseGameKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    RotateCameraKeybind

    Declaration
    [DataMember]
    public readonly Keybind RotateCameraKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    RotateKeybind

    Declaration
    [DataMember]
    public readonly Keybind RotateKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    RoundCameraPosition

    Whether the Camera's position should be rounded. In Apply(), this value is passed to MLEM.Cameras.Camera.RoundPosition.

    Declaration
    [DataMember]
    public bool RoundCameraPosition
    Field Value
    Type Description
    System.Boolean

    ScreenshotKeybind

    Declaration
    [DataMember]
    public readonly Keybind ScreenshotKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    SellHeldObjectKeybind

    Declaration
    [DataMember]
    public readonly Keybind SellHeldObjectKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    ShowBuildModeGrid

    Whether a grid should be displayed in build mode.

    Declaration
    [DataMember]
    public bool ShowBuildModeGrid
    Field Value
    Type Description
    System.Boolean

    SoundscapeVolume

    The volume of ambiant sounds created by Soundscape. Note that the soundscape volume is still multiplied with the master sound volume SoundVolume.

    Declaration
    [DataMember]
    public float SoundscapeVolume
    Field Value
    Type Description
    System.Single

    SoundVolume

    The current sound volume as a percentage, ranging from 0 to 1

    Declaration
    [DataMember]
    public float SoundVolume
    Field Value
    Type Description
    System.Single

    SpeechVolume

    The volume of speech sounds, used by Speak(SpeakStyle, Single, Single). Note that the speech sound volume is still multiplied with the sound master volume SoundVolume.

    Declaration
    [DataMember]
    public float SpeechVolume
    Field Value
    Type Description
    System.Single

    StingVolume

    The volume of sting sound effects. Note that the sting volume is still multiplied with the sound master volume SoundVolume.

    Declaration
    [DataMember]
    public float StingVolume
    Field Value
    Type Description
    System.Single

    StoreInHouseholdKeybind

    Declaration
    [DataMember]
    public readonly Keybind StoreInHouseholdKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    SwitchPersonKeybind

    Declaration
    [DataMember]
    public readonly Keybind SwitchPersonKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    UiAnimations

    Whether ui animations should be enabled. This value is automatically used by CoveringGroup.

    Declaration
    [DataMember]
    public bool UiAnimations
    Field Value
    Type Description
    System.Boolean

    UiScale

    A modifier that is applied to the game's MLEM.Ui.UiSystem's MLEM.Ui.UiSystem.GlobalScale

    Declaration
    [DataMember]
    public float UiScale
    Field Value
    Type Description
    System.Single

    VSync

    Whether vertical synchronization is currently turned on

    Declaration
    [DataMember]
    public bool VSync
    Field Value
    Type Description
    System.Boolean

    WallDisplays

    An array of all defined WallDisplay values

    Declaration
    public static readonly WallDisplay[] WallDisplays
    Field Value
    Type Description
    WallDisplay[]

    WorldSoundVolume

    The volume of in-world sounds, used by PlaySound(SoundEffect, Vector2, Single, Single, Boolean, Boolean) and its overloads. Note that the world sound volume is still multiplied with the sound master volume SoundVolume.

    Declaration
    [DataMember]
    public float WorldSoundVolume
    Field Value
    Type Description
    System.Single

    ZoomInKeybind

    Declaration
    [DataMember]
    public readonly Keybind ZoomInKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    ZoomOutKeybind

    Declaration
    [DataMember]
    public readonly Keybind ZoomOutKeybind
    Field Value
    Type Description
    MLEM.Input.Keybind

    Properties

    Instance

    The static singleton instance of Options

    Declaration
    public static Options Instance { get; }
    Property Value
    Type Description
    Options

    WallMode

    The currently selected WallMode. Note that this value does not always return the wall mode that has been selected by the user: If Mode is SelectHousehold, Roofs is returned. If the CurrentTool overrides ForceWallsUp(), that value is returned.

    Declaration
    public WallDisplay WallMode { get; set; }
    Property Value
    Type Description
    WallDisplay

    Methods

    Apply()

    Applies the currently selected options of this instance to the game

    Declaration
    public void Apply()

    Save()

    Saves the options to the default options file path

    Declaration
    public void Save()

    Implements

    MLEM.Misc.IGenericDataHolder

    Extension Methods

    Extensions.JsonCopy<T>(T)
    ☀
    ☾
    In This Article
    Back to top
    © 2021-2022 Ellpeck – Impressum – Privacy – Status
    ☀
    ☾