LUADOC - Farming Simulator 17

Printable Version

GameSettings

Description
Class handling global settings. Global instance is g_gameSettings
Functions

getValue

Description
Returns the setting value with the given name
Settings in the game:
-maxNumMirrors
-lightsProfile
-realBeaconLights
-motorStopTimerDuration
-uiScale
-fovy
-isTrainTabbable
-radioVehicleOnly
-radioIsActive
-useColorblindMode
-useMiles
-showTriggerMarker
-resetCamera
-useWorldCamera
-invertYLook
-showHelpIcons
-showHelpMenu
-radioVolume
-vehicleVolume
-environmentVolume
-cameraSensitivity
-vehicleArmSensitivity
-ingameMapState
-ingameMapFilter
-moneyUnit
-masterVolume
-musicVolume
Definition
getValue(string name)
Arguments
stringnamename of the setting
Return Values
mixedvalueValue of the setting. The type depends on the setting

setValue

Description
Changed the setting value with the given name
Definition
setValue(string name, mixed value, boolean doSave)
Arguments
stringnamename of the setting
mixedvaluevalue to set the setting to
booleandoSaveIf true, the settings are saved persistently, otherwise it will only be safed when another call triggers it
Return Values
booleansuccessfulReturns true, if the setting was changed