Skip to content
This repository was archived by the owner on Dec 13, 2025. It is now read-only.

VRage.Game.ModAPI.Ingame.Utilities.MyIniValue

Jump to bottom
Morten Aune Lyrstad edited this page Apr 16, 2022 · 51 revisions

← Index ← Namespace Index

MyIniValue Struct

public struct MyIniValue

Represents the value of a single configuration item.

Namespace: VRage.Game.ModAPI.Ingame.Utilities
Assembly: VRage.Game.dll

Fields

Member Description
[static MyIniValue EMPTY](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.EMPTY) Represents an empty MyIniValue
[MyIniKey Key](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.Key) Gets the MyIniKey this value was retrieved from

Properties

Member Description
[bool IsEmpty { get; }](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.IsEmpty) Determines whether this value is empty. Be aware that an empty string is not considered to be an empty value.

Constructors

Member Description
[MyIniValue(MyIniKey, string)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue..ctor)

Methods

Member Description
[void GetLines(List<string>)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.GetLines) Retrieves each individual line of this value into the provided list.
[bool ToBoolean([bool])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToBoolean) Attempts to get this value as a System.Boolean . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[byte ToByte([byte])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToByte) Attempts to get this value as a System.Byte . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[char ToChar([char])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToChar) Attempts to get this value as a System.Char . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[decimal ToDecimal([decimal])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToDecimal) Attempts to get this value as a System.Decimal . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[double ToDouble([double])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToDouble) Attempts to get this value as a System.Double . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[short ToInt16([short])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToInt16) Attempts to get this value as a System.Int16 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[int ToInt32([int])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToInt32) Attempts to get this value as a System.Int32 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[long ToInt64([long])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToInt64) Attempts to get this value as a System.Int64 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[sbyte ToSByte([sbyte])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToSByte) Attempts to get this value as a System.SByte . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[float ToSingle([float])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToSingle) Attempts to get this value as a System.Single . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[string ToString()](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToString) Attempts to get this value as a System.String . If the value is empty or cannot be understood as this data type, an empty string will be returned instead.
[string ToString(string)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToString) Attempts to get this value as a System.String . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[ushort ToUInt16([ushort])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToUInt16) Attempts to get this value as a System.UInt16 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[uint ToUInt32([uint])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToUInt32) Attempts to get this value as a System.UInt32 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[ulong ToUInt64([ulong])](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.ToUInt64) Attempts to get this value as a System.UInt64 . If the value is empty or cannot be understood as this data type, the defaultValue will be returned instead.
[bool TryGetBoolean(out bool)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetBoolean) Attempts to get this value as a System.Boolean . Fills thevalueon success.
[bool TryGetByte(out byte)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetByte) Attempts to get this value as a System.Byte . Fills thevalueon success.
[bool TryGetChar(out char)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetChar) Attempts to get this value as a System.Char . Fills thevalueon success.
[bool TryGetDecimal(out decimal)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetDecimal) Attempts to get this value as a System.Decimal . Fills thevalueon success.
[bool TryGetDouble(out double)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetDouble) Attempts to get this value as a System.Double . Fills thevalueon success.
[bool TryGetInt16(out short)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetInt16) Attempts to get this value as a System.Int16 . Fills thevalueon success.
[bool TryGetInt32(out int)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetInt32) Attempts to get this value as a System.Int32 . Fills thevalueon success.
[bool TryGetInt64(out long)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetInt64) Attempts to get this value as a System.Int64 . Fills thevalueon success.
[bool TryGetSByte(out sbyte)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetSByte) Attempts to get this value as a System.SByte . Fills thevalueon success.
[bool TryGetSingle(out float)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetSingle) Attempts to get this value as a System.Single . Fills thevalueon success.
[bool TryGetString(out string)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetString) Attempts to get this value as a System.String . Fills thevalueon success.
[bool TryGetUInt16(out ushort)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetUInt16) Attempts to get this value as a System.UInt16 . Fills thevalueon success.
[bool TryGetUInt32(out uint)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetUInt32) Attempts to get this value as a System.UInt32 . Fills thevalueon success.
[bool TryGetUInt64(out ulong)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.TryGetUInt64) Attempts to get this value as a System.UInt64 . Fills thevalueon success.
[void Write(StringBuilder)](VRage.Game.ModAPI.Ingame.Utilities.MyIniValue.Write) Writes this value as a string to the given string builder.

Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!

Clone this wiki locally