ModNumericGameSetting

From GECK
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin.

Description

Modifies a numeric Game Setting by the given value.

Returns 1 for a successful change, and 0 on a failed one. For example, it may fail if the GameSetting could not be found.

Syntax

[help]
(success:bool) ModNumericGameSetting settingName:string valueModifier:float

Example

ModNumericGameSetting "fAbsorbBoltGrowWidth" 2

Will increment "fAbsorbBoltGrowWidth" by 2

ModNumericGameSetting "fAbsorbBoltGrowWidth" -5

Will decrease "fAbsorbBoltGrowWidth" by 5

Notes

  • The compiler will not catch typing errors for the settingName string, so take care to type accurately.

See Also