GetGameSettings

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns a StringMap of GameSettings, where the keys are the GameSetting names and the values are the settings' values. The type of gamesetting to include is filtered by gmstType.

gmstType is a Bitmask with the following flags:

1 = Float/Int-value settings (starts with "i"/"f")
2 = String-value settings (starts with "s")

It is set to 3 if not specified (all gamesettings included).

Syntax

[help]
(settings:array) GetGameSettings gmstType:int{0-3}

Example

array_var aSettings
let aSettings := GetGameSettings (0b10)  ;get only string-value settings

The above example makes use of Binary Notation to clarify that only the second bit is being set.