Settings¶

Class in Engine · Engine.Settings · native, abstract

Object › Settings

Subclasses: OnlineGameSearch, OnlineGameSettings

Using it from Lua

h7.find_all("Settings")            -- live instances
h7.find_class("Engine.Settings")   -- the class
h7.hook("Engine.Settings.AppendContextsToURL", fn)

Enums¶

EOnlineDataAdvertisementType

ODAT_DontAdvertise = 0, ODAT_OnlineService = 1, ODAT_QoS = 2, ODAT_OnlineServiceAndQoS = 3

EPropertyValueMappingType

PVMT_RawValue = 0, PVMT_PredefinedValues = 1, PVMT_Ranged = 2, PVMT_IdMapped = 3

ESettingsDataType

SDT_Empty = 0, SDT_Int32 = 1, SDT_Int64 = 2, SDT_Double = 3, SDT_String = 4, SDT_Float = 5, SDT_Blob = 6, SDT_DateTime = 7

Structs¶

IdToStringMapping

Field	Type
`Id`	`int`
`Name`	`name`

LocalizedStringSetting

Field	Type
`Id`	`int`
`ValueIndex`	`int`
`AdvertisementType`	`EOnlineDataAdvertisementType`

LocalizedStringSettingMetaData

Field	Type
`Id`	`int`
`Name`	`name`
`ColumnHeaderText`	`string`
`ValueMappings`	`array<StringIdToStringMapping>`

SettingsData

Field	Type
`Type`	`ESettingsDataType`
`Value1`	`int`
`Value2`	`pointer`

SettingsProperty

Field	Type
`PropertyId`	`int`
`Data`	`SettingsData`
`AdvertisementType`	`EOnlineDataAdvertisementType`

SettingsPropertyPropertyMetaData

Field	Type
`Id`	`int`
`Name`	`name`
`ColumnHeaderText`	`string`
`MappingType`	`EPropertyValueMappingType`
`ValueMappings`	`array<IdToStringMapping>`
`PredefinedValues`	`array<SettingsData>`
`MinVal`	`float`
`MaxVal`	`float`
`RangeIncrement`	`float`

StringIdToStringMapping

Field	Type
`Id`	`int`
`Name`	`name`
`bIsWildcard`	`bool`

Properties¶

Name	Type	Notes
`LocalizedSettings`	`array<LocalizedStringSetting>`
`LocalizedSettingsMappings`	`array<LocalizedStringSettingMetaData>`
`Properties`	`array<SettingsProperty>`
`PropertyMappings`	`array<SettingsPropertyPropertyMetaData>`

Functions¶

Name	Declaration
`AppendContextsToURL`	`native function AppendContextsToURL(out string URL)`
`AppendDataBindingsToURL`	`native function AppendDataBindingsToURL(out string URL)`
`AppendPropertiesToURL`	`native function AppendPropertiesToURL(out string URL)`
`BuildURL`	`native function BuildURL(out string URL)`
`EmptySettingsData`	`static native function EmptySettingsData(out SettingsData Data)`
`GetFloatProperty`	`native function bool GetFloatProperty(int PropertyId, out float Value)`
`GetIntProperty`	`native function bool GetIntProperty(int PropertyId, out int Value)`
`GetPropertyAsString`	`native function string GetPropertyAsString(int PropertyId)`
`GetPropertyAsStringByName`	`native function string GetPropertyAsStringByName(name PropertyName)`
`GetPropertyColumnHeader`	`native function string GetPropertyColumnHeader(int PropertyId)`
`GetPropertyId`	`native function bool GetPropertyId(name PropertyName, out int PropertyId)`
`GetPropertyMappingType`	`native function bool GetPropertyMappingType(int PropertyId, out EPropertyValueMappingType OutType)`
`GetPropertyName`	`native function name GetPropertyName(int PropertyId)`
`GetPropertyRange`	`native function bool GetPropertyRange(int PropertyId, out float OutMinValue, out float OutMaxValue, out float RangeIncrement, out byte bFormatAsInt)`
`GetPropertyType`	`native function ESettingsDataType GetPropertyType(int PropertyId)`
`GetPropertyValueId`	`native function bool GetPropertyValueId(int PropertyId, out int ValueId)`
`GetQoSAdvertisedProperties`	`native function GetQoSAdvertisedProperties(out array<SettingsProperty> QoSProps)`
`GetQoSAdvertisedStringSettings`	`native function GetQoSAdvertisedStringSettings(out array<LocalizedStringSetting> QoSSettings)`
`GetRangedPropertyValue`	`native function bool GetRangedPropertyValue(int PropertyId, out float OutValue)`
`GetSettingsDataBlob`	`static native function GetSettingsDataBlob(out SettingsData Data, out array OutBlob)`
`GetSettingsDataDateTime`	`static native function GetSettingsDataDateTime(out SettingsData Data, out int OutInt1, out int OutInt2)`
`GetSettingsDataFloat`	`static native function float GetSettingsDataFloat(out SettingsData Data)`
`GetSettingsDataInt`	`static native function int GetSettingsDataInt(out SettingsData Data)`
`GetStringProperty`	`native function bool GetStringProperty(int PropertyId, out string Value)`
`GetStringSettingColumnHeader`	`native function string GetStringSettingColumnHeader(int StringSettingId)`
`GetStringSettingId`	`native function bool GetStringSettingId(name StringSettingName, out int StringSettingId)`
`GetStringSettingName`	`native function name GetStringSettingName(int StringSettingId)`
`GetStringSettingValue`	`native function bool GetStringSettingValue(int StringSettingId, out int ValueIndex)`
`GetStringSettingValueByName`	`native function bool GetStringSettingValueByName(name StringSettingName, out int ValueIndex)`
`GetStringSettingValueName`	`native function name GetStringSettingValueName(int StringSettingId, int ValueIndex)`
`GetStringSettingValueNameByName`	`native function name GetStringSettingValueNameByName(name StringSettingName)`
`GetStringSettingValueNames`	`native function bool GetStringSettingValueNames(int StringSettingId, out array<IdToStringMapping> Values)`
`HasProperty`	`native function bool HasProperty(int PropertyId)`
`HasStringSetting`	`native function bool HasStringSetting(int SettingId)`
`IncrementStringSettingValue`	`native function bool IncrementStringSettingValue(int StringSettingId, int Direction, bool bShouldWrap)`
`IsWildcardStringSetting`	`native function bool IsWildcardStringSetting(int StringSettingId)`
`SetFloatProperty`	`native function SetFloatProperty(int PropertyId, float Value)`
`SetIntProperty`	`native function SetIntProperty(int PropertyId, int Value)`
`SetPropertyFromStringByName`	`native function bool SetPropertyFromStringByName(name PropertyName, const out string NewValue)`
`SetPropertyValueId`	`native function bool SetPropertyValueId(int PropertyId, int ValueId)`
`SetRangedPropertyValue`	`native function bool SetRangedPropertyValue(int PropertyId, float NewValue)`
`SetSettingsData`	`static native function SetSettingsData(out SettingsData Data, out SettingsData Data2Copy)`
`SetSettingsDataBlob`	`static native function SetSettingsDataBlob(out SettingsData Data, out array InBlob)`
`SetSettingsDataDateTime`	`static native function SetSettingsDataDateTime(out SettingsData Data, int InInt1, int InInt2)`
`SetSettingsDataFloat`	`static native function SetSettingsDataFloat(out SettingsData Data, float InFloat)`
`SetSettingsDataInt`	`static native function SetSettingsDataInt(out SettingsData Data, int InInt)`
`SetStringProperty`	`native function SetStringProperty(int PropertyId, string Value)`
`SetStringSettingValue`	`native function SetStringSettingValue(int StringSettingId, int ValueIndex, optional bool bShouldAutoAdd)`
`SetStringSettingValueByName`	`native function SetStringSettingValueByName(name StringSettingName, int ValueIndex, bool bShouldAutoAdd)`
`SetStringSettingValueFromStringByName`	`native function bool SetStringSettingValueFromStringByName(name StringSettingName, const out string NewValue)`
`UpdateFromURL`	`native function UpdateFromURL(const out string URL, GameInfo Game)`
`UpdateProperties`	`native function UpdateProperties(const out array<SettingsProperty> Props, bool bShouldAddIfMissing = true)`
`UpdateStringSettings`	`native function UpdateStringSettings(const out array<LocalizedStringSetting> Settings, bool bShouldAddIfMissing = true)`

Inherited¶

From	Members
Object	13 properties, 308 functions