UExperimentSettings¶

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

Syntax¶

class UExperimentSettings : 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¶

UObject → UExperimentSettings

Methods¶

Method	Signature	Description	Blueprint
GetExperimentType	`EExperimentType UExperimentSettings::GetExperimentType() const`	Returns the experiment type for this session.	yes
GetFileName	`const FString & UExperimentSettings::GetFileName() const`	Returns the path of the file that was most recently loaded.	yes
LoadSettings	`void UExperimentSettings::LoadSettings()`	Loads settings from the default config file and applies any command-line overrides.
LoadSettingsFromFile	`void UExperimentSettings::LoadSettingsFromFile(const FString &FilePath, bool bLogOnFailure=true)`	Loads settings from the specified INI-format file.	yes
LoadSettingsFromString	`void UExperimentSettings::LoadSettingsFromString(const FString &INIStyleString)`	Loads settings from an INI-format string in memory.
LogSettings	`void UExperimentSettings::LogSettings() const`	Logs all current setting values via LogExperiment at the Log verbosity level.
SaveSettings	`bool UExperimentSettings::SaveSettings()`	Saves the current settings back to the file they were loaded from.	yes
SaveSettingsToFile	`bool UExperimentSettings::SaveSettingsToFile(const FString &FilePath)`	Saves the current settings to the specified file path.	yes
SetExperimentType	`void UExperimentSettings::SetExperimentType(EExperimentType InExperimentType)`	Sets the experiment type for this session.	yes
SetResolution	`void UExperimentSettings::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
Cameras	`TArray< FExperimentCameraDescription >`	Frame-capture cameras to create during replay rendering.	yes
RenderAll	`int`	Autorendering flag; 0 is disabled.	yes
Resolution	`FString`	Display resolution string in Unreal format (x[w	f]).
ReticuleType	`FString`	Reticule rendering mode shown by the HUD (e.g.	yes
SecondsToDemoStop	`float`	Seconds after the last TTL before demo recording stops automatically.	yes
ShowFPS	`bool`	Whether the HUD shows the framerate counter.	yes
Subject	`FString`	Subject identifier / participant code.	yes
TTLsBeforeExperimentStart	`int`	Number of TTLs to wait for before experiment logic begins each run.	yes