Yureka LogoDocs

API Reference

Quick-reference for all OSSIM subsystem APIs, key structs, and enums.

Enums

EnumValues
EOSSessionStateBooting, SetupNeeded, Locked, LoggedIn, Idle
EWindowStateNormal, Minimized, Maximized
EProcessStateRunning, Suspended
EVFSNodeTypeFile, Directory
EOSSIMNotificationSeverityInfo, Success, Warning, Error
EFileExplorerModeStandard, OpenFile, SaveFile, Picker
EFileExplorerViewModeIconGrid, List, Details
EFileExplorerSortModeName, Size, Type, ModifiedDate
EOSSIMAudioPlaybackStateStopped, Playing, Paused
ECodeSyntaxLanguageAuto, Cpp, JavaScript, TypeScript, Python

Key Structs

FWindowSpawnParams

Title="Window", InitialPosition=(100,100), InitialSize=(800,600), bResizable=true, bMinimizable=true, bMaximizable=true, AppClass, IconPath, IconTexture.

FProcessRecord

PID=0, ProcessName, WindowId, State=Running, FakeMemoryKB=0, StartTime, AppInstance (TWeakObjectPtr).

FVFSNode

Name, Type=Directory, Created, Modified, Content, Size=0, Permissions="rw", Owner="user", Children. Supports ShallowCopy(), DeepCopy().

FUserProfile

Username, Password, bIsInitialized, DisplayName, AvatarPath, WallpaperPath, AccentColor=(0.2,0.5,1,1), InstalledApps: TArray<FString>.

FContextMenuItem

Label(FText), Icon, OnSelected(delegate), bIsEnabled=true, bIsSeparator=false. Static: Separator().

FOSSIMNotificationData

Id(FGuid), Title, Message, Source, Severity=Info, Icon, DurationSeconds=4.0, bSticky=false, CreatedAt.

FOSSIMMusicTrack

TrackName, VFSPath, AssetPath, DurationSeconds.

FMailMessage

MessageId(FGuid), FromName, FromAddress, To[], Cc[], Subject, Body, Timestamp, Folder="Inbox", bIsRead, bIsStarred, bIsDraft, Attachments[].

Save Game (UOSSIMSaveGame)

UOSSIMSaveGame : USaveGame          Save slot: "OSSIM_UserProfile"
  ├── TMap<FString, FUserProfile>   UserRegistry     ← all accounts
  ├── TMap<FString, FVFSFileData>   UserFileSystems  ← per-user VFS blob
  └── FString                       LastLoggedInUser
FVFSFileData { TArray<uint8> RawData }

Utility Libraries

UOSSIMFileUtilities

  • GetFileTypeName(FileName, NodeType) — Extension to human-readable name (~60 extensions).
  • GetFileIconPath(FileName, NodeType) — Extension to icon asset path.
  • FormatBytes(int64) — Formats bytes as B/KB/MB/GB.
  • ResolveVFSAssetReference(RawContent) — Unwraps Type'/Path' object-path strings.

UOSSIMNotificationLibrary

  • GetNotificationSubsystem(WorldContext) — Quick subsystem access.
  • NotifyInfo/NotifySuccess/NotifyWarning/NotifyError — Static notification helpers.

File Associations (Default)

ExtensionsApp
txt, log, ini, cfgNotepad
json, py, md, bat, cpp, h, hpp, c, cs, js, ts, html, css, xml, shCode Editor
png, jpg, jpeg, mp4Media Viewer