This repository has been archived by the owner on Oct 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 125
VRage.Game.ModAPI.Ingame.Utilities.MyIniValue
Morten Aune Lyrstad edited this page Apr 16, 2022
·
50 revisions
← Index ← Namespace Index
public struct MyIniValueRepresents the value of a single configuration item.
Namespace: VRage.Game.ModAPI.Ingame.Utilities
Assembly: VRage.Game.dll
| Member | Description |
|---|---|
| static MyIniValue EMPTY | Represents an empty MyIniValue |
| MyIniKey Key | Gets the MyIniKey this value was retrieved from |
| Member | Description |
|---|---|
| bool IsEmpty { get; } | Determines whether this value is empty. Be aware that an empty string is not considered to be an empty value. |
| Member | Description |
|---|---|
| MyIniValue(MyIniKey, string) |
| Member | Description |
|---|---|
| void GetLines(List<string>) | Retrieves each individual line of this value into the provided list. |
| bool ToBoolean(bool = default) | 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 = 0) | 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 = default) | 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 = 0) | 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 = 0) | 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 = 0) | 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 = 0) | 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 = 0) | 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 = 0) | 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 = 0) | 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() | 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) | 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 = 0) | 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 = 0) | 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 = 0) | 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) | Attempts to get this value as a System.Boolean . Fills thevalueon success. |
| bool TryGetByte(out byte) | Attempts to get this value as a System.Byte . Fills thevalueon success. |
| bool TryGetChar(out char) | Attempts to get this value as a System.Char . Fills thevalueon success. |
| bool TryGetDecimal(out decimal) | Attempts to get this value as a System.Decimal . Fills thevalueon success. |
| bool TryGetDouble(out double) | Attempts to get this value as a System.Double . Fills thevalueon success. |
| bool TryGetInt16(out short) | Attempts to get this value as a System.Int16 . Fills thevalueon success. |
| bool TryGetInt32(out int) | Attempts to get this value as a System.Int32 . Fills thevalueon success. |
| bool TryGetInt64(out long) | Attempts to get this value as a System.Int64 . Fills thevalueon success. |
| bool TryGetSByte(out sbyte) | Attempts to get this value as a System.SByte . Fills thevalueon success. |
| bool TryGetSingle(out float) | Attempts to get this value as a System.Single . Fills thevalueon success. |
| bool TryGetString(out string) | Attempts to get this value as a System.String . Fills thevalueon success. |
| bool TryGetUInt16(out ushort) | Attempts to get this value as a System.UInt16 . Fills thevalueon success. |
| bool TryGetUInt32(out uint) | Attempts to get this value as a System.UInt32 . Fills thevalueon success. |
| bool TryGetUInt64(out ulong) | Attempts to get this value as a System.UInt64 . Fills thevalueon success. |
| void Write(StringBuilder) | 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!