Interface IMyConfig

This interface provides access to game settings

Namespace: VRage.Game.ModAPI

Assembly: VRage.Game.dll

Syntax

public interface IMyConfig

Properties

AmbientOcclusionEnabled

Gets if ambient occlusion is enabled

Declaration

Nullable<bool> AmbientOcclusionEnabled { get; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AnisotropicFiltering

Gets anisotropic filtering

Declaration

Nullable<MyTextureAnisoFiltering> AnisotropicFiltering { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyTextureAnisoFiltering>

AntialiasingMode

Gets anti aliasing mode

Declaration

Nullable<MyAntialiasingMode> AntialiasingMode { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyAntialiasingMode>

CaptureMouse

Gets whether mouse should be captured by game screenshot

Declaration

bool CaptureMouse { get; }

Property Value

Type	Description
System.Boolean

ControlsButtons

Declaration

DictionaryReader<string, object> ControlsButtons { get; }

Property Value

Type	Description
DictionaryReader<System.String, System.Object>

ControlsGeneral

Declaration

DictionaryReader<string, object> ControlsGeneral { get; }

Property Value

Type	Description
DictionaryReader<System.String, System.Object>

ControlsHints

Gets whether games should show controls hints

Declaration

bool ControlsHints { get; }

Property Value

Type	Description
System.Boolean

CubeBuilderBuildingMode

SingleBlock - 0 Line - 1 Plane - 2

Declaration

int CubeBuilderBuildingMode { get; }

Property Value

Type	Description
System.Int32

CubeBuilderUseSymmetry

Gets whether cube builder should use symmetry

Declaration

bool CubeBuilderUseSymmetry { get; }

Property Value

Type	Description
System.Boolean

EnableDamageEffects

Gets whether damage effects are enabled

Declaration

bool EnableDamageEffects { get; }

Property Value

Type	Description
System.Boolean

EnableDynamicMusic

Gets dynamic music is enabled

Declaration

bool EnableDynamicMusic { get; }

Property Value

Type	Description
System.Boolean

EnableMuteWhenNotInFocus

Gets whether should mute sound when game window is not in focus

Declaration

bool EnableMuteWhenNotInFocus { get; }

Property Value

Type	Description
System.Boolean

EnablePerformanceWarnings

Gets whether should show performance warning

Declaration

bool EnablePerformanceWarnings { get; }

Property Value

Type	Description
System.Boolean

EnableReverb

Gets whether reverb sound feature is enabled

Declaration

bool EnableReverb { get; }

Property Value

Type	Description
System.Boolean

EnableTrading

Gets grass draw distance

Declaration

bool EnableTrading { get; }

Property Value

Type	Description
System.Boolean

EnableVoiceChat

Gets whether voice chat is enabled

Declaration

bool EnableVoiceChat { get; }

Property Value

Type	Description
System.Boolean

FieldOfView

Gets game field of view setting

Declaration

float FieldOfView { get; }

Property Value

Type	Description
System.Single

FirstTimeRun

Gets if game is run at first time

Declaration

bool FirstTimeRun { get; }

Property Value

Type	Description
System.Boolean

FlaresIntensity

Gets flares intensity graphics feature

Declaration

float FlaresIntensity { get; }

Property Value

Type	Description
System.Single

GameVolume

Gets game master volume

Declaration

float GameVolume { get; }

Property Value

Type	Description
System.Single

GraphicsRenderer

Gets graphics renderer setting

Declaration

MyGraphicsRenderer GraphicsRenderer { get; }

Property Value

Type	Description
VRageRender.MyGraphicsRenderer

GrassDensityFactor

Gets grass density factor

Declaration

Nullable<float> GrassDensityFactor { get; }

Property Value

Type	Description
System.Nullable<System.Single>

GrassDrawDistance

Gets grass draw distance

Declaration

Nullable<float> GrassDrawDistance { get; }

Property Value

Type	Description
System.Nullable<System.Single>

HUDBkOpacity

Gets HUD Background Opacity

Declaration

float HUDBkOpacity { get; }

Property Value

Type	Description
System.Single

HudState

Gets hud state: 0 - hidden 1 - visible with descriptions 2 - visible without descriptions

Declaration

int HudState { get; }

Property Value

Type	Description
System.Int32

HudWarnings

Gets whether game should show warnings

Declaration

bool HudWarnings { get; }

Property Value

Type	Description
System.Boolean

Language

Gets game current language

Declaration

MyLanguagesEnum Language { get; }

Property Value

Type	Description
VRage.MyLanguagesEnum

LightsQuality

Gets game lights quality

Declaration

Nullable<MyRenderQualityEnum> LightsQuality { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyRenderQualityEnum>

MemoryLimits

Always true

Declaration

bool MemoryLimits { get; }

Property Value

Type	Description
System.Boolean

MinimalHud

Gets if hud currently hidden

Declaration

bool MinimalHud { get; }

Property Value

Type	Description
System.Boolean

ModelQuality

Gets model render quality

Declaration

Nullable<MyRenderQualityEnum> ModelQuality { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyRenderQualityEnum>

MusicVolume

Gets music volume

Declaration

float MusicVolume { get; }

Property Value

Type	Description
System.Single

MutedPlayers

Gets set of muted players

Declaration

HashSetReader<ulong> MutedPlayers { get; }

Property Value

Type	Description
HashSetReader<System.UInt64>

RefreshRate

Gets game refresh rate multiplied by 1000

Declaration

int RefreshRate { get; }

Property Value

Type	Description
System.Int32

RotationHints

Gets if gabe should show rotation hints

Declaration

bool RotationHints { get; }

Property Value

Type	Description
System.Boolean

ScreenHeight

Gets screen height

Declaration

Nullable<int> ScreenHeight { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

ScreenshotSizeMultiplier

Gets screenshot size multiplier

Declaration

float ScreenshotSizeMultiplier { get; }

Property Value

Type	Description
System.Single

ScreenWidth

Gets grass draw distance

Declaration

Nullable<int> ScreenWidth { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

ShaderQuality

Gets shader quality setting

Declaration

Nullable<MyRenderQualityEnum> ShaderQuality { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyRenderQualityEnum>

ShadowQuality

Gets shadow quality setting

Declaration

Nullable<MyShadowsQuality> ShadowQuality { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyShadowsQuality>

ShipSoundsAreBasedOnSpeed

Gets if ship sound are base on ship speed

Declaration

bool ShipSoundsAreBasedOnSpeed { get; }

Property Value

Type	Description
System.Boolean

ShowCrosshair

Gets whether game shows crosshair

Declaration

bool ShowCrosshair { get; }

Property Value

Type	Description
System.Boolean

ShowCrosshair2

Gets game crosshair settings VisibleWithHud = 0, AlwaysVisible = 1, AlwaysHidden = 2

Declaration

int ShowCrosshair2 { get; }

Property Value

Type	Description
System.Int32

Skin

Not used.

Declaration

string Skin { get; }

Property Value

Type	Description
System.String

TextureQuality

Gets game texture quality

Declaration

Nullable<MyTextureQuality> TextureQuality { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyTextureQuality>

UIBkOpacity

Gets game UI background opacity

Declaration

float UIBkOpacity { get; }

Property Value

Type	Description
System.Single

UIOpacity

Gets game UI opacity

Declaration

float UIOpacity { get; }

Property Value

Type	Description
System.Single

VegetationDrawDistance

Gets tree draw distance

Declaration

Nullable<float> VegetationDrawDistance { get; }

Property Value

Type	Description
System.Nullable<System.Single>

VerticalSync

Gets game vertical sync

Declaration

int VerticalSync { get; }

Property Value

Type	Description
System.Int32

VideoAdapter

Gets current used video adapter index. ESC->Display->VideoAdapter

Declaration

int VideoAdapter { get; }

Property Value

Type	Description
System.Int32

VoiceChatVolume

Gets game voice chat volume

Declaration

float VoiceChatVolume { get; }

Property Value

Type	Description
System.Single

VoxelQuality

Gets voxel rendering quality

Declaration

Nullable<MyRenderQualityEnum> VoxelQuality { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyRenderQualityEnum>

VoxelTextureQuality

Gets game voxel texture quality

Declaration

Nullable<MyTextureQuality> VoxelTextureQuality { get; }

Property Value

Type	Description
System.Nullable<VRageRender.MyTextureQuality>

WindowMode

Gets game window mode

Declaration

MyWindowModeEnum WindowMode { get; }

Property Value

Type	Description
VRage.MyWindowModeEnum