RamSettings

Gets and saves settings used by Ramses.

One (and only one) instance globally available (RamSettings is a singleton), by calling RamSettings.instance() or Ramses.instance().settings().

To get a setting, just get the corresponding attribute.

To change a setting temporarily, just set the corresponding attribute. If you want the change to be permanent (i.e. keep the setting for the next sessions), call the save() method.

By default, settings are saved in a ramses_addons_settings.json file, in the user’s OS specific settings folder:

Static Methods

Method Arguments Description
instance
RamSettings
Returns the RamSettings unique instance.

Attributes

To retrieve the default values after the settings have been changed, access them with the attributes which names start with default.

Attribute Type Default Description
addonsHelpUrl string The URL to this page Read-only. A link to the Ramses add-ons documentation
apiReferenceUrl string This page URL Read-only. A link to this API documentation
autoIncrementTimeout int 120 Timeout before auto incrementing a file, in minutes.
debugMode boolean false Set to true to throw errors and other debug info when developping add-ons.
defaultAutoIncrementTimeout int 120
defaultDebugMode boolean false
defaultOnline boolean true
defaultRamsesClientPath string os-specific
defaultRamsesClientPort integer 18185
defaultRamsesFolderPath string "~/Ramses"
defaultLogLevel LogLevel LogLevel.Info
generalHelpUrl string The URL to this documentation Read-only. A link to the Ramses documentation
logLevel LogLevel LogLevel.Info Changes the quantity of messages in the log. One of: LogLevel.DataReceived, LogLevel.DataSent, LogLevel.Debug, LogLevel.Info, LogLevel.Critical, LogLevel.Fatal
online boolean true Wether to always try to (re)connect to the Daemon if offline.
ramsesClientPath string os-specific Location of the Ramses Client executable file (.exe on Windows, .app on MacOS, .appimage or binary on Linux)
ramsesClientPort integer 18185 Listening port of the Ramses Daemon
ramsesFolderPath string "~/Ramses" The folder containing all Ramses files (settings, projects, etc)
userSettings dict or object {} Use this attribute to store your own settings. You can add as many key/value pairs as you need, they will be saved with the RamSettings.save() method too.
version string The current API version Read-only.

Methods

Method Arguments Description
save Saves the current settings to the disk.
folderPath
string
The folder path to the settings
filePath
string
The file path to the settings

API Dev notes

Note

This section is for the development of the API only; you should not need these when developping your add-on using the API.

Private Attributes

Attribute Type Default Description
folderNames FolderNames A simple class containing the common names for subfolders. See the constants for more information.

Examples

ramses = Ramses.instance
settings = ramses.settings
theAsset = RamAsset("thing", "stuff")
thePreviewFolder = theAsset.folderPath() + "/" + settings.folderNames.preview

META