Skip to content

UMRISettings

Per-session configuration loaded from an INI-style settings file.

Syntax

class UMRISettings : public UObject

Remarks

Settings are loaded at startup from the default game config file and can be overridden via command-line arguments or by calling LoadSettingsFromFile. Exposes all configurable parameters to Blueprints for runtime inspection. UCLASS

Inheritance Hierarchy

UObjectUMRISettings

Methods

Method Signature Description Blueprint
GetExperimentType EExperimentType UMRISettings::GetExperimentType() const Returns the experiment type for this session. yes
GetFileName const FString & UMRISettings::GetFileName() const Returns the path of the file that was most recently loaded. yes
LoadSettings void UMRISettings::LoadSettings() Loads settings from the default config file and applies any command-line overrides.
LoadSettingsFromFile void UMRISettings::LoadSettingsFromFile(const FString &FilePath, bool bLogOnFailure=true) Loads settings from the specified INI-format file. yes
LoadSettingsFromString void UMRISettings::LoadSettingsFromString(const FString &INIStyleString) Loads settings from an INI-format string in memory.
LogSettings void UMRISettings::LogSettings() const Logs all current setting values via LogMRI at the Log verbosity level.
SaveSettings bool UMRISettings::SaveSettings() Saves the current settings back to the file they were loaded from. yes
SaveSettingsToFile bool UMRISettings::SaveSettingsToFile(const FString &FilePath) Saves the current settings to the specified file path. yes
SetExperimentType void UMRISettings::SetExperimentType(EExperimentType InExperimentType) Sets the experiment type for this session. yes
SetResolution void UMRISettings::SetResolution(int Width, int Height, bool Fullscreen=false) Try to set the current display resolution. yes

Properties

Property Type Description Blueprint
AutoEyetrackingCalibration bool If true, eyetracking calibration is triggered automatically at the start of each run. yes
AutoTriggerDemoRecording bool If true, demo recording begins automatically on the first TTL. yes
RenderAll int Autorendering flag; 0 is disabled. yes
Resolution FString Display resolution string in Unreal format (x[w f]).
SecondsToDemoStop float Seconds after the last TTL before demo recording stops automatically. yes
SensorsOnlyOnReplay bool If true, rendering is only enabled during replay, not during the experiment. yes
Subject FString Subject identifier / participant code. yes
TTLsBeforeExperimentStart int Number of TTLs to wait for before experiment logic begins each run. yes
bSemanticSegmentationEnabled bool DO we do semseg on this current lifecycle?. yes