mirror of
https://github.com/SteamDeckHomebrew/decky-frontend-lib.git
synced 2026-05-18 09:00:13 +02:00
feat(globals): Steam client reference (#92)
* change: Add SteamClient types Steam Version: 1690583737 Steam Client Build Date: Sat, Jul 29 02:44 UTC -08:00 * new: Document some SteamClient interfaces Using the SDH discord server, GitHub and some personal findings, I tried to document as much SteamClient functions as I can. * new: Document some SteamClient interfaces - part 2 * new: Document some SteamClient interfaces - part 3 * new: Document some SteamClient interfaces - part 4 * new: Document some SteamClient interfaces - part 5 * new: Document some SteamClient interfaces - part 6 * new: Document some SteamClient interfaces - part 7 * change: Update interfaces to Steam Version 1691097434 Steam Version: 1691097434 Steam Client Build Date: Fri, Aug 4 04:54 UTC -08:00 * new: Document some SteamClient interfaces - part 8 * new: Document some SteamClient interfaces - part 9 * change: Update interfaces to Steam Version 1694466342 Steam Version: 1694466342 Steam Client Build Date: Tue, Sep 12 04:59 UTC +08:00 * new: Document some SteamClient interfaces - part 10 * new: Document some SteamClient interfaces - part 11 * new: Document some SteamClient interfaces - part 12 * new: Document some SteamClient interfaces - part 13 * new: Document some SteamClient interfaces - part 14 * change: Update interfaces to Steam Version 1698260427 Steam Version: 1698260427 Steam Client Build Date: Thu, Oct 26 2:40 AM UTC -08:00 * new: Document some SteamClient interfaces - part 10 * change: Update interfaces to Steam Version 1700160213 Steam Version: 1700160213 Steam Client Build Date: Fri, Nov 17 2:23 AM UTC +08:00 * docs(SteamClient): document some interfaces * change: Fix formatting style * docs(SteamClient): document protobufs & System.Report * docs(SteamClient): document CMsgMonitorInfo * docs(SteamClient): document remaining messages * docs(SteamClient): update interfaces to Steam Version 1702515219 Steam Version: 1702515219 Steam Client Build Date: Thu, Dec 14 00:36 UTC -08:00 * docs(SteamClient): update interfaces to Steam Version 1704329464 Steam Version: 1704329464 Steam Client Build Date: Thu, Jan 4 12:23 AM UTC -08:00 * docs(SteamClient): update interfaces to Steam Version 1705630720 Steam Version: 1705630720 Steam Client Build Date: Fri, Jan 19 1:58 AM UTC -08:00 * docs(SteamClient): update interfaces to Steam Version 1706914901 Steam Version: 1706914901 Steam Client Build Date: Fri, Feb 2 8:46 PM UTC -08:00 * docs(SteamClient): update interfaces to Steam Version 1709920887 Steam Version: 1709920887 Steam Client Build Date: Thu, Mar 7 5:29 PM UTC -08:00 * docs(SteamClient): update interfaces to Steam Version 1710786209 Steam Version: 1710786209 Steam Client Build Date: Mon, Mar 18 7:07 PM UTC -08:00 * docs(SteamClient): document even more interfaces * new: Document some SteamClient interfaces - part 15 * Fix QAM button bit number * new: Document some SteamClient interfaces - part 16 * change: Update interfaces to Steam Version 1714854927 Steam Version: 1714854927 Steam Client Build Date: Sat, May 4 7:11 AM UTC -08:00 * change: Refactor and reorganize SteamClient * docs(SteamClient): document more notification interfaces * docs(SteamClient): document more interfaces * docs(SteamClient): add some descriptions * docs(SteamClient): remove duplicate types * change: Fix rebase errors * Updated ControllerStateChange * Fix typo * docs(SteamClient): update interfaces to Steam Version 1723601482 Steam Version: 1723601482 Steam Client Build Date: Wed, Aug 14 01:51 UTC -08:00 * docs(SteamClient): update interfaces to 1725654351 * docs(SteamClient): update interfaces to 1730416762 * docs(SteamClient): forgot some stuff * docs(SteamClient): add missed interfaces * docs(SteamClient): update enums * docs(SteamClient): add some things and move stuff around * docs(SteamClient): move shared enums/interfaces to a separate file * docs(SteamClient): add more stuff * docs(SteamClient): reword some things * docs(SteamClient): new BrowserView things * docs(SteamClient): review fixes * move to src/globals --------- Co-authored-by: ricewind012 <58827198+ricewind012@users.noreply.github.com> Co-authored-by: Party Wumpus <48649272+PartyWumpus@users.noreply.github.com> Co-authored-by: Xander <xander@isxander.dev>
This commit is contained in:
Yao Chung Hu
@@ -1,321 +1,5 @@
|
||||
import {SteamClient} from "./steam-client";
|
||||
|
||||
declare global {
|
||||
var SteamClient: SteamClient;
|
||||
}
|
||||
|
||||
export interface Apps {
|
||||
RegisterForAppOverviewChanges: any;
|
||||
RegisterForAppDetails: any;
|
||||
RegisterForLocalizationChanges: any;
|
||||
RegisterForWorkshopChanges: any;
|
||||
RegisterForWorkshopItemDownloads: any;
|
||||
GetLibraryBootstrapData: any;
|
||||
RegisterForAchievementChanges: any;
|
||||
GetFriendAchievementsForApp: any;
|
||||
GetMyAchievementsForApp: any;
|
||||
AddUserTagToApps: any;
|
||||
RemoveUserTagFromApps: any;
|
||||
ClearUserTagsOnApps: any;
|
||||
ClearAndSetUserTagsOnApp: any;
|
||||
SetAppHidden: any;
|
||||
ResetHiddenState: any;
|
||||
SetAppLaunchOptions: any;
|
||||
SetAppResolutionOverride: any;
|
||||
SetAppCurrentLanguage: any;
|
||||
SetAppAutoUpdateBehavior: any;
|
||||
SetAppBackgroundDownloadsBehavior: any;
|
||||
ToggleAppFamilyBlockedState: any;
|
||||
ToggleAppSteamCloudEnabled: any;
|
||||
ToggleAppSteamCloudSyncOnSuspendEnabled: any;
|
||||
ToggleOverrideResolutionForInternalDisplay: any;
|
||||
ToggleEnableSteamOverlayForApp: any;
|
||||
ToggleEnableDesktopTheatreForApp: any;
|
||||
BrowseLocalFilesForApp: any;
|
||||
BrowseScreenshotsForApp: any;
|
||||
BrowseScreenshotForApp: any;
|
||||
BackupFilesForApp: any;
|
||||
VerifyFilesForApp: any;
|
||||
CreateDesktopShortcutForApp: any;
|
||||
JoinAppContentBeta: any;
|
||||
JoinAppContentBetaByPassword: any;
|
||||
GetAchievementsInTimeRange: any;
|
||||
GetSubscribedWorkshopItems: any;
|
||||
SubscribeWorkshopItem: any;
|
||||
GetDownloadedWorkshopItems: any;
|
||||
DownloadWorkshopItem: any;
|
||||
SetLocalScreenshotCaption: any;
|
||||
SetLocalScreenshotSpoiler: any;
|
||||
GetDetailsForScreenshotUpload: any;
|
||||
UploadLocalScreenshot: any;
|
||||
DeleteLocalScreenshot: any;
|
||||
GetScreenshotsInTimeRange: any;
|
||||
GetFriendsWhoPlay: any;
|
||||
RequestLegacyCDKeysForApp: any;
|
||||
GetSoundtrackDetails: any;
|
||||
GetStoreTagLocalization: any;
|
||||
GetLaunchOptionsForApp: any;
|
||||
GetResolutionOverrideForApp: any;
|
||||
ScanForShortcuts: any;
|
||||
GetAllShortcuts: any;
|
||||
GetShortcutData: any;
|
||||
AddShortcut: any;
|
||||
RemoveShortcut: any;
|
||||
InstallFlatpakAppAndCreateShortcut: any;
|
||||
ListFlatpakApps: any;
|
||||
UninstallFlatpakApp: any;
|
||||
ShowControllerConfigurator: any;
|
||||
SetThirdPartyControllerConfiguration: any;
|
||||
ToggleAllowDesktopConfiguration: any;
|
||||
SetControllerRumblePreference: any;
|
||||
GetCachedAppDetails: any;
|
||||
SetCachedAppDetails: any;
|
||||
ReportLibraryAssetCacheMiss: any;
|
||||
SaveAchievementProgressCache: any;
|
||||
SetStreamingClientForApp: any;
|
||||
SetCustomArtworkForApp: any;
|
||||
ClearCustomArtworkForApp: any;
|
||||
SetCustomLogoPositionForApp: any;
|
||||
ClearCustomLogoPositionForApp: any;
|
||||
RequestIconDataForApp: any;
|
||||
SpecifyCompatTool: any;
|
||||
GetAvailableCompatTools: any;
|
||||
SetShortcutName: any;
|
||||
SetShortcutExe: any;
|
||||
SetShortcutStartDir: any;
|
||||
SetShortcutLaunchOptions: any;
|
||||
SetShortcutIsVR: any;
|
||||
PromptToChangeShortcut: any;
|
||||
PromptToSelectShortcutIcon: any;
|
||||
InstallApp: any;
|
||||
RunGame: any;
|
||||
VerifyApp: any;
|
||||
StreamGame: any;
|
||||
CancelLaunch: any;
|
||||
TerminateApp: any;
|
||||
UninstallApps: any;
|
||||
ShowStore: any;
|
||||
SetDLCEnabled: any;
|
||||
ContinueGameAction: any;
|
||||
CancelGameAction: any;
|
||||
GetActiveGameActions: any;
|
||||
GetGameActionDetails: any;
|
||||
GetGameActionForApp: any;
|
||||
SkipShaderProcessing: any;
|
||||
MarkEulaAccepted: any;
|
||||
MarkEulaRejected: any;
|
||||
LoadEula: any;
|
||||
GetConflictingFileTimestamps: any;
|
||||
GetCloudPendingRemoteOperations: any;
|
||||
ClearProton: any;
|
||||
RegisterForMarketingMessages: any;
|
||||
FetchMarketingMessages: any;
|
||||
MarkMarketingMessageSeen: any;
|
||||
ReportMarketingMessageSeen: any;
|
||||
RegisterForGameActionStart: any;
|
||||
RegisterForGameActionEnd: any;
|
||||
RegisterForGameActionTaskChange: any;
|
||||
RegisterForGameActionUserRequest: any;
|
||||
RegisterForGameActionShowError: any;
|
||||
RegisterForGameActionShowUI: any;
|
||||
OpenAppSettingsDialog: any;
|
||||
}
|
||||
|
||||
export interface Window {
|
||||
RegisterForExternalDisplayChanged: any;
|
||||
SetManualDisplayScaleFactor: any;
|
||||
SetAutoDisplayScale: any;
|
||||
Minimize: any;
|
||||
ProcessShuttingDown: any;
|
||||
ToggleMaximize: any;
|
||||
MoveTo: any;
|
||||
ResizeTo: any;
|
||||
SetMinSize: any;
|
||||
SetResizeGrip: any;
|
||||
SetComposition: any;
|
||||
GamescopeBlur: any;
|
||||
BringToFront: any;
|
||||
SetForegroundWindow: any;
|
||||
SetKeyFocus: any;
|
||||
FlashWindow: any;
|
||||
StopFlashWindow: any;
|
||||
ShowWindow: any;
|
||||
HideWindow: any;
|
||||
SetWindowIcon: any;
|
||||
GetWindowDimensions: any;
|
||||
GetWindowRestoreDetails: any;
|
||||
PositionWindowRelative: any;
|
||||
GetMousePositionDetails: any;
|
||||
IsWindowMinimized: any;
|
||||
GetBrowserID: any;
|
||||
}
|
||||
|
||||
export interface SteamClient {
|
||||
Apps: Apps;
|
||||
Browser: any;
|
||||
BrowserView: any;
|
||||
ClientNotifications: any;
|
||||
Cloud: any;
|
||||
Console: any;
|
||||
Downloads: any;
|
||||
FamilySharing: any;
|
||||
FriendSettings: any;
|
||||
Friends: any;
|
||||
GameSessions: any;
|
||||
Input: any;
|
||||
InstallFolder: any;
|
||||
Installs: any;
|
||||
MachineStorage: any;
|
||||
Messaging: any;
|
||||
Notifications: any;
|
||||
OpenVR: any;
|
||||
Overlay: any;
|
||||
Parental: any;
|
||||
RegisterIFrameNavigatedCallback: any;
|
||||
RemotePlay: any;
|
||||
RoamingStorage: any;
|
||||
Screenshots: any;
|
||||
Settings: any;
|
||||
SharedConnection: any;
|
||||
Stats: any;
|
||||
Storage: any;
|
||||
Streaming: any;
|
||||
System: any;
|
||||
UI: any;
|
||||
URL: any;
|
||||
Updates: any;
|
||||
User: any;
|
||||
WebChat: any;
|
||||
Window: Window;
|
||||
}
|
||||
|
||||
export interface SteamShortcut {
|
||||
appid: number;
|
||||
data: {
|
||||
bIsApplication: boolean;
|
||||
strAppName: string;
|
||||
strExePath: string;
|
||||
strArguments: string;
|
||||
strShortcutPath: string;
|
||||
strSortAs: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @prop unAppID is not properly set by Steam for non-steam game shortcuts, so it defaults to 0 for them
|
||||
*/
|
||||
export interface LifetimeNotification {
|
||||
unAppID: number;
|
||||
nInstanceID: number;
|
||||
bRunning: boolean;
|
||||
}
|
||||
|
||||
export type AppAchievements = {
|
||||
nAchieved: number;
|
||||
nTotal: number;
|
||||
vecAchievedHidden: any[];
|
||||
vecHighlight: any[];
|
||||
vecUnachieved: any[];
|
||||
};
|
||||
|
||||
export type AppLanguages = {
|
||||
strDisplayName: string;
|
||||
strShortName: string;
|
||||
};
|
||||
|
||||
export type LogoPinPositions = 'BottomLeft' | 'UpperLeft' | 'CenterCenter' | 'UpperCenter' | 'BottomCenter';
|
||||
|
||||
export interface LogoPosition {
|
||||
pinnedPosition: LogoPinPositions;
|
||||
nWidthPct: number;
|
||||
nHeightPct: number;
|
||||
}
|
||||
|
||||
export interface AppDetails {
|
||||
achievements: AppAchievements;
|
||||
bCanMoveInstallFolder: boolean;
|
||||
bCloudAvailable: boolean;
|
||||
bCloudEnabledForAccount: boolean;
|
||||
bCloudEnabledForApp: boolean;
|
||||
bCloudSyncOnSuspendAvailable: boolean;
|
||||
bCloudSyncOnSuspendEnabled: boolean;
|
||||
bCommunityMarketPresence: boolean;
|
||||
bEnableAllowDesktopConfiguration: boolean;
|
||||
bFreeRemovableLicense: boolean;
|
||||
bHasAllLegacyCDKeys: boolean;
|
||||
bHasAnyLocalContent: boolean;
|
||||
bHasLockedPrivateBetas: boolean;
|
||||
bIsExcludedFromSharing: boolean;
|
||||
bIsSubscribedTo: boolean;
|
||||
bOverlayEnabled: boolean;
|
||||
bOverrideInternalResolution: boolean;
|
||||
bRequiresLegacyCDKey: boolean;
|
||||
bShortcutIsVR: boolean;
|
||||
bShowCDKeyInMenus: boolean;
|
||||
bShowControllerConfig: boolean;
|
||||
bSupportsCDKeyCopyToClipboard: boolean;
|
||||
bVRGameTheatreEnabled: boolean;
|
||||
bWorkshopVisible: boolean;
|
||||
eAppOwnershipFlags: number;
|
||||
eAutoUpdateValue: number;
|
||||
eBackgroundDownloads: number;
|
||||
eCloudSync: number;
|
||||
eControllerRumblePreference: number;
|
||||
eDisplayStatus: number;
|
||||
eEnableThirdPartyControllerConfiguration: number;
|
||||
eSteamInputControllerMask: number;
|
||||
iInstallFolder: number;
|
||||
lDiskUsageBytes: number;
|
||||
lDlcUsageBytes: number;
|
||||
nBuildID: number;
|
||||
nCompatToolPriority: number;
|
||||
nPlaytimeForever: number;
|
||||
nScreenshots: number;
|
||||
rtLastTimePlayed: number;
|
||||
rtLastUpdated: number;
|
||||
rtPurchased: number;
|
||||
selectedLanguage: {
|
||||
strDisplayName: string;
|
||||
strShortName: string;
|
||||
};
|
||||
strCloudBytesAvailable: string;
|
||||
strCloudBytesUsed: string;
|
||||
strCompatToolDisplayName: string;
|
||||
strCompatToolName: string;
|
||||
strDeveloperName: string;
|
||||
strDeveloperURL: string;
|
||||
strDisplayName: string;
|
||||
strExternalSubscriptionURL: string;
|
||||
strFlatpakAppID: string;
|
||||
strHomepageURL: string;
|
||||
strLaunchOptions: string;
|
||||
strManualURL: string;
|
||||
strOwnerSteamID: string;
|
||||
strResolutionOverride: string;
|
||||
strSelectedBeta: string;
|
||||
strShortcutExe: string;
|
||||
strShortcutLaunchOptions: string;
|
||||
strShortcutStartDir: string;
|
||||
strSteamDeckBlogURL: string;
|
||||
unAppID: number;
|
||||
vecBetas: any[];
|
||||
vecDLC: any[];
|
||||
vecDeckCompatTestResults: any[];
|
||||
vecLanguages: AppLanguages[];
|
||||
vecLegacyCDKeys: any[];
|
||||
vecMusicAlbums: any[];
|
||||
vecPlatforms: string[];
|
||||
vecScreenShots: any[];
|
||||
libraryAssets?: {
|
||||
logoPosition?: LogoPosition;
|
||||
};
|
||||
}
|
||||
|
||||
export interface SteamAppOverview {
|
||||
display_name: string;
|
||||
gameid: string;
|
||||
appid: number;
|
||||
icon_hash: string;
|
||||
third_party_mod?: boolean;
|
||||
selected_clientid?: string;
|
||||
BIsModOrShortcut: () => boolean;
|
||||
BIsShortcut: () => boolean;
|
||||
}
|
||||
var SteamClient: SteamClient;
|
||||
}
|
||||
1749
src/globals/steam-client/App.ts
Normal file
1749
src/globals/steam-client/App.ts
Normal file
File diff suppressed because it is too large
Load Diff
105
src/globals/steam-client/Auth.ts
Normal file
105
src/globals/steam-client/Auth.ts
Normal file
@@ -0,0 +1,105 @@
|
||||
import { EResult, JsPbMessage, OperationResponse } from "./shared";
|
||||
import {EOSType} from "./system";
|
||||
|
||||
export interface Auth {
|
||||
/**
|
||||
* @returns a boolean indicating if the operation succeeded.
|
||||
*/
|
||||
ClearCachedSignInPin(): Promise<boolean>;
|
||||
|
||||
CurrentUserHasCachedSignInPin(): Promise<boolean>;
|
||||
|
||||
GetLocalHostname(): Promise<string>;
|
||||
|
||||
/**
|
||||
* @returns a ProtoBuf message. If deserialized, returns {@link CAuthentication_DeviceDetails}.
|
||||
*/
|
||||
GetMachineID(): Promise<ArrayBuffer>;
|
||||
|
||||
GetRefreshInfo(): Promise<AuthRefreshInfo>;
|
||||
|
||||
GetSteamGuardData(param0: string): Promise<SteamGuardData>;
|
||||
|
||||
/**
|
||||
* "Secured" refers to unshared.
|
||||
*/
|
||||
IsSecureComputer(): Promise<boolean>;
|
||||
|
||||
SetCachedSignInPin(pin: string): Promise<boolean>;
|
||||
|
||||
SetLoginToken(refreshToken: string, accountName: string): Promise<OperationResponse>;
|
||||
|
||||
SetSteamGuardData(accountName: string, newGuardData: string): void;
|
||||
|
||||
StartSignInFromCache(accountName: string, offlineMode: boolean): Promise<OperationResponse | void>;
|
||||
|
||||
UserHasCachedSignInPin(accountName: string): Promise<boolean>;
|
||||
|
||||
ValidateCachedSignInPin(accountName: string, pin: string): Promise<boolean>;
|
||||
}
|
||||
|
||||
export interface AuthRefreshInfo {
|
||||
reason: number;
|
||||
account_name: string;
|
||||
login_id_token: string;
|
||||
}
|
||||
|
||||
export interface SteamGuardData {
|
||||
data: string;
|
||||
eresult: EResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* `deserializeBinary` argument:
|
||||
* ```
|
||||
* [
|
||||
* await SteamClient.System.GetOSType(),
|
||||
* await SteamClient.Auth.GetLocalHostname(),
|
||||
* await SteamClient.Auth.GetMachineID(),
|
||||
* ];
|
||||
* ```
|
||||
*/
|
||||
export interface CAuthentication_DeviceDetails extends JsPbMessage {
|
||||
client_count(): number | undefined;
|
||||
|
||||
device_friendly_name(): string | undefined;
|
||||
|
||||
gaming_device_type(): EGamingDeviceType | undefined;
|
||||
|
||||
machine_id(): Uint8Array | string;
|
||||
|
||||
os_type(): EOSType | undefined;
|
||||
|
||||
platform_type(): EAuthTokenPlatformType | undefined;
|
||||
|
||||
set_client_count(): any;
|
||||
|
||||
set_device_friendly_name(): any;
|
||||
|
||||
set_gaming_device_type(): any;
|
||||
|
||||
set_machine_id(): any;
|
||||
|
||||
set_os_type(): any;
|
||||
|
||||
set_platform_type(): any;
|
||||
}
|
||||
|
||||
export enum EAuthTokenPlatformType {
|
||||
Unknown,
|
||||
SteamClient,
|
||||
WebBrowser,
|
||||
MobileApp,
|
||||
}
|
||||
|
||||
export enum EGamingDeviceType {
|
||||
Unknown,
|
||||
StandardPC,
|
||||
Console = 256,
|
||||
PS3 = 272,
|
||||
Steambox = 288,
|
||||
Tesla = 320,
|
||||
Handheld = 512,
|
||||
Phone = 528,
|
||||
SteamDeck = 544,
|
||||
}
|
||||
56
src/globals/steam-client/Broadcast.ts
Normal file
56
src/globals/steam-client/Broadcast.ts
Normal file
@@ -0,0 +1,56 @@
|
||||
import { EResult, Unregisterable } from "./shared";
|
||||
|
||||
export interface Broadcast {
|
||||
/**
|
||||
* Approves a viewer request for the broadcast.
|
||||
* @param steamId64 The SteamID64 of the user whose request is to be approved.
|
||||
*/
|
||||
ApproveViewerRequest(steamId64: string, param1: number): void;
|
||||
|
||||
/**
|
||||
* Invites a user identified by their SteamID64 to watch the broadcast.
|
||||
* @param steamId64 The SteamID64 of the user to invite.
|
||||
*/
|
||||
InviteToWatch(steamId64: string): Promise<EResult>;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when the broadcast status changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForBroadcastStatus(callback: (status: BroadcastStatus) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when viewer requests are received.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForViewerRequests(
|
||||
callback: (viewerFriendCode: number, param1: number, param2: number) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Rejects a viewer request for the broadcast.
|
||||
* @param steamId64 The SteamID64 of the user whose request is to be rejected.
|
||||
*/
|
||||
RejectViewerRequest(steamId64: string, param1: number): void;
|
||||
|
||||
/**
|
||||
* Stops the broadcast.
|
||||
*/
|
||||
StopBroadcasting(): void;
|
||||
}
|
||||
|
||||
export interface BroadcastStatus {
|
||||
broadcastid: string;
|
||||
nViewers: number;
|
||||
nRequests: number;
|
||||
bIsBroadcasting: boolean;
|
||||
bIsRecordingDesktop: boolean;
|
||||
eBroadcastReady: EResult;
|
||||
bBroadcastCapable: boolean;
|
||||
bMicrophoneEnabled: boolean;
|
||||
bMicrophoneActive: boolean;
|
||||
nCurrentFPS: number;
|
||||
nUploadKbps: number;
|
||||
}
|
||||
91
src/globals/steam-client/Browser.ts
Normal file
91
src/globals/steam-client/Browser.ts
Normal file
@@ -0,0 +1,91 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
export interface Browser {
|
||||
AddWordToDictionary(word: string): void;
|
||||
|
||||
ClearAllBrowsingData(): void;
|
||||
|
||||
ClearHistory(): void;
|
||||
|
||||
CloseDevTools(): void;
|
||||
|
||||
GetBrowserID(): Promise<number>;
|
||||
|
||||
GetSpellingSuggestions(word: string): string[];
|
||||
|
||||
GetSteamBrowserID(): Promise<number>; // 16-bit unsigned integer?
|
||||
|
||||
/**
|
||||
* Hides the mouse cursor until input.
|
||||
*/
|
||||
HideCursorUntilMouseEvent(): void;
|
||||
|
||||
/**
|
||||
* yup that's right, clientY and clientX are reversed
|
||||
*/
|
||||
InspectElement(clientY: number, clientX: number): void;
|
||||
|
||||
NotifyUserActivation(): void;
|
||||
|
||||
OpenDevTools(): void;
|
||||
|
||||
/**
|
||||
* Pastes the clipboard contents.
|
||||
*/
|
||||
Paste(): void;
|
||||
|
||||
/**
|
||||
* @note Not available on a created BrowserView.
|
||||
* @todo unconfirmed
|
||||
*/
|
||||
RegisterForGestureEvents(callback: (gesture: TouchGesture) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @note Not available on a created BrowserView.
|
||||
*/
|
||||
RegisterForOpenNewTab: Unregisterable;
|
||||
|
||||
ReplaceMisspelling(param0: string): void;
|
||||
|
||||
/**
|
||||
* Restarts the Steam JS context.
|
||||
*/
|
||||
RestartJSContext(): void;
|
||||
|
||||
SetBackgroundThrottlingDisabled(value: boolean): void;
|
||||
|
||||
SetPendingFilePath(path: string): Promise<boolean>;
|
||||
|
||||
SetShouldExitSteamOnBrowserClosed(value: boolean): Promise<void>;
|
||||
|
||||
SetTouchGesturesToCancel(gestures: ETouchGesture[]): void;
|
||||
|
||||
/**
|
||||
* Prompts and downloads a file.
|
||||
* @param url The URL of the file to download.
|
||||
*/
|
||||
StartDownload(url: string): void;
|
||||
}
|
||||
|
||||
export interface TouchGesture {
|
||||
eTouchGesture: ETouchGesture;
|
||||
x: number;
|
||||
y: number;
|
||||
}
|
||||
|
||||
export enum ETouchGesture {
|
||||
None,
|
||||
Touch,
|
||||
Tap,
|
||||
DoubleTap,
|
||||
ShortPress,
|
||||
LongPress,
|
||||
LongTap,
|
||||
TwoFingerTap,
|
||||
TapCancelled,
|
||||
PinchBegin,
|
||||
PinchUpdate,
|
||||
PinchEnd,
|
||||
FlingStart,
|
||||
FlingCancelled,
|
||||
}
|
||||
39
src/globals/steam-client/ClientNotifications.ts
Normal file
39
src/globals/steam-client/ClientNotifications.ts
Normal file
@@ -0,0 +1,39 @@
|
||||
import { BrowserContext } from "./shared";
|
||||
|
||||
export interface ClientNotifications {
|
||||
/**
|
||||
* Displays a Steam notification.
|
||||
* @param notification Notification type.
|
||||
* @param options Stringified object of {@link SteamNotificationOptions}.
|
||||
* @param callback
|
||||
*/
|
||||
DisplayClientNotification(
|
||||
notification: EClientUINotificationType,
|
||||
options: string,
|
||||
callback: (context: BrowserContext) => void,
|
||||
): void;
|
||||
|
||||
/**
|
||||
* @param notificationId The ID of the notification to handle.
|
||||
* @param handleAction `true` to execute the callback function associated with the notification.
|
||||
*/
|
||||
OnRespondToClientNotification(notificationId: number, handleAction: boolean): void;
|
||||
}
|
||||
|
||||
export interface SteamNotificationOptions {
|
||||
body: string;
|
||||
chatroomgroupid?: number;
|
||||
chatroomid?: number;
|
||||
icon?: string;
|
||||
state: string;
|
||||
/** A Steam64 ID. */
|
||||
steamid: string;
|
||||
tag?: string;
|
||||
title?: string;
|
||||
}
|
||||
|
||||
export enum EClientUINotificationType {
|
||||
GroupChatMessage = 1,
|
||||
FriendChatMessage,
|
||||
FriendPersonaState,
|
||||
}
|
||||
14
src/globals/steam-client/Cloud.ts
Normal file
14
src/globals/steam-client/Cloud.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
export interface Cloud {
|
||||
/**
|
||||
* Resolves a synchronization conflict for an app in the cloud.
|
||||
* @param appId The ID of the app with the sync conflict.
|
||||
* @param keepLocal Whether to keep the local version during conflict resolution.
|
||||
*/
|
||||
ResolveAppSyncConflict(appId: number, keepLocal: boolean): void;
|
||||
|
||||
/**
|
||||
* Retries syncing an app with the cloud.
|
||||
* @param appId The ID of the app to retry syncing.
|
||||
*/
|
||||
RetryAppSync(appId: number): void;
|
||||
}
|
||||
24
src/globals/steam-client/CommunityItems.ts
Normal file
24
src/globals/steam-client/CommunityItems.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
export interface CommunityItems {
|
||||
/*
|
||||
DownloadMovie(e) {
|
||||
return (0, o.mG)(this, void 0, void 0, (function* () {
|
||||
if (0 != e.movie_webm_local_path.length) return !0;
|
||||
let t = yield SteamClient.CommunityItems.DownloadItemAsset(e.communityitemid, w, e.movie_webm),
|
||||
n = 1 == t.result;
|
||||
if (n) {
|
||||
e.movie_webm_local_path = t.path;
|
||||
let n = [];
|
||||
this.m_startupMovies.forEach((t => {
|
||||
t.movie_webm == e.movie_webm ? n.push(e) : n.push(t)
|
||||
})), this.m_startupMovies = n
|
||||
}
|
||||
return n
|
||||
}))
|
||||
}
|
||||
*/
|
||||
DownloadItemAsset(communityItemId: string, param1: any, param2: string): any;
|
||||
|
||||
GetItemAssetPath(communityItemId: string, param1: any, param2: string): any;
|
||||
|
||||
RemoveDownloadedItemAsset(communityItemId: string, param1: any, param2: string): any;
|
||||
}
|
||||
43
src/globals/steam-client/Console.ts
Normal file
43
src/globals/steam-client/Console.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents the console functionality for executing commands and handling spew output.
|
||||
*/
|
||||
export interface Console {
|
||||
/**
|
||||
* Executes a console command.
|
||||
* @param command The command to execute in the console.
|
||||
*/
|
||||
ExecCommand(command: string): void;
|
||||
|
||||
/**
|
||||
* Retrieves autocomplete suggestions for a given console command.
|
||||
* @param command The console command to provide autocomplete suggestions for.
|
||||
* @returns an array of autocomplete suggestions.
|
||||
*/
|
||||
GetAutocompleteSuggestions(command: string): Promise<string[]>;
|
||||
|
||||
/**
|
||||
* Registers a callback function to receive spew output.
|
||||
* @param callback The callback function that will receive spew output.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForSpewOutput(callback: (output: SpewOutput) => void): Unregisterable;
|
||||
}
|
||||
|
||||
export type SpewType_t = "assert" | "error" | "warning" | "info" | "input";
|
||||
|
||||
/**
|
||||
* Represents spew output information.
|
||||
*/
|
||||
export interface SpewOutput {
|
||||
/**
|
||||
* The content of the spew output.
|
||||
*/
|
||||
spew: string;
|
||||
|
||||
/**
|
||||
* The type or category of the spew output.
|
||||
*/
|
||||
spew_type: SpewType_t;
|
||||
}
|
||||
12
src/globals/steam-client/Customization.ts
Normal file
12
src/globals/steam-client/Customization.ts
Normal file
@@ -0,0 +1,12 @@
|
||||
export interface Customization {
|
||||
GenerateLocalStartupMoviesThumbnails(param0: number): Promise<number>;
|
||||
|
||||
//param0: "startupmovies"
|
||||
GetDownloadedStartupMovies(param0: string): Promise<StartupMovie[]>;
|
||||
|
||||
GetLocalStartupMovies(): Promise<StartupMovie[]>;
|
||||
}
|
||||
|
||||
export interface StartupMovie {
|
||||
strMovieURL: string;
|
||||
}
|
||||
175
src/globals/steam-client/Downloads.ts
Normal file
175
src/globals/steam-client/Downloads.ts
Normal file
@@ -0,0 +1,175 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
import {EAppUpdateError} from "./App";
|
||||
|
||||
/**
|
||||
* Represents functions related to managing downloads in Steam.
|
||||
*/
|
||||
export interface Downloads {
|
||||
/**
|
||||
* Enables or disables all downloads in Steam.
|
||||
* @param enable True to enable downloads, false to disable.
|
||||
*/
|
||||
EnableAllDownloads(enable: boolean): void;
|
||||
|
||||
/**
|
||||
* Moves the update for a specific app down the download queue.
|
||||
* @param appId The ID of the application to move.
|
||||
*/
|
||||
MoveAppUpdateDown(appId: number): void;
|
||||
|
||||
/**
|
||||
* Moves the update for a specific app up the download queue.
|
||||
* @param appId The ID of the application to move.
|
||||
*/
|
||||
MoveAppUpdateUp(appId: number): void;
|
||||
|
||||
PauseAppUpdate(appId: number): void; // Broken? It seems to be removing it from download list like RemoveFromDownloadList
|
||||
|
||||
/**
|
||||
* Adds the update for a specific app to the download queue.
|
||||
* @param appId The ID of the application to queue.
|
||||
*/
|
||||
QueueAppUpdate(appId: number): void;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when download items change.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForDownloadItems(
|
||||
callback: (isDownloading: boolean, downloadItems: DownloadItem[]) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when download overview changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForDownloadOverview(callback: (overview: DownloadOverview) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Removes the update for a specific app from the download list and places it in the unscheduled list.
|
||||
* @param appId The ID of the application to remove.
|
||||
*/
|
||||
RemoveFromDownloadList(appId: number): void;
|
||||
|
||||
/**
|
||||
* Resumes the update for a specific app in the queue.
|
||||
* @param appId The ID of the application to resume.
|
||||
*/
|
||||
ResumeAppUpdate(appId: number): void;
|
||||
|
||||
/**
|
||||
* Sets an app to launch when its download is complete.
|
||||
* @param appId The ID of the application to set.
|
||||
*/
|
||||
SetLaunchOnUpdateComplete(appId: number): void;
|
||||
|
||||
/**
|
||||
* Sets the queue index for an app in the download queue.
|
||||
* @param appId The ID of the application to set the index for.
|
||||
* @param index The index to set.
|
||||
* @remarks Index of 0 is the current download in progress.
|
||||
*/
|
||||
SetQueueIndex(appId: number, index: number): void;
|
||||
|
||||
/**
|
||||
* Suspends or resumes download throttling.
|
||||
* @param suspend Whether to suspend or resume download throttling.
|
||||
*/
|
||||
SuspendDownloadThrottling(suspend: boolean): void;
|
||||
|
||||
/**
|
||||
* Suspends or resumes local transfers.
|
||||
* @param suspend Whether to suspend or resume local transfers.
|
||||
*/
|
||||
SuspendLanPeerContent(suspend: boolean): void;
|
||||
}
|
||||
|
||||
export interface DownloadItem {
|
||||
/** True if this app is currently downloading */
|
||||
active: boolean;
|
||||
/** Appid of app */
|
||||
appid: number;
|
||||
/** Current build ID for the installed app, zero if the app isn't installed yet */
|
||||
buildid: number;
|
||||
/** True if this update has been completed */
|
||||
completed: boolean;
|
||||
/** For completed downloads, time of completion, 0 if not completed */
|
||||
completed_time: number;
|
||||
deferred_time: number;
|
||||
/** Bytes already downloaded, sum across all content types */
|
||||
downloaded_bytes: number;
|
||||
/** If true, game will launch when its download completes successfully */
|
||||
launch_on_completion: boolean;
|
||||
/** True if this app has been paused by the user or the system */
|
||||
paused: boolean;
|
||||
/** Queue index, -1 if the item is unqueued */
|
||||
queue_index: number;
|
||||
/** Build ID that this download is moving towards. This can be the same as buildid.*/
|
||||
target_buildid: number;
|
||||
/** Total bytes to download, sum across all content types */
|
||||
total_bytes: number;
|
||||
/**
|
||||
* Update error description, when paused and there has been an error.
|
||||
* Unlocalized and shouldn't be displayed to the user.
|
||||
*/
|
||||
update_error: string;
|
||||
update_result: EAppUpdateError;
|
||||
update_type_info: UpdateTypeInfo[];
|
||||
}
|
||||
|
||||
export interface DownloadOverview {
|
||||
/** Set if we are downloading from LAN peer content server */
|
||||
lan_peer_hostname: string;
|
||||
/** True if all downloads are paused */
|
||||
paused: boolean;
|
||||
/** True if download throttling has been temporarily suspended for the current download */
|
||||
throttling_suspended: boolean;
|
||||
/** Appid of currently updating app */
|
||||
update_appid: number;
|
||||
/** Bytes already downloaded */
|
||||
update_bytes_downloaded: number;
|
||||
/** Bytes already processed in current phase - resets to zero when update stage changes */
|
||||
update_bytes_processed: number;
|
||||
/** Bytes already staged */
|
||||
update_bytes_staged: number;
|
||||
/** Total bytes to download */
|
||||
update_bytes_to_download: number;
|
||||
/** Total bytes to process in current phase - resets to zero when update stage changes */
|
||||
update_bytes_to_process: number;
|
||||
/** Total bytes to be staged */
|
||||
update_bytes_to_stage: number;
|
||||
/** Current disk throughput estimate */
|
||||
update_disc_bytes_per_second: number;
|
||||
/** True if the current update is an initial install */
|
||||
update_is_install: boolean;
|
||||
/** True if download and staging sizes are prefetch estimates */
|
||||
update_is_prefetch_estimate: boolean;
|
||||
/** True if the current update is for shader update */
|
||||
update_is_shader: boolean;
|
||||
/** True if the client is running in peer content server mode serving other peers */
|
||||
update_is_upload: boolean;
|
||||
/** True if the current update is for workshop content */
|
||||
update_is_workshop: boolean;
|
||||
/** Current bandwidth estimate for download */
|
||||
update_network_bytes_per_second: number;
|
||||
/** Peak bandwidth estimate for download */
|
||||
update_peak_network_bytes_per_second: number;
|
||||
/** Estimate of remaining time (in seconds) until download completes (not including staging) */
|
||||
update_seconds_remaining: number;
|
||||
/** Time current update started */
|
||||
update_start_time: number;
|
||||
update_state: 'None' | 'Starting' | 'Updating' | 'Stopping';
|
||||
}
|
||||
|
||||
export interface UpdateTypeInfo {
|
||||
/** True if this content type had an update and it has completed */
|
||||
completed_update: boolean;
|
||||
/** Bytes already downloaded for this content type */
|
||||
downloaded_bytes: number;
|
||||
/** True if this content type has or had an update */
|
||||
has_update: boolean;
|
||||
/** Total bytes to download for this content type */
|
||||
total_bytes: number;
|
||||
}
|
||||
30
src/globals/steam-client/FamilySharing.ts
Normal file
30
src/globals/steam-client/FamilySharing.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
import { EResult, Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents functions related to Steam Family Sharing.
|
||||
*/
|
||||
export interface FamilySharing {
|
||||
GetAvailableLenders(appId: number): Promise<Lender[]>;
|
||||
|
||||
RegisterForKickedBorrower: Unregisterable;
|
||||
|
||||
SetPreferredLender(appId: number, param1: number): Promise<EResult>;
|
||||
}
|
||||
|
||||
interface LenderDLC {
|
||||
rtStoreAssetModifyTime: number;
|
||||
strHeaderFilename: string;
|
||||
strName: string;
|
||||
unAppID: number;
|
||||
}
|
||||
|
||||
export interface Lender {
|
||||
/**
|
||||
* A Steam64 ID.
|
||||
*/
|
||||
steamid: string;
|
||||
appid: number;
|
||||
numDlc: number;
|
||||
bPreferred: boolean;
|
||||
vecDLC: LenderDLC[];
|
||||
}
|
||||
80
src/globals/steam-client/FriendSettings.ts
Normal file
80
src/globals/steam-client/FriendSettings.ts
Normal file
@@ -0,0 +1,80 @@
|
||||
import { VDFBoolean_t } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents friend settings and configuration.
|
||||
*/
|
||||
export interface FriendSettings {
|
||||
/**
|
||||
* Retrieves a list of enabled friend settings features.
|
||||
* @returns an array of enabled friend settings features.
|
||||
*/
|
||||
GetEnabledFeatures(): Promise<FriendSettingsFeatureObject[]>;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be notified of friend settings changes.
|
||||
* @param callback The callback function to be called when friend settings change.
|
||||
* @remarks The callback receives a JSON object string which may be parsed into {@link FriendSettingsChange}.
|
||||
*/
|
||||
RegisterForSettingsChanges(callback: (settings: string) => void): void;
|
||||
|
||||
/**
|
||||
* @param details Stringified {@link FriendSettingsChange}.
|
||||
*/
|
||||
SetFriendSettings(details: string): void;
|
||||
}
|
||||
|
||||
export enum EChatFlashMode {
|
||||
Always,
|
||||
Minimized,
|
||||
Never,
|
||||
}
|
||||
|
||||
export interface FriendSettingsFeatureObject {
|
||||
feature: FriendSettingsFeature_t;
|
||||
bEnabled: boolean;
|
||||
}
|
||||
|
||||
export type FriendSettingsFeature_t =
|
||||
| "DoNotDisturb"
|
||||
| "FriendsFilter"
|
||||
| "LoaderWindowSynchronization"
|
||||
| "NewVoiceHotKeyState"
|
||||
| "NonFriendMessageHandling"
|
||||
| "PersonaNotifications"
|
||||
| "ServerVirtualizedMemberLists"
|
||||
| "SteamworksChatAPI";
|
||||
|
||||
export type FriendSettingsEnabledFeatures<T> = {
|
||||
[feature in FriendSettingsFeature_t]: T;
|
||||
};
|
||||
|
||||
export interface FriendSettingsChange {
|
||||
bNotifications_ShowIngame: VDFBoolean_t;
|
||||
bNotifications_ShowOnline: VDFBoolean_t;
|
||||
bNotifications_ShowMessage: VDFBoolean_t;
|
||||
bNotifications_EventsAndAnnouncements: VDFBoolean_t;
|
||||
bSounds_PlayIngame: VDFBoolean_t;
|
||||
bSounds_PlayOnline: VDFBoolean_t;
|
||||
bSounds_PlayMessage: VDFBoolean_t;
|
||||
bSounds_EventsAndAnnouncements: VDFBoolean_t;
|
||||
bAlwaysNewChatWindow: VDFBoolean_t;
|
||||
bForceAlphabeticFriendSorting: VDFBoolean_t;
|
||||
nChatFlashMode: EChatFlashMode;
|
||||
bRememberOpenChats: VDFBoolean_t;
|
||||
bCompactQuickAccess: VDFBoolean_t;
|
||||
bCompactFriendsList: VDFBoolean_t;
|
||||
bNotifications_ShowChatRoomNotification: VDFBoolean_t;
|
||||
bSounds_PlayChatRoomNotification: VDFBoolean_t;
|
||||
bHideOfflineFriendsInTagGroups: VDFBoolean_t;
|
||||
bHideCategorizedFriends: VDFBoolean_t;
|
||||
bCategorizeInGameFriendsByGame: VDFBoolean_t;
|
||||
nChatFontSize: number;
|
||||
b24HourClock: VDFBoolean_t;
|
||||
bDoNotDisturbMode: VDFBoolean_t;
|
||||
bDisableEmbedInlining: VDFBoolean_t;
|
||||
bSignIntoFriends: VDFBoolean_t;
|
||||
bDisableSpellcheck: VDFBoolean_t;
|
||||
bDisableRoomEffects: VDFBoolean_t;
|
||||
bAnimatedAvatars: VDFBoolean_t;
|
||||
featuresEnabled: FriendSettingsEnabledFeatures<VDFBoolean_t>;
|
||||
}
|
||||
70
src/globals/steam-client/Friends.ts
Normal file
70
src/globals/steam-client/Friends.ts
Normal file
@@ -0,0 +1,70 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents functions related to managing friends in Steam.
|
||||
*/
|
||||
export interface Friends {
|
||||
/**
|
||||
* Adds a user to the friend list.
|
||||
* @param steamId The Steam ID of the user to add as a friend.
|
||||
* @returns `true` if the friend was added successfully.
|
||||
*/
|
||||
AddFriend(steamId: string): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* @returns a list of players you recently played with.
|
||||
*/
|
||||
GetCoplayData(): Promise<CoplayData>;
|
||||
|
||||
InviteUserToCurrentGame(steam64Id: string, steamIdTarget: string): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Invites a user to a specific game.
|
||||
* @param steamId The Steam ID of the user to invite.
|
||||
* @param appId The ID of the game to invite the user to.
|
||||
* @param connectString Additional parameters for the invitation.
|
||||
* @returns `true` if the user was invited successfully.
|
||||
*/
|
||||
InviteUserToGame(steamId: string, appId: number, connectString: string): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Invites a user to a specific lobby.
|
||||
* @returns `true` if the user was invited successfully.
|
||||
*/
|
||||
InviteUserToLobby(steam64Id: string, steamIdTarget: string): Promise<boolean>;
|
||||
|
||||
InviteUserToRemotePlayTogetherCurrentGame(steam64Id: string): Promise<boolean>;
|
||||
|
||||
RegisterForMultiplayerSessionShareURLChanged(
|
||||
appId: number,
|
||||
callback: (param0: string, param1: string) => void,
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForVoiceChatStatus(callback: (status: VoiceChatStatus) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Removes a user from the friend list.
|
||||
* @param steamId The Steam ID of the user to remove from the friend list.
|
||||
* @returns `true` if the friend was removed successfully.
|
||||
*/
|
||||
RemoveFriend(steamId: string): Promise<boolean>;
|
||||
|
||||
ShowRemotePlayTogetherUI(): void;
|
||||
}
|
||||
|
||||
export interface CoplayData {
|
||||
currentUsers: CoplayUser[];
|
||||
recentUsers: CoplayUser[];
|
||||
}
|
||||
|
||||
export interface CoplayUser {
|
||||
accountid: number;
|
||||
rtTimePlayed: number;
|
||||
appid: number;
|
||||
}
|
||||
|
||||
export interface VoiceChatStatus {
|
||||
bVoiceChatActive: boolean;
|
||||
bMicMuted: boolean;
|
||||
bOutputMuted: boolean;
|
||||
}
|
||||
73
src/globals/steam-client/GameNotes.ts
Normal file
73
src/globals/steam-client/GameNotes.ts
Normal file
@@ -0,0 +1,73 @@
|
||||
import { EResult, OperationResponse } from "./shared";
|
||||
|
||||
export interface GameNotes {
|
||||
/**
|
||||
* @returns a boolean indicating whether the operation was successful.
|
||||
*/
|
||||
DeleteImage(param0: string): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* @returns a boolean indicating whether the operation was successful.
|
||||
*/
|
||||
DeleteNotes(param0: string): Promise<boolean>;
|
||||
|
||||
GetNotes(filenameForNotes: string, directoryForNoteImages: string): Promise<Notes>;
|
||||
|
||||
GetNotesMetadata(note: string): Promise<NoteMetadata>;
|
||||
GetNumNotes(): Promise<number>;
|
||||
GetQuota: Promise<NotesQuota>;
|
||||
|
||||
IterateNotes(appId: number, length: number): Promise<NoteMetadata[]>;
|
||||
ResolveSyncConflicts(param0: boolean): Promise<EResult>;
|
||||
|
||||
/**
|
||||
* @param notes Escaped JSON array of {@link Note}.
|
||||
*/
|
||||
SaveNotes(filenameForNotes: string, notes: string): Promise<EResult>;
|
||||
SyncToClient(): Promise<EResult>;
|
||||
|
||||
SyncToServer(): Promise<EResult>;
|
||||
|
||||
/**
|
||||
* @param mimeType Image MIME type.
|
||||
* @param base64 Image contents in base64.
|
||||
* @returns an image file name with its extension that's meant to be used as a part of some URL. (todo)
|
||||
* @throws OperationResponse if invalid MIME type or unable to parse base64 BUT NOT if it failed.
|
||||
*/
|
||||
UploadImage(imageFileNamePrefix: string, mimeType: string, base64: string): Promise<EResult | OperationResponse>;
|
||||
}
|
||||
|
||||
export interface Note {
|
||||
appid: number;
|
||||
id: string;
|
||||
/**
|
||||
* Note contents in BB code.
|
||||
*/
|
||||
content: string;
|
||||
ordinal: number;
|
||||
time_created: number;
|
||||
time_modified: number;
|
||||
title: string;
|
||||
}
|
||||
|
||||
interface Notes {
|
||||
result: EResult;
|
||||
/**
|
||||
* Escaped JSON array of {@link Note}. Not present if {@link result} is {@link EResult.FileNotFound}.
|
||||
*/
|
||||
notes?: string;
|
||||
}
|
||||
|
||||
interface NoteMetadata {
|
||||
filename: string;
|
||||
filesize: number;
|
||||
result: EResult;
|
||||
timestamp: number;
|
||||
}
|
||||
|
||||
interface NotesQuota {
|
||||
bytes: number;
|
||||
bytesAvailable: number;
|
||||
numFiles: number;
|
||||
numFilesAvailable: number;
|
||||
}
|
||||
29
src/globals/steam-client/GameRecording.ts
Normal file
29
src/globals/steam-client/GameRecording.ts
Normal file
@@ -0,0 +1,29 @@
|
||||
import type { JsPbMessage, Unregisterable } from "./shared";
|
||||
|
||||
export interface GameRecording {
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link CGameRecording_AudioSessionsChanged_Notification}.
|
||||
*/
|
||||
RegisterForAudioSessionsChanged(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
SetAudioSessionCaptureState(id: string, name: string, state: boolean): void;
|
||||
}
|
||||
|
||||
export interface AudioSession {
|
||||
id(): string | undefined;
|
||||
name(): string | undefined;
|
||||
is_system(): boolean | undefined;
|
||||
is_muted(): boolean | undefined;
|
||||
is_active(): boolean | undefined;
|
||||
is_captured(): boolean | undefined;
|
||||
recent_peak(): number | undefined;
|
||||
is_game(): boolean | undefined;
|
||||
is_steam(): boolean | undefined;
|
||||
is_saved(): boolean | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* @note Taken from https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/steammessages_gamerecording_objects.proto
|
||||
*/
|
||||
export interface CGameRecording_AudioSessionsChanged_Notification extends JsPbMessage {
|
||||
sessions(): AudioSession[];
|
||||
}
|
||||
59
src/globals/steam-client/GameSessions.ts
Normal file
59
src/globals/steam-client/GameSessions.ts
Normal file
@@ -0,0 +1,59 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
import {AppAchievements} from "./App";
|
||||
import { Screenshot } from "./Screenshots";
|
||||
|
||||
/**
|
||||
* Represents functions related to Steam Game Sessions.
|
||||
*/
|
||||
export interface GameSessions {
|
||||
/**
|
||||
* Registers a callback function to be called when an achievement notification is received.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForAchievementNotification(
|
||||
callback: (notification: AchievementNotification) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when an app lifetime notification is received.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForAppLifetimeNotifications(
|
||||
callback: (notification: AppLifetimeNotification) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when a screenshot notification is received.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForScreenshotNotification(
|
||||
callback: (notification: ScreenshotNotification) => void,
|
||||
): Unregisterable;
|
||||
}
|
||||
|
||||
/**
|
||||
* @prop unAppID is not properly set by Steam for non-steam game shortcuts, so it defaults to 0 for them
|
||||
*/
|
||||
interface GameSessionNotificationBase {
|
||||
unAppID: number;
|
||||
}
|
||||
|
||||
export interface AchievementNotification extends GameSessionNotificationBase {
|
||||
achievement: AppAchievements;
|
||||
nCurrentProgress: number;
|
||||
nMaxProgress: number;
|
||||
}
|
||||
|
||||
export interface AppLifetimeNotification extends GameSessionNotificationBase {
|
||||
nInstanceID: number;
|
||||
bRunning: boolean;
|
||||
}
|
||||
|
||||
export interface ScreenshotNotification extends GameSessionNotificationBase {
|
||||
details: Screenshot;
|
||||
hScreenshot: number;
|
||||
strOperation: "deleted" | "written";
|
||||
}
|
||||
762
src/globals/steam-client/Input.ts
Normal file
762
src/globals/steam-client/Input.ts
Normal file
@@ -0,0 +1,762 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents functions related to input and controllers in Steam.
|
||||
*/
|
||||
export interface Input {
|
||||
CalibrateControllerIMU(controllerIndex: any): any;
|
||||
|
||||
CalibrateControllerJoystick(controllerIndex: any): any;
|
||||
|
||||
CalibrateControllerTrackpads(controllerIndex: any): any;
|
||||
|
||||
CancelGyroSWCalibration(): any;
|
||||
|
||||
ClearSelectedConfigForApp(appId: number, controllerIndex: number): any;
|
||||
|
||||
CloseDesktopConfigurator: any;
|
||||
|
||||
/**
|
||||
* Writes text.
|
||||
* @param textToWrite The text to write.
|
||||
*/
|
||||
ControllerKeyboardSendText(textToWrite: string): void;
|
||||
|
||||
/**
|
||||
* Sets a specified key's pressed state.
|
||||
* @param key The key index to set the state for.
|
||||
* @param state `true` for pressed, `false` otherwise.
|
||||
* @example
|
||||
* Send paste command:
|
||||
* ```
|
||||
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.LControl, true);
|
||||
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.V, true);
|
||||
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.V, false);
|
||||
* SteamClient.Input.ControllerKeyboardSetKeyState(EHIDKeyboardKey.LControl, false);
|
||||
* ```
|
||||
*/
|
||||
ControllerKeyboardSetKeyState(key: EHIDKeyboardKey, state: boolean): void;
|
||||
|
||||
DecrementCloudedControllerConfigsCounter(): any;
|
||||
|
||||
DeletePersonalControllerConfiguration(param0: any): any;
|
||||
|
||||
//f.Debug("sending to client"), this.SetEditingConfigurationValue(e, t, c.QU, (e => SteamClient.Input.DuplicateControllerConfigurationSourceMode(this.m_unControllerIndex, e))), this.SaveEditingConfiguration(e), this
|
||||
DuplicateControllerConfigurationSourceMode(controllerIndex: number, param1: any): any;
|
||||
|
||||
EndControllerDeviceSupportFlow(): any;
|
||||
|
||||
ExportCurrentControllerConfiguration(controllerIndex: number, appId: number, param2: number, title: string, description: string, param5: string): Promise<any>;
|
||||
|
||||
ForceConfiguratorFocus(param0: boolean): any;
|
||||
|
||||
ForceSimpleHapticEvent(param0: number, param1: number, param2: number, param3: number, param4: number): any;
|
||||
|
||||
FreeControllerConfig(m_ChordSummaryConfiguration: any): any;
|
||||
|
||||
GetConfigForAppAndController(appId: number, unControllerIndex: number): any;
|
||||
|
||||
/**
|
||||
* Retrieves the controller mapping string for the specified controller index.
|
||||
* @param unControllerIndex The controller index.
|
||||
* @returns the controller mapping string.
|
||||
*/
|
||||
GetControllerMappingString(unControllerIndex: number): Promise<string>;
|
||||
|
||||
GetControllerPreviouslySeen(): Promise<number[]>;
|
||||
|
||||
GetSteamControllerDongleState(): Promise<boolean>;
|
||||
|
||||
GetTouchMenuIconsForApp(appId: number): Promise<any>;
|
||||
|
||||
GetXboxDriverInstallState(): Promise<any>; // "{"nResult":0}"
|
||||
IdentifyController(controllerIndex: number): any;
|
||||
|
||||
InitControllerSounds(): any;
|
||||
|
||||
InitializeControllerPersonalizationSettings(controllerIndex: number): any;
|
||||
|
||||
ModalKeyboardDismissed(): void;
|
||||
|
||||
OpenDesktopConfigurator: any;
|
||||
|
||||
PreviewConfigForAppAndController(appId: number, controllerIndex: number, workshopUri: string): any;
|
||||
|
||||
PreviewControllerLEDColor(flHue: number, flSaturation: number, flBrightness: number): any;
|
||||
|
||||
QueryControllerConfigsForApp(appId: number, controllerIndex: number, param2: boolean): any;
|
||||
|
||||
RegisterForActiveControllerChanges: Unregisterable; // {"nActiveController":0}
|
||||
//param0 - e possibly appid?
|
||||
//param1 - some index?
|
||||
RegisterForConfigSelectionChanges(callback: (param0: number, param1: number) => void): Unregisterable;
|
||||
|
||||
RegisterForControllerAccountChanges: Unregisterable;
|
||||
|
||||
RegisterForControllerAnalogInputMessages(
|
||||
callback: (msgs: ControllerAnalogInputMessage[]) => void,
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForControllerBatteryChanges(callback: any): Unregisterable;
|
||||
|
||||
RegisterForControllerCommandMessages(
|
||||
callback: (msg: ControllerCommandMessage) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback for changes in controller configuration cloud state.
|
||||
* @param callback The callback function for config cloud state changes.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForControllerConfigCloudStateChanges(
|
||||
callback: (state: ControllerConfigCloudState) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback for receiving controller configuration info messages (controller layouts query, personal controller layout query).
|
||||
* @param callback The callback function for controller config info messages.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
* @remarks Do Not Use, this will break the controller layout selection unless you know what you are doing.
|
||||
*/
|
||||
RegisterForControllerConfigInfoMessages(
|
||||
callback: (
|
||||
msgs: ControllerConfigInfoMessageList[] | ControllerConfigInfoMessageQuery[],
|
||||
) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be invoked when controller input messages are received.
|
||||
* @param callback The callback function to be invoked when controller input messages are received.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForControllerInputMessages(
|
||||
callback: (msgs: ControllerInputMessage[]) => void,
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForControllerListChanges(callback: (controllerListChanges: ControllerInfo[]) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback for changes in the controller state (buttons presses, triggers presses, joystick changes etc...).
|
||||
* @param callback The callback function for controller state changes.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForControllerStateChanges(
|
||||
callback: (changes: ControllerStateChange[]) => void,
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForDualSenseUpdateNotification(callback: (m_strDualSenseUpdateProduct: string) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback for receiving game keyboard messages (text field popup for inputting text for games when in character creation or etc...).
|
||||
* @param callback The callback function for game keyboard messages.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForGameKeyboardMessages(callback: (msg: GameKeyboardMessage) => void): Unregisterable;
|
||||
|
||||
RegisterForRemotePlayConfigChanges(callback: () => void): Unregisterable;
|
||||
|
||||
//data.appId, data.ulConfigId
|
||||
RegisterForShowControllerLayoutPreviewMessages(callback: (data: any) => void): Unregisterable;
|
||||
|
||||
/*
|
||||
onTouchMenuInput(e) {
|
||||
for (let t = 0; t < e.length; t++) {
|
||||
const n = this.TouchMenuGetKey(e[t]), o = this.m_mapActiveTouchMenus.get(n);
|
||||
void 0 !== o && o.updateTouchMenuState(e[t])
|
||||
}
|
||||
}
|
||||
*/
|
||||
RegisterForTouchMenuInputMessages(callback: (inputs: number[]) => void): Unregisterable;
|
||||
|
||||
RegisterForTouchMenuMessages(callback: (msg: TouchMenuMessage) => void): Unregisterable;
|
||||
|
||||
//param0 - index?
|
||||
RegisterForUIVisualization(param0: any, param1: any, param2: any): Unregisterable;
|
||||
|
||||
RegisterForUnboundControllerListChanges(callback: (m_unboundControllerList: any) => void): Unregisterable; // param0 is an array
|
||||
|
||||
/*
|
||||
OnDismissKeyboardMessage(e) {
|
||||
this.m_WindowStore.SteamUIWindows.forEach((e => e.VirtualKeyboardManager.SetVirtualKeyboardHidden(e.BrowserWindow)))
|
||||
}
|
||||
*/
|
||||
RegisterForUserDismissKeyboardMessages(callback: (param0: any) => void): Unregisterable;
|
||||
|
||||
RegisterForUserKeyboardMessages: Unregisterable;
|
||||
|
||||
RequestGyroActive(controllerIndex: number, param1: boolean): any;
|
||||
|
||||
RequestRemotePlayControllerConfigs(param0: any): any;
|
||||
|
||||
ResetControllerBindings(param0: any): any;
|
||||
|
||||
ResolveCloudedControllerConfigConflict(param0: any): any;
|
||||
|
||||
RestoreControllerPersonalizationSettings(controllerIndex: number): any;
|
||||
|
||||
SaveControllerCalibration(controllerIndex: number): any;
|
||||
|
||||
SaveControllerPersonalizationSettings(param0: any): any;
|
||||
|
||||
SaveControllerSounds: any;
|
||||
|
||||
SaveEditingControllerConfiguration(controllerIndex: number, sharedConfig: boolean): any;
|
||||
|
||||
//this.SetEditingConfigurationValue(e, t, c.sL, (e => SteamClient.Input.SetControllerConfigurationModeShiftBinding(this.m_unControllerIndex, e)))
|
||||
SetControllerConfigurationModeShiftBinding(controllerIndex: number, param1: any): any;
|
||||
|
||||
SetControllerHapticSetting(controllerIndex: number, eHapticSetting: any): any;
|
||||
|
||||
SetControllerMappingString(mapping: string): void;
|
||||
|
||||
SetControllerName(controllerIndex: number, controllerName: string): any;
|
||||
|
||||
SetControllerNintendoLayoutSetting: any;
|
||||
SetControllerPersonalizationName: any;
|
||||
|
||||
//param0 - nLStickDeadzone, bSWAntiDrift, nRHapticStrength, flRPadPressureCurve
|
||||
/*
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("nLStickDeadzone", e.nLStickDeadzone),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("nRStickDeadzone", e.nRStickDeadzone),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("bSWAntiDrift", e.bSWAntiDrift ? 1 : 0),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("nLHapticStrength", e.nLHapticStrength),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("nRHapticStrength", e.nRHapticStrength),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("flLPadPressureCurve", 100 * e.flLPadPressureCurve),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("flRPadPressureCurve", 100 * e.flRPadPressureCurve),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("ePlayerSlotLEDSetting", e),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nGyroSampleAngleOffsetX", e.nGyroSampleAngleOffsetX),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.bMomentumEnabled", e.bMomentumEnabled ? 1 : 0),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nMomentumFrictionX", e.nMomentumFrictionX),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nMomentumFrictionY", e.nMomentumFrictionY),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nAccerationLevel", e.nAccerationLevel),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.bInvertX", e.bInvertX ? 1 : 0),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.bInvertY", e.bInvertY ? 1 : 0),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nRotationAngle", e.nRotationAngle),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nTriggerClamping", e.nTriggerClamping),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nTriggerClampingAmount", e.nTriggerClampingAmount),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nGyroEnableButton", e.nGyroEnableButton),
|
||||
SteamClient.Input.SetControllerPersonalizationSetting("GyroPreferenceData.nGyroEnableButtonBehavior", e.nGyroEnableButtonBehavior),
|
||||
*/
|
||||
SetControllerPersonalizationSetting(param0: string, param1: number): any;
|
||||
|
||||
//param0 - flGyroStationaryTolerance, flAccelerometerStationaryTolerance,
|
||||
/*
|
||||
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroNaturalSensitivity", e.flGyroNaturalSensitivity),
|
||||
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroXYRatio", e.flGyroXYRatio),
|
||||
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroSpeedDeadzone", e.flGyroSpeedDeadzone),
|
||||
SteamClient.Input.SetControllerPersonalizationSettingFloat("GyroPreferenceData.flGyroPrecisionSpeed", e.flGyroPrecisionSpeed),
|
||||
SteamClient.Input.SetControllerPersonalizationSettingFloat("flGyroStationaryTolerance", e.flGyroStationaryTolerance),
|
||||
SteamClient.Input.SetControllerPersonalizationSettingFloat("flAccelerometerStationaryTolerance", e.flAccelerometerStationaryTolerance),
|
||||
*/
|
||||
SetControllerPersonalizationSettingFloat(param0: string, param1: number): any;
|
||||
|
||||
SetControllerRumbleSetting(controllerIndex: number, rumblePreference: EControllerRumbleSetting): any;
|
||||
|
||||
SetControllerUseUniversalFaceButtonGlyphs(controllerIndex: number, value: boolean): void;
|
||||
|
||||
SetCursorActionset(param0: boolean): any;
|
||||
|
||||
SetDualSenseUpdateNotification(param0: boolean): any
|
||||
|
||||
/*
|
||||
SetEditingConfigurationValue(e, t, n, o) {
|
||||
const a = new r.BinaryWriter;
|
||||
n.serializeBinaryToWriter(n.fromObject(t), a);
|
||||
const s = a.getResultBase64String();
|
||||
f.Debug("SetEditingConfigurationValue serializeBinaryToWriter", (0, i.ZN)(t), s), this.EditingConfigurationWillUpdate(), this.m_updatingEditingConfigurationPromise = o(s).then((t => {
|
||||
if (null == t) return f.Debug("SetEditingConfigurationValue returned nothing."), void (0, i.z)((() => this.UpdateEditingConfiguration(e, this.m_unControllerIndex, this.EditingConfiguration)));
|
||||
const n = c.bE.deserializeBinary(t).toObject();
|
||||
f.Debug("SetEditingConfigurationValue returned controller configuration.", n), this.UpdateEditingConfiguration(e, this.m_unControllerIndex, n), this.m_nEditNumber++, -1 == n.url.indexOf("autosave://") && this.SaveEditingConfiguration(e)
|
||||
})).catch((e => {
|
||||
f.Error("SetEditingConfigurationValue fail:", o, l.jt(e.result), e.message), this.m_bIsUpdatingActiveConfiguration = !1
|
||||
}))
|
||||
}
|
||||
|
||||
SetControllerActionSet(e, t) {
|
||||
this.SetEditingConfigurationValue(e, t, c.X3, (e => SteamClient.Input.SetEditingControllerConfigurationActionSet(this.m_unControllerIndex, e)))
|
||||
}
|
||||
*/
|
||||
SetEditingControllerConfigurationActionSet(controllerIndex: number, param1: any): any;
|
||||
|
||||
//this.SetEditingConfigurationValue(e, t, c.io, (e => SteamClient.Input.SetEditingControllerConfigurationInputActivator(this.m_unControllerIndex, e)))
|
||||
SetEditingControllerConfigurationInputActivator(controllerIndex: number, param1: any): any;
|
||||
|
||||
//this.SetEditingConfigurationValue(e, t, c.tH, (e => SteamClient.Input.SetEditingControllerConfigurationInputActivatorEnabled(this.m_unControllerIndex, e)))
|
||||
SetEditingControllerConfigurationInputActivatorEnabled(controllerIndex: number, param1: any): any;
|
||||
|
||||
//this.SetEditingConfigurationValue(e, t, c.J2, (e => SteamClient.Input.SetEditingControllerConfigurationInputBinding(this.m_unControllerIndex, e)))
|
||||
SetEditingControllerConfigurationInputBinding(controllerIndex: number, param1: any): any;
|
||||
|
||||
//this.SetEditingConfigurationValue(e, t, c.Sz, (e => SteamClient.Input.SetEditingControllerConfigurationMiscSetting(this.m_unControllerIndex, e)))
|
||||
SetEditingControllerConfigurationMiscSetting(controllerIndex: number, param1: any): any;
|
||||
|
||||
//f.Debug("sending to client"), this.SetEditingConfigurationValue(e, t, c.QU, (e => SteamClient.Input.SetEditingControllerConfigurationSourceMode(this.m_unControllerIndex, e)))
|
||||
SetEditingControllerConfigurationSourceMode(controllerIndex: number, param1: any): any;
|
||||
|
||||
SetGamepadKeyboardText(param0: boolean, param1: string): any;
|
||||
|
||||
SetKeyboardActionset(param0: boolean, param1: boolean): any;
|
||||
|
||||
/**
|
||||
* Sets the mouse position.
|
||||
* @param pid 0
|
||||
* @param x Mouse X position.
|
||||
* @param y Mouse Y position.
|
||||
*/
|
||||
SetMousePosition(pid: number, x: number, y: number): void;
|
||||
|
||||
SetSelectedConfigForApp(appId: number, controllerIndex: number, url: string, param3: boolean): any;
|
||||
|
||||
SetSteamControllerDonglePairingMode(bEnable: boolean, bSilent: boolean): any;
|
||||
|
||||
SetVirtualMenuKeySelected(unControllerIndex: number, unMenuIndex: number, m_controllerMenuActiveMenuItem: number): any; //
|
||||
SetWebBrowserActionset(param0: boolean): any;
|
||||
|
||||
SetXboxDriverInstallState(param0: any): any; // state
|
||||
|
||||
/**
|
||||
* Opens the Steam Input controller settings.
|
||||
* This function displays the Steam Input controller settings for configuration.
|
||||
*/
|
||||
ShowControllerSettings(): void;
|
||||
|
||||
StandaloneKeyboardDismissed(): any;
|
||||
|
||||
StartControllerDeviceSupportFlow(param0: any, param1: any, callback: (param2: any) => void): any;
|
||||
|
||||
/*
|
||||
this.m_updatingEditingConfigurationPromise = SteamClient.Input.StartEditingControllerConfigurationForAppIDAndControllerIndex(e, t).then((n=>{
|
||||
const o = c.bE.deserializeBinary(n).toObject();
|
||||
f.Debug("Loaded controller config for appid", e, n, o),
|
||||
(0,
|
||||
i.z)((()=>this.UpdateEditingConfiguration(e, t, o)))
|
||||
}
|
||||
)).catch((n=>{
|
||||
f.Debug("Loading controller config for appid rejected", e, n),
|
||||
(0,
|
||||
i.z)((()=>this.UpdateEditingConfiguration(e, t, null)))
|
||||
}
|
||||
))
|
||||
*/
|
||||
StartEditingControllerConfigurationForAppIDAndControllerIndex(m_appId: number, m_unControllerIndex: number): Promise<any>;
|
||||
|
||||
StartGyroSWCalibration(callback: () => void): any;
|
||||
|
||||
StopEditingControllerConfiguration(controllerIndex: number): any;
|
||||
|
||||
SwapControllerConfigurationSourceModes: any;
|
||||
|
||||
//this.SetEditingConfigurationValue(e, t, c.Qb, (e => SteamClient.Input.SwapControllerModeInputBindings(this.m_unControllerIndex, e)))
|
||||
SwapControllerModeInputBindings(controllerIndex: number, param1: any): any;
|
||||
|
||||
SwapControllerOrder(controllerIndex1: number, controllerIndex2: number): any;
|
||||
|
||||
SyncCloudedControllerConfigs(): any;
|
||||
|
||||
// type - enum
|
||||
/*
|
||||
Off - 0, Tick, Click
|
||||
*/
|
||||
TriggerHapticPulse(controllerIndex: number, eHapticType: number, param2: number): any;
|
||||
|
||||
TriggerSimpleHapticEvent(
|
||||
controllerIndex: number,
|
||||
eHapticType: number,
|
||||
unIntensity: number,
|
||||
ndBGain: number,
|
||||
param4: number,
|
||||
): any;
|
||||
|
||||
UnregisterForControllerStateChanges(): void;
|
||||
|
||||
UnregisterForUIVisualization(controllerIndex: number): any;
|
||||
|
||||
UploadChangesForCloudedControllerConfigs(): any;
|
||||
}
|
||||
|
||||
export enum EHIDKeyboardKey {
|
||||
Invalid,
|
||||
BeforeFirst = 3,
|
||||
A,
|
||||
B,
|
||||
C,
|
||||
D,
|
||||
E,
|
||||
F,
|
||||
G,
|
||||
H,
|
||||
I,
|
||||
J,
|
||||
K,
|
||||
L,
|
||||
M,
|
||||
N,
|
||||
O,
|
||||
P,
|
||||
Q,
|
||||
R,
|
||||
S,
|
||||
T,
|
||||
U,
|
||||
V,
|
||||
W,
|
||||
X,
|
||||
Y,
|
||||
Z,
|
||||
Key_1,
|
||||
Key_2,
|
||||
Key_3,
|
||||
Key_4,
|
||||
Key_5,
|
||||
Key_6,
|
||||
Key_7,
|
||||
Key_8,
|
||||
Key_9,
|
||||
Key_0,
|
||||
Return,
|
||||
Escape,
|
||||
Backspace,
|
||||
Tab,
|
||||
Space,
|
||||
Dash,
|
||||
Equals,
|
||||
LeftBracket,
|
||||
RightBracket,
|
||||
Backslash,
|
||||
Unused1,
|
||||
Semicolon,
|
||||
SingleQuote,
|
||||
Backtick,
|
||||
Comma,
|
||||
Period,
|
||||
ForwardSlash,
|
||||
CapsLock,
|
||||
F1,
|
||||
F2,
|
||||
F3,
|
||||
F4,
|
||||
F5,
|
||||
F6,
|
||||
F7,
|
||||
F8,
|
||||
F9,
|
||||
F10,
|
||||
F11,
|
||||
F12,
|
||||
PrintScreen,
|
||||
ScrollLock,
|
||||
Break,
|
||||
Insert,
|
||||
Home,
|
||||
PageUp,
|
||||
Delete,
|
||||
End,
|
||||
PageDown,
|
||||
RightArrow,
|
||||
LeftArrow,
|
||||
DownArrow,
|
||||
UpArrow,
|
||||
NumLock,
|
||||
KeypadForwardSlash,
|
||||
KeypadAsterisk,
|
||||
KeypadDash,
|
||||
KeypadPlus,
|
||||
KeypadEnter,
|
||||
Keypad_1,
|
||||
Keypad_2,
|
||||
Keypad_3,
|
||||
Keypad_4,
|
||||
Keypad_5,
|
||||
Keypad_6,
|
||||
Keypad_7,
|
||||
Keypad_8,
|
||||
Keypad_9,
|
||||
Keypad_0,
|
||||
KeypadPeriod,
|
||||
LAlt,
|
||||
LShift,
|
||||
LWin,
|
||||
LControl,
|
||||
RAlt,
|
||||
RShift,
|
||||
RWin,
|
||||
RControl,
|
||||
VolUp,
|
||||
VolDown,
|
||||
Mute,
|
||||
Play,
|
||||
Stop,
|
||||
Next,
|
||||
Prev,
|
||||
AfterLast,
|
||||
}
|
||||
|
||||
export interface ControllerAnalogInputMessage {
|
||||
nA: number;
|
||||
x: number;
|
||||
y: number;
|
||||
nC: number;
|
||||
}
|
||||
|
||||
export interface ControllerCommandMessage {
|
||||
/**
|
||||
* @todo enum
|
||||
*/
|
||||
eAction: number;
|
||||
nControllerIndex: number;
|
||||
}
|
||||
|
||||
export interface ControllerConfigCloudState {
|
||||
bSyncDone: boolean;
|
||||
bSyncConflict: boolean;
|
||||
bSyncError: boolean;
|
||||
}
|
||||
|
||||
export interface ControllerConfigInfoMessage {
|
||||
appID: number;
|
||||
}
|
||||
|
||||
export interface ControllerConfigInfoMessageQuery extends ControllerConfigInfoMessage {
|
||||
bPersonalQueryDone: boolean;
|
||||
}
|
||||
|
||||
export interface ControllerConfigInfoMessageList extends ControllerConfigInfoMessage {
|
||||
nControllerType: number;
|
||||
publishedFileID: string;
|
||||
accountID: number;
|
||||
Title: string;
|
||||
Description: string;
|
||||
URL: string;
|
||||
timeUpdated: string;
|
||||
bOfficial: boolean;
|
||||
bProgenitorOfficial: boolean;
|
||||
bRecommended: boolean;
|
||||
bProgenitorRecommended: boolean;
|
||||
bUsesSIAPI: boolean;
|
||||
bUsesMouse: boolean;
|
||||
bUsesKeyboard: boolean;
|
||||
bUsesGamepad: boolean;
|
||||
/**
|
||||
* @todo unconfirmed
|
||||
*/
|
||||
eExportType: EControllerConfigExportType;
|
||||
playtime: string;
|
||||
bSelected: boolean;
|
||||
}
|
||||
|
||||
export enum EControllerConfigExportType {
|
||||
Unknown,
|
||||
PersonalLocal,
|
||||
PersonalCloud,
|
||||
Community,
|
||||
Template,
|
||||
Official,
|
||||
OfficialDefault,
|
||||
}
|
||||
|
||||
export enum EControllerRumbleSetting {
|
||||
ControllerPreference,
|
||||
Off,
|
||||
On,
|
||||
}
|
||||
|
||||
// TODO: Not the actual name, but the enum is only represented in a dropdown
|
||||
// options vector, ty valve
|
||||
export enum EThirdPartyControllerConfiguration {
|
||||
Off,
|
||||
DefaultSetting,
|
||||
On,
|
||||
}
|
||||
|
||||
export interface ControllerInputMessage {
|
||||
nA: number;
|
||||
bS: boolean;
|
||||
nC: number;
|
||||
}
|
||||
|
||||
export interface ActiveAccount {
|
||||
strActiveAccountID: string;
|
||||
strName: string;
|
||||
strAvatarHash: string;
|
||||
}
|
||||
|
||||
export interface ControllerInfo {
|
||||
strName: string;
|
||||
eControllerType: EControllerType;
|
||||
nXInputIndex: number;
|
||||
nControllerIndex: number;
|
||||
eRumblePreference: EControllerRumbleSetting;
|
||||
bWireless: boolean;
|
||||
unUniqueID: number;
|
||||
unVendorID: number;
|
||||
unProductID: number;
|
||||
/** Bitmask */
|
||||
unCapabilities: number;
|
||||
strFirmwareBuildTime: string;
|
||||
strSerialNumber: string;
|
||||
strChipID: string;
|
||||
nLEDColorR: number;
|
||||
nLEDColorG: number;
|
||||
nLEDColorB: number;
|
||||
flLEDBrightness: number;
|
||||
flLEDSaturation: number;
|
||||
nTurnOnSound: number;
|
||||
nTurnOffSound: number;
|
||||
nLStickDeadzone: number;
|
||||
nRStickDeadzone: number;
|
||||
nLHapticStrength: number;
|
||||
nRHapticStrength: number;
|
||||
flLPadPressureCurve: number;
|
||||
flRPadPressureCurve: number;
|
||||
bHaptics: boolean;
|
||||
bSWAntiDrift: boolean;
|
||||
flGyroStationaryTolerance: number;
|
||||
flAccelerometerStationaryTolerance: number;
|
||||
bRemoteDevice: boolean;
|
||||
bNintendoLayout: boolean;
|
||||
bUseReversedLayout: boolean;
|
||||
ActiveAccount: ActiveAccount | undefined;
|
||||
vecAltAccounts: any[]; // The type for this property might need to be more specific based on the actual data structure
|
||||
}
|
||||
|
||||
export enum EControllerType {
|
||||
None = -1,
|
||||
Unknown,
|
||||
UnknownSteamController,
|
||||
SteamController, // Codename Gordon
|
||||
SteamControllerV2, // Codename Headcrab
|
||||
SteamControllerNeptune, // Steam Deck
|
||||
FrontPanelBoard = 20,
|
||||
Generic = 30,
|
||||
XBox360Controller,
|
||||
XBoxOneController,
|
||||
PS3Controller,
|
||||
PS4Controller,
|
||||
WiiController,
|
||||
AppleController,
|
||||
AndroidController,
|
||||
SwitchProController,
|
||||
SwitchJoyConLeft,
|
||||
SwitchJoyConRight,
|
||||
SwitchJoyConPair,
|
||||
SwitchProGenericInputOnlyController,
|
||||
MobileTouch,
|
||||
SwitchProXInputSwitchController,
|
||||
PS5Controller,
|
||||
XboxEliteController,
|
||||
LastController, // Unverified
|
||||
PS5EdgeController,
|
||||
GenericKeyboard = 400,
|
||||
GenericMouse = 800,
|
||||
}
|
||||
|
||||
export interface ControllerStateChange {
|
||||
unControllerIndex: number;
|
||||
unPacketNum: number;
|
||||
/**
|
||||
* Bitmask representing pressed upper buttons.
|
||||
* - Bit 0-8: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 9: L4
|
||||
* - Bit 10: R4
|
||||
* - Bit 11-13: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 14: Left Joystick Touch
|
||||
* - Bit 15: Right Joystick Touch
|
||||
* - Bit 16-17: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 18: Quick Access Menu
|
||||
*/
|
||||
ulUpperButtons: number;
|
||||
/**
|
||||
* Bitmask representing pressed buttons.
|
||||
* - Bit 0: R2
|
||||
* - Bit 1: L2
|
||||
* - Bit 2: R1
|
||||
* - Bit 3: L1
|
||||
* - Bit 4: Y
|
||||
* - Bit 5: B
|
||||
* - Bit 6: X
|
||||
* - Bit 7: A
|
||||
* - Bit 8: D-Pad Up
|
||||
* - Bit 9: D-Pad Right
|
||||
* - Bit 10: D-Pad Left
|
||||
* - Bit 11: D-Pad Down
|
||||
* - Bit 12: Select
|
||||
* - Bit 13: Steam/Home
|
||||
* - Bit 14: Start
|
||||
* - Bit 15: L5
|
||||
* - Bit 16: R5
|
||||
* - Bit 17: Left Touchpad Click
|
||||
* - Bit 18: Right Touchpad Click
|
||||
* - Bit 19: Left Touchpad Touch
|
||||
* - Bit 20: Right Touchpad Touch
|
||||
* - Bit 21: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 22: L3
|
||||
* - Bit 23-25: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 26: R3
|
||||
* - Bit 27-28: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 29: Mute (Dualsense)
|
||||
* - Bit 30-31: Unknown (@todo Please provide more details if known)
|
||||
*/
|
||||
ulButtons: number;
|
||||
sLeftPadX: number;
|
||||
sLeftPadY: number;
|
||||
sRightPadX: number;
|
||||
sRightPadY: number;
|
||||
sCenterPadX: number;
|
||||
sCenterPadY: number;
|
||||
sLeftStickX: number;
|
||||
sLeftStickY: number;
|
||||
sRightStickX: number;
|
||||
sRightStickY: number;
|
||||
sTriggerL: number;
|
||||
sTriggerR: number;
|
||||
flTrustedGravityVectorX: number;
|
||||
flTrustedGravityVectorY: number;
|
||||
flTrustedGravityVectorZ: number;
|
||||
flSoftwareQuatW: number;
|
||||
flSoftwareQuatX: number;
|
||||
flSoftwareQuatY: number;
|
||||
flSoftwareQuatZ: number;
|
||||
flSoftwareGyroDegreesPerSecondPitch: number;
|
||||
flSoftwareGyroDegreesPerSecondYaw: number;
|
||||
flSoftwareGyroDegreesPerSecondRoll: number;
|
||||
flHardwareQuatW: number;
|
||||
flHardwareQuatX: number;
|
||||
flHardwareQuatY: number;
|
||||
flHardwareQuatZ: number;
|
||||
flHardwareGyroDegreesPerSecondPitch: number;
|
||||
flHardwareGyroDegreesPerSecondYaw: number;
|
||||
flHardwareGyroDegreesPerSecondRoll: number;
|
||||
flGyroNoiseLength: number;
|
||||
flGyroCalibrationProgress: number;
|
||||
flGravityVectorX: number;
|
||||
flGravityVectorY: number;
|
||||
flGravityVectorZ: number;
|
||||
flAccelerometerNoiseLength: number;
|
||||
sBatteryLevel: number;
|
||||
sPressurePadLeft: number;
|
||||
sPressurePadRight: number;
|
||||
sPressureBumperLeft: number;
|
||||
sPressureBumperRight: number;
|
||||
unHardwareUpdateInMicrosec: number;
|
||||
}
|
||||
|
||||
export interface GameKeyboardMessage {
|
||||
m_bOpen: boolean;
|
||||
nAppID: number;
|
||||
m_dwPID: number;
|
||||
m_dwOverlayPID: number;
|
||||
m_hPipe: number;
|
||||
/** @todo enum */
|
||||
m_eInputMode: number;
|
||||
/** @todo enum */
|
||||
m_eLineInputMode: number;
|
||||
m_pchDescription: string;
|
||||
m_unCharMax: number;
|
||||
m_pchExistingText: string;
|
||||
}
|
||||
|
||||
export interface TouchMenuMessage {
|
||||
bHasVirtualMenus: boolean;
|
||||
unControllerIndex: number;
|
||||
appID: number;
|
||||
}
|
||||
167
src/globals/steam-client/InstallFolder.ts
Normal file
167
src/globals/steam-client/InstallFolder.ts
Normal file
@@ -0,0 +1,167 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
import {EAppUpdateError} from "./App";
|
||||
|
||||
/**
|
||||
* Represents functions related to Steam Install Folders.
|
||||
*/
|
||||
export interface InstallFolder {
|
||||
/**
|
||||
* Adds a Steam Library folder to the Steam client.
|
||||
* @param path The path of the Steam Library folder to be added.
|
||||
* @returns the index of the added folder.
|
||||
*/
|
||||
AddInstallFolder(path: string): Promise<number>;
|
||||
|
||||
/**
|
||||
* Opens the file explorer to browse files in a specific Steam Library folder.
|
||||
* @param folderIndex The index of the folder to be opened.
|
||||
*/
|
||||
BrowseFilesInFolder(folderIndex: number): void;
|
||||
|
||||
/**
|
||||
* Cancels the current move operation for moving game content.
|
||||
*/
|
||||
CancelMove(): void;
|
||||
|
||||
/**
|
||||
* Retrieves a list of installed Steam Library folders.
|
||||
* @returns an array of SteamInstallFolder objects.
|
||||
*/
|
||||
GetInstallFolders(): Promise<SteamInstallFolder[]>;
|
||||
|
||||
/**
|
||||
* Retrieves a list of potential Steam Library folders that can be added.
|
||||
* @returns an array of PotentialInstallFolder objects.
|
||||
*/
|
||||
GetPotentialFolders(): Promise<PotentialInstallFolder[]>;
|
||||
|
||||
/**
|
||||
* Moves the installation folder for a specific app to another Steam Library folder.
|
||||
* @param appId The ID of the application to be moved.
|
||||
* @param folderIndex The index of the target Steam Library folder.
|
||||
*/
|
||||
MoveInstallFolderForApp(appId: number, folderIndex: number): void;
|
||||
|
||||
/**
|
||||
* Refreshes the list of installed Steam Library folders.
|
||||
*/
|
||||
RefreshFolders(): void;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when changes occur in Steam Install Folders.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForInstallFolderChanges(callback: (change: FolderChange) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when moving game content progresses.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForMoveContentProgress(callback: (progress: MoveContentProgress) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when repairing an install folder is finished.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForRepairFolderFinished(callback: (change: FolderChange) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Removes a Steam Library folder from the Steam client.
|
||||
* @param folderIndex The index of the folder to be removed.
|
||||
*/
|
||||
RemoveInstallFolder(folderIndex: number): void;
|
||||
|
||||
/**
|
||||
* Repairs an installed Steam Library folder.
|
||||
* @param folderIndex The index of the folder to be repaired.
|
||||
*/
|
||||
RepairInstallFolder(folderIndex: number): void;
|
||||
|
||||
/**
|
||||
* Sets a specific Steam Library folder as the default install folder.
|
||||
* @param folderIndex The index of the folder to be set as default.
|
||||
*/
|
||||
SetDefaultInstallFolder(folderIndex: number): void;
|
||||
|
||||
/**
|
||||
* Sets a user-defined label for a specific Steam Library folder.
|
||||
* @param folderIndex The index of the folder to be labeled.
|
||||
* @param label The label to be assigned to the folder.
|
||||
*/
|
||||
SetFolderLabel(folderIndex: number, label: string): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents information about an installation folder.
|
||||
*/
|
||||
export interface SteamInstallFolder extends PotentialInstallFolder {
|
||||
/** Index of the folder. */
|
||||
nFolderIndex: number;
|
||||
/** Used space in the folder. */
|
||||
strUsedSize: string;
|
||||
/** Size of DLC storage used in the folder. */
|
||||
strDLCSize: string;
|
||||
/** Size of workshop storage used in the folder. */
|
||||
strWorkshopSize: string;
|
||||
/** Size of staged storage used in the folder. */
|
||||
strStagedSize: string;
|
||||
/** Indicates if the folder is set as the default installation folder. */
|
||||
bIsDefaultFolder: boolean;
|
||||
/** Indicates if the folder is currently mounted. */
|
||||
bIsMounted: boolean;
|
||||
/** List of applications installed in the folder. */
|
||||
vecApps: AppInfo[];
|
||||
}
|
||||
|
||||
export interface PotentialInstallFolder {
|
||||
/** Path of the folder. */
|
||||
strFolderPath: string;
|
||||
/** User label for the folder. */
|
||||
strUserLabel: string;
|
||||
/** Name of the drive where the folder is located. */
|
||||
strDriveName: string;
|
||||
/** Total capacity of the folder. */
|
||||
strCapacity: string;
|
||||
/** Available free space in the folder. */
|
||||
strFreeSpace: string;
|
||||
/** Indicates if the folder is on a fixed drive. */
|
||||
bIsFixed: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents information about an installed application.
|
||||
*/
|
||||
export interface AppInfo {
|
||||
/** ID of the application. */
|
||||
nAppID: number;
|
||||
/** Name of the application. */
|
||||
strAppName: string;
|
||||
/** Sorting information for the application. */
|
||||
strSortAs: string;
|
||||
/** Last played time in Unix Epoch time format. */
|
||||
rtLastPlayed: number;
|
||||
/** Size of used storage by the application. */
|
||||
strUsedSize: string;
|
||||
/** Size of DLC storage used by the application. */
|
||||
strDLCSize: string;
|
||||
/** Size of workshop storage used by the application. */
|
||||
strWorkshopSize: string;
|
||||
/** Size of staged storage used by the application. */
|
||||
strStagedSize: string;
|
||||
}
|
||||
|
||||
export interface FolderChange {
|
||||
folderIndex: number;
|
||||
}
|
||||
|
||||
export interface MoveContentProgress {
|
||||
appid: number;
|
||||
eError: EAppUpdateError;
|
||||
flProgress: number;
|
||||
strBytesMoved: string;
|
||||
strTotalBytesToMove: string;
|
||||
nFilesMoved: number;
|
||||
}
|
||||
131
src/globals/steam-client/Installs.ts
Normal file
131
src/globals/steam-client/Installs.ts
Normal file
@@ -0,0 +1,131 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
import {EAppUpdateError} from "./App";
|
||||
|
||||
/**
|
||||
* Represents functions related to managing installs and installation wizards in Steam.
|
||||
*/
|
||||
export interface Installs {
|
||||
/**
|
||||
* Cancels the installation wizard if it is open.
|
||||
*/
|
||||
CancelInstall(): void;
|
||||
|
||||
/**
|
||||
* Continues and starts the installation if the wizard is still open.
|
||||
*/
|
||||
ContinueInstall(): void;
|
||||
|
||||
/**
|
||||
* Retrieves information from the last opened or currently opened installation wizard.
|
||||
*/
|
||||
GetInstallManagerInfo(): Promise<InstallMgrInfo>;
|
||||
|
||||
/**
|
||||
* Opens the restore from backup installer wizard for a specific app.
|
||||
* @param appBackupPath The backup path of the app.
|
||||
*/
|
||||
OpenInstallBackup(appBackupPath: string): void;
|
||||
|
||||
/**
|
||||
* Opens the installation wizard for specified app IDs.
|
||||
* @param appIds An array of app IDs to install.
|
||||
*/
|
||||
OpenInstallWizard(appIds: number[]): void;
|
||||
|
||||
/**
|
||||
* Opens the uninstall wizard for specified app IDs.
|
||||
* @param appIds An array of app IDs to uninstall.
|
||||
* @param dontPrompt Whether to *not* prompt the user to uninstall.
|
||||
*/
|
||||
OpenUninstallWizard(appIds: number[], dontPrompt: boolean): void;
|
||||
|
||||
RegisterForShowConfirmUninstall: Unregisterable; // Broken? doesn't seem to work
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the "Failed Uninstall" dialog is shown.
|
||||
* @param callback The callback function to be called when the dialog is shown.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForShowFailedUninstall(callback: (appId: number, reason: EAppUpdateError) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the installation wizard is shown.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForShowInstallWizard(callback: (data: InstallMgrInfo) => void): Unregisterable;
|
||||
|
||||
RegisterForShowRegisterCDKey: any;
|
||||
|
||||
/**
|
||||
* Sets a list of app identifiers for downloads in the installation wizard.
|
||||
* @param appIds An array of app IDs to set.
|
||||
* @remarks The wizard will not reflect this change immediately, but changing another option will.
|
||||
*/
|
||||
SetAppList(appIds: number[]): void;
|
||||
|
||||
/**
|
||||
* Sets the options for creating shortcuts in the installation wizard.
|
||||
* @param bDesktopShortcut Whether to create a desktop shortcut.
|
||||
* @param bSystemMenuShortcut Whether to create a system menu shortcut.
|
||||
* @remarks The wizard will not reflect this change immediately, but changing another option will.
|
||||
*/
|
||||
SetCreateShortcuts(bDesktopShortcut: boolean, bSystemMenuShortcut: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets the install folder for the installation wizard using an install folder index.
|
||||
* @param folderIndex The index of the install folder.
|
||||
* @remarks The wizard will not reflect this change immediately, but changing another option will.
|
||||
*/
|
||||
SetInstallFolder(folderIndex: number): void;
|
||||
}
|
||||
|
||||
export interface InstallMgrInfo {
|
||||
rgAppIDs: InstallInfoApps[];
|
||||
eInstallState: EInstallMgrState;
|
||||
nDiskSpaceRequired: number;
|
||||
nDiskSpaceAvailable: number;
|
||||
nCurrentDisk: number;
|
||||
nTotalDisks: number;
|
||||
bCanChangeInstallFolder: boolean;
|
||||
/**
|
||||
* Index of the install folder. -1 if not installed.
|
||||
*/
|
||||
iInstallFolder: number;
|
||||
iUnmountedFolder: number;
|
||||
currentAppID: number;
|
||||
eAppError: EAppUpdateError;
|
||||
errorDetail: string;
|
||||
bSystemMenuShortcut: boolean;
|
||||
bDesktopShortcut: boolean;
|
||||
bIsBackupInstall: boolean;
|
||||
// device/hostname
|
||||
strPeerContentServer: string;
|
||||
bPeerContentServerOnline: boolean;
|
||||
bPeerContentServerAvailable: boolean;
|
||||
}
|
||||
|
||||
export interface InstallInfoApps {
|
||||
nAppID: number;
|
||||
lDiskSpaceRequiredBytes: number;
|
||||
}
|
||||
|
||||
export enum EInstallMgrState {
|
||||
None,
|
||||
Setup,
|
||||
WaitLicense,
|
||||
FreeLicense,
|
||||
ShowCDKey,
|
||||
WaitAppInfo,
|
||||
ShowPassword,
|
||||
ShowConfig,
|
||||
ShowEULAs,
|
||||
CreateApps,
|
||||
ReadFromMedia,
|
||||
ShowChangeMedia,
|
||||
WaitLegacyCDKeys,
|
||||
ShowSignup,
|
||||
Complete,
|
||||
Failed,
|
||||
Canceled,
|
||||
}
|
||||
20
src/globals/steam-client/Messaging.ts
Normal file
20
src/globals/steam-client/Messaging.ts
Normal file
@@ -0,0 +1,20 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
export interface Messaging {
|
||||
// section - "ContentManagement", "JumpList", "PostToLibrary"
|
||||
// seems multipurpose
|
||||
RegisterForMessages<T extends string>(
|
||||
message: T,
|
||||
callback: (message: T, section: string, args: string) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/*
|
||||
function m(e) {
|
||||
SteamClient.Messaging.PostMessage("LibraryCommands", "ShowFriendChatDialog", JSON.stringify({
|
||||
steamid: e.persona.m_steamid.ConvertTo64BitString()
|
||||
}))
|
||||
}
|
||||
SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedRemotePlayInvite", JSON.stringify({id: this.appID})) : SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedGameInvite", JSON.stringify({id: this.appID}))
|
||||
*/
|
||||
PostMessage(message: string, section: string, args: string): void;
|
||||
}
|
||||
99
src/globals/steam-client/Music.ts
Normal file
99
src/globals/steam-client/Music.ts
Normal file
@@ -0,0 +1,99 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents functions related to controlling music playback in the Steam client.
|
||||
*/
|
||||
export interface Music {
|
||||
/**
|
||||
* Decreases the music volume by 10%.
|
||||
*/
|
||||
DecreaseVolume(): void;
|
||||
|
||||
/**
|
||||
* Increases the music volume by 10%.
|
||||
*/
|
||||
IncreaseVolume(): void;
|
||||
|
||||
/**
|
||||
* Plays the next track in the music playlist.
|
||||
*/
|
||||
PlayNext(): void;
|
||||
|
||||
/**
|
||||
* Plays the previous track in the music playlist.
|
||||
*/
|
||||
PlayPrevious(): void;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when music playback changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForMusicPlaybackChanges(callback: (param0: boolean | MusicTrack) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the music playback position changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForMusicPlaybackPosition(callback: (position: number) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Sets the playback position of the music track.
|
||||
* @param position The position to set in seconds.
|
||||
*/
|
||||
SetPlaybackPosition(position: number): void;
|
||||
|
||||
/**
|
||||
* Sets the repeat status for music playback.
|
||||
* @param status The repeat status.
|
||||
*/
|
||||
SetPlayingRepeatStatus(status: EMusicPlayingRepeatStatus): void;
|
||||
|
||||
/**
|
||||
* Sets the shuffle status for music playback.
|
||||
* @param value True to enable shuffle, false to disable shuffle.
|
||||
*/
|
||||
SetPlayingShuffled(value: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets the volume for music playback.
|
||||
* @param volume The volume level to set.
|
||||
* @remarks Ranges from 0 to 100.
|
||||
*/
|
||||
SetVolume(volume: number): void;
|
||||
|
||||
/**
|
||||
* Toggles the mute state of the music volume.
|
||||
*/
|
||||
ToggleMuteVolume(): void;
|
||||
|
||||
/**
|
||||
* Toggles between play and pause for music playback.
|
||||
*/
|
||||
TogglePlayPause(): void;
|
||||
}
|
||||
|
||||
export interface MusicTrack {
|
||||
uSoundtrackAppId: number;
|
||||
ePlaybackStatus: EAudioPlayback;
|
||||
eRepeatStatus: EMusicPlayingRepeatStatus;
|
||||
bShuffle: boolean;
|
||||
nVolume: number;
|
||||
nActiveTrack: number;
|
||||
nLengthInMsec: number;
|
||||
}
|
||||
|
||||
export enum EAudioPlayback {
|
||||
Undefined,
|
||||
Playing,
|
||||
Paused,
|
||||
Idle,
|
||||
}
|
||||
|
||||
export enum EMusicPlayingRepeatStatus {
|
||||
None,
|
||||
All,
|
||||
Once,
|
||||
Max,
|
||||
}
|
||||
333
src/globals/steam-client/Notifications.ts
Normal file
333
src/globals/steam-client/Notifications.ts
Normal file
@@ -0,0 +1,333 @@
|
||||
import { JsPbMessage, Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Everything is taken from here:
|
||||
* https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/steammessages_clientnotificationtypes.proto
|
||||
*/
|
||||
export interface Notifications {
|
||||
/**
|
||||
* If `data` is deserialized, returns one of the following here: {@link Notifications}
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForNotifications(
|
||||
callback: (notificationIndex: number, type: EClientNotificationType, data: ArrayBuffer) => void,
|
||||
): Unregisterable;
|
||||
}
|
||||
|
||||
export enum EClientNotificationType {
|
||||
Invalid,
|
||||
DownloadComplete,
|
||||
FriendInvite,
|
||||
FriendInGame,
|
||||
FriendOnline,
|
||||
Achievement,
|
||||
LowBattery,
|
||||
SystemUpdate,
|
||||
FriendMessage,
|
||||
GroupChatMessage,
|
||||
FriendInviteRollup,
|
||||
FamilySharingDeviceAuthorizationChanged,
|
||||
FamilySharingStopPlaying,
|
||||
FamilySharingLibraryAvailable,
|
||||
Screenshot,
|
||||
CloudSyncFailure,
|
||||
CloudSyncConflict,
|
||||
IncomingVoiceChat,
|
||||
ClaimSteamDeckRewards,
|
||||
GiftReceived,
|
||||
ItemAnnouncement,
|
||||
HardwareSurvey,
|
||||
LowDiskSpace,
|
||||
BatteryTemperature,
|
||||
DockUnsupportedFirmware,
|
||||
PeerContentUpload,
|
||||
CannotReadControllerGuideButton,
|
||||
Comment,
|
||||
Wishlist,
|
||||
TradeOffer,
|
||||
AsyncGame,
|
||||
General,
|
||||
HelpRequest,
|
||||
OverlaySplashScreen,
|
||||
BroadcastAvailableToWatch,
|
||||
TimedTrialRemaining,
|
||||
LoginRefresh,
|
||||
MajorSale,
|
||||
TimerExpired,
|
||||
ModeratorMsg,
|
||||
SteamInputActionSetChanged,
|
||||
RemoteClientConnection,
|
||||
RemoteClientStartStream,
|
||||
StreamingClientConnection,
|
||||
FamilyInvite,
|
||||
PlaytimeWarning,
|
||||
FamilyPurchaseRequest,
|
||||
FamilyPurchaseRequestResponse,
|
||||
ParentalFeatureRequest,
|
||||
ParentalPlaytimeRequest,
|
||||
GameRecordingError,
|
||||
ParentalFeatureResponse,
|
||||
ParentalPlaytimeResponse,
|
||||
RequestedGameAdded,
|
||||
ClipDownloaded,
|
||||
GameRecordingStart,
|
||||
GameRecordingStop,
|
||||
GameRecordingUserMarkerAdded,
|
||||
GameRecordingInstantClip,
|
||||
}
|
||||
|
||||
export enum ESystemUpdateNotificationType {
|
||||
Invalid,
|
||||
Available,
|
||||
NeedsRestart,
|
||||
}
|
||||
|
||||
export enum EGameRecordingErrorType {
|
||||
General = 1,
|
||||
LowDiskSpace,
|
||||
}
|
||||
|
||||
export interface ClientNotificationGroupChatMessage extends JsPbMessage {
|
||||
tag(): string;
|
||||
|
||||
/** A Steam64 ID. */
|
||||
steamid_sender(): string;
|
||||
|
||||
chat_group_id(): string;
|
||||
|
||||
chat_id(): string;
|
||||
|
||||
title(): string;
|
||||
|
||||
body(): string;
|
||||
|
||||
rawbody(): string;
|
||||
|
||||
icon(): string;
|
||||
|
||||
notificationid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFriendMessage extends JsPbMessage {
|
||||
body(): string;
|
||||
|
||||
icon(): string;
|
||||
|
||||
notificationid(): number;
|
||||
|
||||
response_steamurl(): string;
|
||||
|
||||
/** A Steam64 ID. */
|
||||
steamid(): string;
|
||||
|
||||
tag(): string;
|
||||
|
||||
title(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationCloudSyncFailure extends JsPbMessage {
|
||||
appid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationCloudSyncConflict extends JsPbMessage {
|
||||
appid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationScreenshot extends JsPbMessage {
|
||||
screenshot_handle(): string;
|
||||
description(): string;
|
||||
local_url(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationDownloadCompleted extends JsPbMessage {
|
||||
appid(): number;
|
||||
dlc_appid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFriendInvite extends JsPbMessage {
|
||||
steamid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFriendInviteRollup extends JsPbMessage {
|
||||
new_invite_count(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFriendInGame extends JsPbMessage {
|
||||
steamid(): number;
|
||||
game_name(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFriendOnline extends JsPbMessage {
|
||||
steamid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationAchievement extends JsPbMessage {
|
||||
achievement_id(): string;
|
||||
appid(): number;
|
||||
name(): string;
|
||||
description(): string;
|
||||
image_url(): string;
|
||||
achieved(): boolean;
|
||||
rtime_unlocked(): number;
|
||||
min_progress(): number;
|
||||
current_progress(): number;
|
||||
max_progress(): number;
|
||||
global_achieved_pct(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationLowBattery extends JsPbMessage {
|
||||
pct_remaining(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationSystemUpdate extends JsPbMessage {
|
||||
type(): ESystemUpdateNotificationType;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFriendMessage extends JsPbMessage {
|
||||
tag(): string;
|
||||
steamid(): string;
|
||||
title(): string;
|
||||
body(): string;
|
||||
icon(): string;
|
||||
notificationid(): number;
|
||||
response_steamurl(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationGroupChatMessage extends JsPbMessage {
|
||||
tag(): string;
|
||||
steamid_sender(): string;
|
||||
chat_group_id(): string;
|
||||
chat_id(): string;
|
||||
title(): string;
|
||||
body(): string;
|
||||
rawbody(): string;
|
||||
icon(): string;
|
||||
notificationid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFamilySharingDeviceAuthorizationChanged extends JsPbMessage {
|
||||
accountid_owner(): number;
|
||||
authorized(): boolean;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFamilySharingStopPlaying extends JsPbMessage {
|
||||
accountid_owner(): number;
|
||||
seconds_remaining(): number;
|
||||
appid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationFamilySharingLibraryAvailable extends JsPbMessage {
|
||||
accountid_owner(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationIncomingVoiceChat extends JsPbMessage {
|
||||
steamid(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationClaimSteamDeckRewards extends JsPbMessage {
|
||||
}
|
||||
|
||||
export interface ClientNotificationGiftReceived extends JsPbMessage {
|
||||
sender_name(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationItemAnnouncement extends JsPbMessage {
|
||||
new_item_count(): number;
|
||||
new_backpack_items(): boolean;
|
||||
}
|
||||
|
||||
export interface ClientNotificationHardwareSurveyPending extends JsPbMessage {
|
||||
}
|
||||
|
||||
export interface ClientNotificationLowDiskSpace extends JsPbMessage {
|
||||
folder_index(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationBatteryTemperature extends JsPbMessage {
|
||||
temperature(): number;
|
||||
notification_type(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationDockUnsupportedFirmware extends JsPbMessage {
|
||||
}
|
||||
|
||||
export interface ClientNotificationPeerContentUpload extends JsPbMessage {
|
||||
appid(): number;
|
||||
peer_name(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationCannotReadControllerGuideButton extends JsPbMessage {
|
||||
controller_index(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationOverlaySplashScreen extends JsPbMessage {
|
||||
}
|
||||
|
||||
export interface ClientNotificationBroadcastAvailableToWatch extends JsPbMessage {
|
||||
broadcast_permission(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationTimedTrialRemaining extends JsPbMessage {
|
||||
appid(): number;
|
||||
icon(): string;
|
||||
offline(): boolean;
|
||||
allowed_seconds(): number;
|
||||
played_seconds(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationLoginRefresh extends JsPbMessage {
|
||||
}
|
||||
|
||||
export interface ClientNotificationTimerExpired extends JsPbMessage {
|
||||
}
|
||||
|
||||
export interface ClientNotificationSteamInputActionSetChanged extends JsPbMessage {
|
||||
controller_index(): number;
|
||||
action_set_name(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationRemoteClientConnection extends JsPbMessage {
|
||||
machine(): string;
|
||||
connected(): boolean;
|
||||
}
|
||||
|
||||
export interface ClientNotificationRemoteClientStartStream extends JsPbMessage {
|
||||
machine(): string;
|
||||
game_name(): string;
|
||||
}
|
||||
|
||||
export interface ClientNotificationStreamingClientConnection extends JsPbMessage {
|
||||
hostname(): string;
|
||||
machine(): string;
|
||||
connected(): boolean;
|
||||
}
|
||||
|
||||
export interface ClientNotificationPlaytimeWarning extends JsPbMessage {
|
||||
type(): string;
|
||||
playtime_remaining(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationGameRecordingError extends JsPbMessage {
|
||||
game_id(): number;
|
||||
error_type(): EGameRecordingErrorType;
|
||||
}
|
||||
|
||||
export interface ClientNotificationGameRecordingStart extends JsPbMessage {
|
||||
game_id(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationGameRecordingStop extends JsPbMessage {
|
||||
game_id(): number;
|
||||
clip_id(): string;
|
||||
duration_secs(): number;
|
||||
}
|
||||
|
||||
export interface ClientNotificationGameRecordingUserMarkerAdded extends JsPbMessage {
|
||||
game_id(): number;
|
||||
}
|
||||
|
||||
export interface CClientNotificationGameRecordingInstantClip extends JsPbMessage {
|
||||
game_id(): number;
|
||||
clip_id(): string;
|
||||
duration_secs(): number;
|
||||
}
|
||||
122
src/globals/steam-client/OpenVR.ts
Normal file
122
src/globals/steam-client/OpenVR.ts
Normal file
@@ -0,0 +1,122 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
|
||||
export interface OpenVR {
|
||||
Device: VRDevice;
|
||||
DeviceProperties: DeviceProperties;
|
||||
|
||||
/**
|
||||
* @throws OperationResponse if mutual capabilities haven't been loaded.
|
||||
*/
|
||||
GetMutualCapabilities(): Promise<any>;
|
||||
|
||||
GetWebSecret(): Promise<string>;
|
||||
|
||||
InstallVR(): any;
|
||||
|
||||
Keyboard: Keyboard;
|
||||
PathProperties: PathProperties;
|
||||
|
||||
QuitAllVR(): any;
|
||||
|
||||
RegisterForButtonPress: Unregisterable;
|
||||
|
||||
RegisterForHMDActivityLevelChanged(callback: (m_eHMDActivityLevel: EHMDActivityLevel) => void): Unregisterable;
|
||||
|
||||
RegisterForInstallDialog: Unregisterable;
|
||||
|
||||
RegisterForStartupErrors(callback: (clientError: any, initError: any, initErrorString: string) => void): Unregisterable;
|
||||
|
||||
RegisterForVRHardwareDetected(callback: (m_bHMDPresent: any, m_bHMDHardwareDetected: any, m_strHMDName: any) => void): Unregisterable;
|
||||
|
||||
RegisterForVRModeChange(callback: (m_bIsVRRunning: boolean) => void): Unregisterable;
|
||||
|
||||
RegisterForVRSceneAppChange(callback: (param0: number) => void): Unregisterable;
|
||||
|
||||
SetOverlayInteractionAffordance: any;
|
||||
|
||||
StartVR: any;
|
||||
TriggerOverlayHapticEffect: any;
|
||||
VRNotifications: VRNotifications;
|
||||
VROverlay: VROverlay;
|
||||
}
|
||||
|
||||
export interface VRDevice {
|
||||
BIsConnected: any;
|
||||
RegisterForDeviceConnectivityChange: Unregisterable;
|
||||
|
||||
RegisterForVRDeviceSeenRecently(callback: (m_bVRDeviceSeenRecently: any) => void): Unregisterable;
|
||||
}
|
||||
|
||||
export interface DeviceProperties {
|
||||
GetBoolDeviceProperty: any;
|
||||
GetDoubleDeviceProperty: any;
|
||||
GetFloatDeviceProperty: any;
|
||||
GetInt32DeviceProperty: any;
|
||||
GetStringDeviceProperty: any;
|
||||
RegisterForDevicePropertyChange: Unregisterable;
|
||||
}
|
||||
|
||||
export interface Keyboard {
|
||||
Hide(): any;
|
||||
|
||||
/**
|
||||
* {@link EKeyboardFlags} could be useful here
|
||||
*/
|
||||
RegisterForStatus(callback: (m_bIsKeyboardOpen: boolean, m_eKeyboardFlags: number, m_sInitialKeyboardText: string) => void): Unregisterable;
|
||||
|
||||
SendDone(): any;
|
||||
|
||||
SendText(key: string): any; //???
|
||||
Show(): any;
|
||||
}
|
||||
|
||||
export interface PathProperties {
|
||||
GetBoolPathProperty: any;
|
||||
GetDoublePathProperty: any;
|
||||
GetFloatPathProperty: any;
|
||||
GetInt32PathProperty: any;
|
||||
GetStringPathProperty: any;
|
||||
RegisterForPathPropertyChange: any;
|
||||
SetBoolPathProperty: any;
|
||||
SetDoublePathProperty: any;
|
||||
SetFloatPathProperty: any;
|
||||
SetInt32PathProperty: any;
|
||||
SetStringPathProperty: any;
|
||||
}
|
||||
|
||||
export interface VRNotifications {
|
||||
HideCustomNotification: any;
|
||||
RegisterForNotificationEvent: Unregisterable;
|
||||
ShowCustomNotification: any;
|
||||
}
|
||||
|
||||
export interface VROverlay {
|
||||
HideDashboard: any;
|
||||
|
||||
IsDashboardVisible(): Promise<boolean>;
|
||||
|
||||
RegisterForButtonPress: Unregisterable;
|
||||
RegisterForCursorMovement: Unregisterable;
|
||||
RegisterForThumbnailChanged: Unregisterable;
|
||||
RegisterForVisibilityChanged: Unregisterable;
|
||||
ShowDashboard: any;
|
||||
|
||||
SwitchToDashboardOverlay(param0: string): void;
|
||||
}
|
||||
|
||||
export enum EHMDActivityLevel {
|
||||
Unknown = -1,
|
||||
Idle,
|
||||
UserInteraction,
|
||||
UserInteraction_Timeout,
|
||||
Standby,
|
||||
Idle_Timeout,
|
||||
}
|
||||
|
||||
export enum EKeyboardFlags {
|
||||
Minimal = 1 << 0,
|
||||
Modal = 1 << 1,
|
||||
ShowArrowKeys = 1 << 2,
|
||||
HideDoneKey = 1 << 3,
|
||||
}
|
||||
172
src/globals/steam-client/Overlay.ts
Normal file
172
src/globals/steam-client/Overlay.ts
Normal file
@@ -0,0 +1,172 @@
|
||||
import type { EBrowserType, ESteamRealm, EUIComposition, EUIMode, Unregisterable } from "./shared";
|
||||
|
||||
export interface Overlay {
|
||||
/**
|
||||
* Destroys the gamepad UI desktop configurator window if open.
|
||||
*/
|
||||
DestroyGamePadUIDesktopConfiguratorWindow(): void;
|
||||
|
||||
GetOverlayBrowserInfo(): Promise<OverlayBrowserInfo[]>;
|
||||
|
||||
// steam://gamewebcallback
|
||||
HandleGameWebCallback(url: string): void;
|
||||
|
||||
/**
|
||||
* @param protocol Something like {@link OverlayBrowserProtocols.strScheme}
|
||||
*/
|
||||
HandleProtocolForOverlayBrowser(appId: number, protocol: string): void;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when an overlay is activated from an app.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForActivateOverlayRequests(callback: (request: ActivateOverlayRequest) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when a microtransaction authorization is requested.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForMicroTxnAuth(
|
||||
callback: (appId: number, microTxnId: string, realm: ESteamRealm, microTxnUrl: string) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when a microtransaction authorization is dismissed by the user in Steam's authorization page.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForMicroTxnAuthDismiss(callback: (appId: number, microTxnId: string) => void): Unregisterable;
|
||||
|
||||
RegisterForNotificationPositionChanged(
|
||||
callback: (appId: number, position: ENotificationPosition, horizontalInset: number, verticalInset: number) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when an overlay is activated or closed.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForOverlayActivated(
|
||||
callback: (overlayProcessPid: number, appId: number, active: boolean, param3: boolean) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the overlay browser protocols change.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForOverlayBrowserProtocols(
|
||||
callback: (browseProtocols: OverlayBrowserProtocols) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers **the** callback function to be called when the overlay browser information changes.
|
||||
* @param callback The callback function to be called when the overlay browser information changes.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
* @remarks Do Not Use, this will break the overlay unless you know what you are doing.
|
||||
*/
|
||||
RegisterOverlayBrowserInfoChanged(callback: () => void): Unregisterable;
|
||||
|
||||
SetOverlayState(appId: string, state: EUIComposition): void;
|
||||
}
|
||||
|
||||
type OverlayRequestDialog_t =
|
||||
| 'achievements'
|
||||
| 'asyncnotificationsrequested'
|
||||
| 'chat'
|
||||
| 'community'
|
||||
| 'friendadd'
|
||||
| 'friendremove'
|
||||
| 'friendrequestaccept'
|
||||
| 'friendrequestignore'
|
||||
| 'friendremove'
|
||||
| 'jointrade'
|
||||
| 'leaderboards'
|
||||
| 'lobbyinvite'
|
||||
| 'lobbyinviteconnectstring'
|
||||
| 'officialgamegroup'
|
||||
| 'requestplaytime'
|
||||
| 'remoteplaytogether'
|
||||
| 'remoteplaytogetherinvite'
|
||||
| 'settings'
|
||||
| 'stats'
|
||||
| 'steamid'
|
||||
| 'store';
|
||||
|
||||
// EPosition
|
||||
export enum ENotificationPosition {
|
||||
TopLeft,
|
||||
TopRight,
|
||||
BottomLeft,
|
||||
BottomRight,
|
||||
}
|
||||
|
||||
export interface ActivateOverlayRequest {
|
||||
/**
|
||||
* The app ID that just had an overlay request.
|
||||
*/
|
||||
appid: number;
|
||||
|
||||
/**
|
||||
* `true` if webpage, and so {@link strDialog} will start with `https://`.
|
||||
*/
|
||||
bWebPage: boolean;
|
||||
|
||||
eFlag: EOverlayToStoreFlag;
|
||||
|
||||
eWebPageMode: EActivateGameOverlayToWebPageMode;
|
||||
|
||||
/**
|
||||
* Steam64 ID.
|
||||
*/
|
||||
steamidTarget: string;
|
||||
|
||||
/**
|
||||
* Game invites string for `Friends.InviteUserToGame`.
|
||||
*/
|
||||
strConnectString: string;
|
||||
|
||||
/**
|
||||
* Web page URL if starts with `https://`, so cast the type to `string` if it is.
|
||||
*/
|
||||
strDialog: OverlayRequestDialog_t;
|
||||
|
||||
/**
|
||||
* App ID of the requesting game.
|
||||
*/
|
||||
unRequestingAppID: number;
|
||||
}
|
||||
|
||||
export interface OverlayBrowserInfo {
|
||||
appID: number;
|
||||
eBrowserType: EBrowserType;
|
||||
eUIMode: EUIMode;
|
||||
flDisplayScale?: number;
|
||||
gameID: string;
|
||||
nBrowserID: number;
|
||||
nScreenHeight: number;
|
||||
nScreenWidth: number;
|
||||
/**
|
||||
* The PID of the overlay process.
|
||||
*/
|
||||
unPID: number;
|
||||
}
|
||||
|
||||
export interface OverlayBrowserProtocols {
|
||||
unAppID: number;
|
||||
strScheme: string;
|
||||
bAdded: boolean;
|
||||
}
|
||||
|
||||
export enum EActivateGameOverlayToWebPageMode {
|
||||
Default,
|
||||
Modal,
|
||||
}
|
||||
|
||||
export enum EOverlayToStoreFlag {
|
||||
None,
|
||||
AddToCart,
|
||||
AddToCartAndShow,
|
||||
}
|
||||
129
src/globals/steam-client/Parental.ts
Normal file
129
src/globals/steam-client/Parental.ts
Normal file
@@ -0,0 +1,129 @@
|
||||
import { EResult, Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Interface for managing parental control settings.
|
||||
*/
|
||||
export interface Parental {
|
||||
/**
|
||||
* Locks the parental control settings.
|
||||
*/
|
||||
LockParentalLock(): void;
|
||||
|
||||
RegisterForParentalPlaytimeWarnings(callback: (time: number) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be invoked when parental settings change.
|
||||
* @param callback The callback function to be invoked when parental settings change.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForParentalSettingsChanges(callback: (settings: ParentalSettings) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Unlocks the parental lock with the provided PIN.
|
||||
* @param pin The 4-digit PIN to unlock the parental lock.
|
||||
* @returns a number representing the result of the unlock operation.
|
||||
*/
|
||||
UnlockParentalLock(pin: string, param1: boolean): Promise<EResult>;
|
||||
}
|
||||
|
||||
export interface ParentalSettings {
|
||||
ever_enabled: boolean;
|
||||
locked: boolean;
|
||||
/**
|
||||
* If deserialized, returns {@link ParentalSettingsProtoMsg}.
|
||||
*/
|
||||
settings: ArrayBuffer;
|
||||
strPlaintextPassword: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents the parental settings and restrictions.
|
||||
* @todo This whole thing is unconfirmed as I do not have access to parental
|
||||
* stuff and things
|
||||
*/
|
||||
export interface ParentalSettingsProtoMsg {
|
||||
steamid?: number;
|
||||
applist_base_id?: number;
|
||||
applist_base_description?: string;
|
||||
/**
|
||||
* Base list.
|
||||
*/
|
||||
applist_base: ParentalApp[];
|
||||
/**
|
||||
* Custom list of allowed applications.
|
||||
*/
|
||||
applist_custom: ParentalApp[];
|
||||
/**
|
||||
* @todo enum ?
|
||||
*/
|
||||
passwordhashtype?: number;
|
||||
salt?: number;
|
||||
passwordhash?: number;
|
||||
/**
|
||||
* Indicates whether parental settings are enabled.
|
||||
*/
|
||||
is_enabled?: boolean;
|
||||
/**
|
||||
* Bitmask representing enabled features.
|
||||
* - Bit 0: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 1: Online content & features - Steam Store
|
||||
* - Bit 2: Online content & features - Community-generated content
|
||||
* - Bit 3: Online content & features - My online profile, screenshots, and achievements
|
||||
* - Bit 4: Online content & features - Friends, chat, and groups
|
||||
* - Bit 5-11: Unknown (@todo Please provide more details if known)
|
||||
* - Bit 12: Library content - 0: Only games I choose, 1: All games
|
||||
* @todo {@link EParentalFeature} ?
|
||||
*/
|
||||
enabled_features?: number;
|
||||
/**
|
||||
* Email for recovery (if applicable).
|
||||
*/
|
||||
recovery_email?: string;
|
||||
is_site_license_lock?: boolean;
|
||||
temporary_enabled_features?: number;
|
||||
rtime_temporary_feature_expiration?: number;
|
||||
playtime_restrictions?: ParentalPlaytimeRestrictions;
|
||||
temporary_playtime_restrictions?: ParentalTemporaryPlaytimeRestrictions;
|
||||
excluded_store_content_descriptors: number[];
|
||||
excluded_community_content_descriptors: number[];
|
||||
utility_appids: number[];
|
||||
}
|
||||
|
||||
interface ParentalApp {
|
||||
appid: number;
|
||||
is_allowed: boolean;
|
||||
}
|
||||
|
||||
interface ParentalPlaytimeDay {
|
||||
allowed_time_windows?: number;
|
||||
allowed_daily_minutes?: number;
|
||||
}
|
||||
|
||||
interface ParentalPlaytimeRestrictions {
|
||||
apply_playtime_restrictions?: boolean;
|
||||
playtime_days: ParentalPlaytimeDay[];
|
||||
}
|
||||
|
||||
interface ParentalTemporaryPlaytimeRestrictions {
|
||||
restrictions?: ParentalPlaytimeDay;
|
||||
rtime_expires?: number;
|
||||
}
|
||||
|
||||
export enum EParentalFeature {
|
||||
Invalid,
|
||||
Store,
|
||||
Community,
|
||||
Profile,
|
||||
Friends,
|
||||
News,
|
||||
Trading,
|
||||
Settings,
|
||||
Console,
|
||||
Browser,
|
||||
ParentalSetup,
|
||||
Library,
|
||||
Test,
|
||||
SiteLicense,
|
||||
KioskMode,
|
||||
Max,
|
||||
}
|
||||
342
src/globals/steam-client/RemotePlay.ts
Normal file
342
src/globals/steam-client/RemotePlay.ts
Normal file
@@ -0,0 +1,342 @@
|
||||
import {EControllerType} from "./Input";
|
||||
import { EParentalFeature } from "./Parental";
|
||||
import { EResult, Unregisterable } from "./shared";
|
||||
|
||||
export interface RemotePlay {
|
||||
/**
|
||||
* @param param1 TODO: Something about restrictions countries ? maybe it's games
|
||||
*/
|
||||
BCanAcceptInviteForGame(gameId: string, param1: string): Promise<boolean>;
|
||||
BCanCreateInviteForGame(gameId: string, param1: boolean): Promise<boolean>;
|
||||
|
||||
BRemotePlayTogetherGuestOnPhoneOrTablet(steam64Id: string, guestId: number): Promise<boolean>;
|
||||
|
||||
BRemotePlayTogetherGuestSupported(): Promise<boolean>;
|
||||
|
||||
// TODO: both calls have 1 arg, but it requires 2
|
||||
CancelInviteAndSession(steam64Id: string, param1: number): Promise<EResult>;
|
||||
|
||||
CancelInviteAndSessionWithGuestID(steam64Id: string, guestId: number): Promise<EResult>;
|
||||
|
||||
CancelRemoteClientPairing(): void;
|
||||
|
||||
CloseGroup(): Promise<number>;
|
||||
|
||||
CreateGroup(param0: string): Promise<EResult>;
|
||||
|
||||
CreateInviteAndSession(steam64Id: string, param1: string): Promise<EResult>;
|
||||
|
||||
CreateInviteAndSessionWithGuestID(steam64Id: string, guestId: number, param2: string): Promise<EResult>;
|
||||
|
||||
GetClientID(): Promise<string>;
|
||||
|
||||
// TODO: -1 no preference? no idea where the settings are anyway lol
|
||||
GetClientStreamingBitrate(): Promise<number>;
|
||||
GetClientStreamingQuality(): Promise<number>;
|
||||
GetControllerType(controllerIndex: number): Promise<EControllerType>;
|
||||
|
||||
/**
|
||||
* @returns an integer from 0 to 100.
|
||||
*/
|
||||
GetGameSystemVolume(): Promise<number>;
|
||||
|
||||
GetPerUserInputSettings(steam64Id: string): Promise<RemotePlayInputSettings>;
|
||||
|
||||
GetPerUserInputSettingsWithGuestID(steam64Id: string, guestId: number): Promise<RemotePlayInputSettings>;
|
||||
|
||||
IdentifyController(nControllerIndex: number): void;
|
||||
|
||||
InstallAudioDriver(): void;
|
||||
InstallInputDriver(): void;
|
||||
MoveControllerToSlot(controllerIndex: number, slot: number): void;
|
||||
RegisterForAdditionalParentalBlocks(callback: (blocks: EParentalFeature[]) => void): Unregisterable;
|
||||
RegisterForAudioDriverPrompt(callback: () => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @todo no mentions of it in Steam code
|
||||
*/
|
||||
RegisterForBitrateOverride: Unregisterable;
|
||||
RegisterForClearControllers(callback: () => void): Unregisterable;
|
||||
RegisterForControllerIndexSet(
|
||||
callback: (steamid: string, slot: number, guestid: number) => void
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForDevicesChanges(callback: (devices: RemotePlayDevice[]) => void): Unregisterable;
|
||||
|
||||
RegisterForGroupCreated(callback: (steamId: string, appId: string) => void): Unregisterable;
|
||||
RegisterForGroupDisbanded(callback: () => void): Unregisterable;
|
||||
RegisterForInputDriverPrompt(callback: () => void): Unregisterable;
|
||||
RegisterForInputDriverRestartNotice(callback: () => void): Unregisterable;
|
||||
|
||||
RegisterForInputUsed(
|
||||
callback: (steam64Id: string, type: EClientUsedInputType, guestId: number) => void,
|
||||
): Unregisterable; // only fires on host
|
||||
|
||||
RegisterForInviteResult(
|
||||
callback: (
|
||||
steamId: string,
|
||||
param1: any,
|
||||
result: ERemoteClientLaunch,
|
||||
) => void
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForNetworkUtilizationUpdate(
|
||||
callback: (steam64Id: string, guestId: number, networkUtilization: number, networkDuration: number) => void,
|
||||
): Unregisterable; // only fires on host
|
||||
|
||||
RegisterForPlaceholderStateChanged(callback: (isShowingPlaceholder: boolean) => void): Unregisterable;
|
||||
|
||||
RegisterForPlayerInputSettingsChanged(
|
||||
callback: (steamId: string, settings: RemotePlayInputSettings, guestId: number) => void
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForQualityOverride(callback: (hostStreamingQualityOverride: number) => void): Unregisterable;
|
||||
|
||||
RegisterForRemoteClientLaunchFailed(callback: (state: ERemoteClientLaunch) => void): Unregisterable;
|
||||
|
||||
RegisterForRemoteClientStarted(callback: (steam64Id: string, appId: string) => void): Unregisterable; // only fires on client
|
||||
|
||||
RegisterForRemoteClientStopped(callback: (steam64Id: string, appId: string) => void): Unregisterable; // only fires on client
|
||||
|
||||
RegisterForRemoteDeviceAuthorizationCancelled(callback: () => void): Unregisterable;
|
||||
|
||||
RegisterForRemoteDeviceAuthorizationRequested(callback: (device: string) => void): Unregisterable;
|
||||
|
||||
RegisterForRemoteDevicePairingPINChanged(callback: (device: string, pin: string) => void): Unregisterable;
|
||||
|
||||
RegisterForRestrictedSessionChanges(callback: (restrictedSession: boolean) => void): Unregisterable;
|
||||
|
||||
RegisterForSessionStopped(callback: (steam64Id: string, guestId: number, avatarHash: string) => void): Unregisterable;
|
||||
|
||||
RegisterForSessionStarted(callback: (steam64Id: string, gameId: string, guestId: number) => void): Unregisterable;
|
||||
|
||||
RegisterForSessionStopped(callback: (steam64Id: string, guestId: number) => void): Unregisterable;
|
||||
|
||||
RegisterForSettingsChanges(callback: (remotePlaySettings: RemotePlaySettings) => void): Unregisterable;
|
||||
|
||||
SetClientStreamingBitrate(bitrate: number): void;
|
||||
|
||||
SetClientStreamingQuality(quality: number): void;
|
||||
|
||||
SetGameSystemVolume(volume: number): void;
|
||||
|
||||
SetPerUserControllerInputEnabled(steam64Id: string, enabled: boolean): void;
|
||||
|
||||
SetPerUserControllerInputEnabledWithGuestID(steam64Id: string, guestId: number, enabled: boolean): void;
|
||||
|
||||
SetPerUserKeyboardInputEnabled(steam64Id: string, enabled: boolean): void;
|
||||
|
||||
SetPerUserKeyboardInputEnabledWithGuestID(steam64Id: string, guestId: number, enabled: boolean): void;
|
||||
|
||||
SetPerUserMouseInputEnabled(steam64Id: string, enabled: boolean): void;
|
||||
|
||||
SetPerUserMouseInputEnabledWithGuestID(steam64Id: string, guestId: number, enabled: boolean): void;
|
||||
|
||||
SetRemoteDeviceAuthorized(param0: boolean, param1: string): void;
|
||||
|
||||
SetRemoteDevicePIN(pin: string): void;
|
||||
|
||||
SetRemotePlayEnabled(enabled: boolean): void;
|
||||
|
||||
/**
|
||||
* @param base64 Serialized base64 message from {@link StreamingClientConfig}.
|
||||
*/
|
||||
SetStreamingClientConfig(base64: string, sessionId: number): void;
|
||||
|
||||
/**
|
||||
* Enables advanced client options.
|
||||
*/
|
||||
SetStreamingClientConfigEnabled(value: boolean): void;
|
||||
|
||||
SetStreamingDesktopToRemotePlayTogetherEnabled(enabled: boolean): void;
|
||||
|
||||
SetStreamingP2PScope(scope: EStreamP2PScope): void;
|
||||
|
||||
/**
|
||||
* @param base64 Serialized base64 message from {@link StreamingServerConfig}.
|
||||
*/
|
||||
SetStreamingServerConfig(base64: string, sessionId: number): void;
|
||||
|
||||
/**
|
||||
* Enables advanced host options.
|
||||
*/
|
||||
SetStreamingServerConfigEnabled(value: boolean): void;
|
||||
|
||||
StopStreamingClient(): void;
|
||||
|
||||
StopStreamingSession(id: number): void;
|
||||
StopStreamingSessionAndSuspendDevice(id: number): void;
|
||||
|
||||
UnlockH264(): void;
|
||||
|
||||
/**
|
||||
* Unpairs all devices.
|
||||
*/
|
||||
UnpairRemoteDevices(): void;
|
||||
}
|
||||
|
||||
export enum EClientUsedInputType {
|
||||
Keyboard,
|
||||
Mouse,
|
||||
Controller,
|
||||
Max,
|
||||
}
|
||||
|
||||
export interface RemotePlayDevice {
|
||||
clientId: string;
|
||||
clientName: string;
|
||||
status: string; // "Connected", "Paired",
|
||||
formFactor: number;
|
||||
unStreamingSessionID: number;
|
||||
bCanSteamVR: boolean;
|
||||
bCanSuspend: boolean;
|
||||
}
|
||||
|
||||
interface RemotePlayInputSettings {
|
||||
bKeyboardEnabled: true;
|
||||
bMouseEnabled: true;
|
||||
bControllerEnabled: true;
|
||||
}
|
||||
|
||||
export interface RemotePlaySettings {
|
||||
bAV1DecodeAvailable: boolean;
|
||||
bHEVCDecodeAvailable: boolean;
|
||||
bRemotePlayDisabledBySystemPolicy: boolean;
|
||||
bRemotePlaySupported: boolean;
|
||||
bRemotePlayEnabled: boolean;
|
||||
eRemotePlayP2PScope: EStreamP2PScope;
|
||||
bRemotePlayServerConfigAvailable: boolean;
|
||||
bRemotePlayServerConfigEnabled: boolean;
|
||||
bRemotePlayClientConfigEnabled: boolean;
|
||||
unStreamingSessionID: number;
|
||||
strStreamingClientName: string;
|
||||
/**
|
||||
* If deserialized, returns {@link StreamingClientConfig}.
|
||||
*/
|
||||
RemotePlayClientConfig: StreamingClientConfig;
|
||||
/**
|
||||
* If deserialized, returns {@link StreamingServerConfig}.
|
||||
*/
|
||||
RemotePlayServerConfig: ArrayBuffer;
|
||||
nDefaultAudioChannels: number;
|
||||
nAutomaticResolutionX: number;
|
||||
nAutomaticResolutionY: number;
|
||||
}
|
||||
|
||||
export interface StreamingClientConfig {
|
||||
quality?: EStreamQualityPreference;
|
||||
desired_resolution_x?: number;
|
||||
desired_resolution_y?: number;
|
||||
desired_framerate_numerator?: number;
|
||||
desired_framerate_denominator?: number;
|
||||
desired_bitrate_kbps?: number;
|
||||
enable_hardware_decoding?: boolean;
|
||||
enable_performance_overlay?: boolean;
|
||||
enable_video_streaming?: boolean;
|
||||
enable_audio_streaming?: boolean;
|
||||
enable_input_streaming?: boolean;
|
||||
audio_channels?: number;
|
||||
enable_video_hevc?: boolean;
|
||||
enable_performance_icons?: boolean;
|
||||
enable_microphone_streaming?: boolean;
|
||||
controller_overlay_hotkey?: string;
|
||||
enable_touch_controller_OBSOLETE?: boolean;
|
||||
p2p_scope?: EStreamP2PScope;
|
||||
enable_audio_uncompressed?: boolean;
|
||||
display_limit?: StreamVideoLimit;
|
||||
quality_limit?: StreamVideoLimit;
|
||||
runtime_limit?: StreamVideoLimit;
|
||||
decoder_limit: StreamVideoLimit[];
|
||||
}
|
||||
|
||||
export interface StreamingServerConfig {
|
||||
change_desktop_resolution?: boolean;
|
||||
dynamically_adjust_resolution_OBSOLETE?: boolean;
|
||||
enable_capture_nvfbc?: boolean;
|
||||
enable_hardware_encoding_nvidia_OBSOLETE?: boolean;
|
||||
enable_hardware_encoding_amd_OBSOLETE?: boolean;
|
||||
enable_hardware_encoding_intel_OBSOLETE?: boolean;
|
||||
software_encoding_threads?: number;
|
||||
enable_traffic_priority?: boolean;
|
||||
host_play_audio?: EStreamHostPlayAudioPreference;
|
||||
enable_hardware_encoding?: boolean;
|
||||
}
|
||||
|
||||
export interface StreamVideoLimit {
|
||||
codec?: EStreamVideoCodec;
|
||||
mode?: StreamVideoMode;
|
||||
bitrate_kbps?: number;
|
||||
burst_bitrate_kbps?: number;
|
||||
}
|
||||
|
||||
export interface StreamVideoMode {
|
||||
width?: number;
|
||||
height?: number;
|
||||
refresh_rate?: number;
|
||||
refresh_rate_numerator?: number;
|
||||
refresh_rate_denominator?: number;
|
||||
}
|
||||
|
||||
export enum ERemoteClientLaunch {
|
||||
OK = 1,
|
||||
Fail,
|
||||
RequiresUI,
|
||||
RequiresLaunchOption,
|
||||
RequiresEULA,
|
||||
Timeout,
|
||||
StreamTimeout,
|
||||
StreamClientFail,
|
||||
OtherGameRunning,
|
||||
DownloadStarted,
|
||||
DownloadNoSpace,
|
||||
DownloadFiltered,
|
||||
DownloadRequiresUI,
|
||||
AccessDenied,
|
||||
NetworkError,
|
||||
Progress,
|
||||
ParentalUnlockFailed,
|
||||
ScreenLocked,
|
||||
Unsupported,
|
||||
DisabledLocal,
|
||||
DisabledRemote,
|
||||
Broadcasting,
|
||||
Busy,
|
||||
DriversNotInstalled,
|
||||
TransportUnavailable,
|
||||
Canceled,
|
||||
Invisible,
|
||||
RestrictedCountry,
|
||||
Unauthorized,
|
||||
}
|
||||
|
||||
export enum EStreamVideoCodec {
|
||||
None,
|
||||
Raw,
|
||||
VP8,
|
||||
VP9,
|
||||
H264,
|
||||
HEVC,
|
||||
ORBX1,
|
||||
ORBX2,
|
||||
AV1,
|
||||
}
|
||||
|
||||
export enum EStreamHostPlayAudioPreference {
|
||||
Default,
|
||||
Always,
|
||||
}
|
||||
|
||||
export enum EStreamQualityPreference {
|
||||
Automatic = -1,
|
||||
Fast = 1,
|
||||
Balanced,
|
||||
Beautiful,
|
||||
}
|
||||
|
||||
export enum EStreamP2PScope {
|
||||
Automatic,
|
||||
Disabled,
|
||||
OnlyMe,
|
||||
Friends,
|
||||
Everyone,
|
||||
}
|
||||
149
src/globals/steam-client/Screenshots.ts
Normal file
149
src/globals/steam-client/Screenshots.ts
Normal file
@@ -0,0 +1,149 @@
|
||||
/**
|
||||
* Interface for managing screenshots.
|
||||
*/
|
||||
export interface Screenshots {
|
||||
/**
|
||||
* Deletes a local screenshot.
|
||||
* @param appId The ID of the application.
|
||||
* @param screenshotIndex The index of the local screenshot.
|
||||
* @returns a boolean value indicating whether the deletion was successful.
|
||||
*/
|
||||
DeleteLocalScreenshot(appId: string, screenshotIndex: number): Promise<boolean>;
|
||||
|
||||
DeleteLocalScreenshots(screenshots: ScreenshotToDelete[]): Promise<ScreenshotDeletionResponse>;
|
||||
|
||||
/**
|
||||
* Retrieves all local screenshots for all applications.
|
||||
* @returns an array of Screenshot objects.
|
||||
*/
|
||||
GetAllAppsLocalScreenshots(): Promise<Screenshot[]>;
|
||||
|
||||
/**
|
||||
* Retrieves the count of all local screenshots for all applications.
|
||||
* @returns the count of local screenshots.
|
||||
*/
|
||||
GetAllAppsLocalScreenshotsCount(): Promise<number>;
|
||||
|
||||
/**
|
||||
* Retrieves a range of local screenshots for all applications.
|
||||
* @param start The starting index of the screenshot range.
|
||||
* @param end The ending index of the screenshot range.
|
||||
* @returns an array of Screenshot objects within the specified range.
|
||||
*/
|
||||
GetAllAppsLocalScreenshotsRange(start: number, end: number): Promise<Screenshot[]>;
|
||||
|
||||
/**
|
||||
* Retrieves all local screenshots.
|
||||
* @returns an array of Screenshot objects.
|
||||
*/
|
||||
GetAllLocalScreenshots(): Promise<Screenshot[]>;
|
||||
|
||||
/**
|
||||
* Retrieves the game associated with a specific local screenshot index.
|
||||
* @param screenshotIndex The index of the local screenshot.
|
||||
* @returns the ID of the game associated with the screenshot.
|
||||
*/
|
||||
GetGameWithLocalScreenshots(screenshotIndex: number): Promise<number>;
|
||||
|
||||
/**
|
||||
* Retrieves the last taken local screenshot.
|
||||
* @returns the last taken local screenshot.
|
||||
*/
|
||||
GetLastScreenshotTaken(): Promise<Screenshot>;
|
||||
|
||||
/**
|
||||
* Retrieves a specific local screenshot for an application.
|
||||
* @param appId The ID of the application.
|
||||
* @param screenshotIndex The index of the local screenshot.
|
||||
* @returns the requested local screenshot.
|
||||
*/
|
||||
GetLocalScreenshotByHandle(appId: string, screenshotIndex: number): Promise<Screenshot>;
|
||||
|
||||
/**
|
||||
* Retrieves the count of local screenshots for a specific application.
|
||||
* @param appId The ID of the application.
|
||||
* @returns the count of local screenshots for the application.
|
||||
*/
|
||||
GetLocalScreenshotCount(appId: number): Promise<number>;
|
||||
|
||||
/**
|
||||
* Retrieves the path of a screenshot.
|
||||
* @param appId The ID of the application.
|
||||
* @param hHandle The handle of the screenshot.
|
||||
* @returns the screenshot path or the screenshot directory if no such handle.
|
||||
*/
|
||||
GetLocalScreenshotPath(appId: number, hHandle: number): Promise<string>;
|
||||
|
||||
/**
|
||||
* Retrieves the number of games with local screenshots.
|
||||
* @returns the number of games with local screenshots.
|
||||
*/
|
||||
GetNumGamesWithLocalScreenshots(): Promise<number>;
|
||||
|
||||
/**
|
||||
* Gets total screenshot usage in the specified library folder.
|
||||
* @param path Library folder path.
|
||||
* @returns the number of taken space in bytes.
|
||||
*/
|
||||
GetTotalDiskSpaceUsage(path: string): Promise<number>;
|
||||
|
||||
/**
|
||||
* Opens a local screenshot in the system image viewer.
|
||||
* If the screenshot index is invalid, this function opens the screenshots directory for the specified application ID.
|
||||
* @param appId The ID of the application.
|
||||
* @param screenshotIndex The index of the local screenshot.
|
||||
*/
|
||||
ShowScreenshotInSystemViewer(appId: string, screenshotIndex: number): void;
|
||||
|
||||
/**
|
||||
* Opens the folder containing local screenshots for a specific application.
|
||||
* @param appId The ID of the application.
|
||||
*/
|
||||
ShowScreenshotsOnDisk(appId: string): void;
|
||||
|
||||
/**
|
||||
* Uploads a local screenshot.
|
||||
* @param appId The ID of the application.
|
||||
* @param localScreenshot_hHandle The handle of the local screenshot.
|
||||
* @param filePrivacyState The privacy state of the screenshot file.
|
||||
* @returns a boolean value indicating whether the upload was successful.
|
||||
*/
|
||||
UploadLocalScreenshot(
|
||||
appId: string,
|
||||
localScreenshot_hHandle: number,
|
||||
filePrivacyState: EUCMFilePrivacyState,
|
||||
): Promise<boolean>;
|
||||
}
|
||||
|
||||
export interface Screenshot {
|
||||
nAppID: number;
|
||||
strGameID: string;
|
||||
hHandle: number;
|
||||
nWidth: number;
|
||||
nHeight: number;
|
||||
nCreated: number; // timestamp
|
||||
ePrivacy: EUCMFilePrivacyState;
|
||||
strCaption: string;
|
||||
bSpoilers: boolean;
|
||||
strUrl: string;
|
||||
bUploaded: boolean;
|
||||
ugcHandle: string;
|
||||
}
|
||||
|
||||
export interface ScreenshotToDelete {
|
||||
gameID: string;
|
||||
rgHandles: number[];
|
||||
}
|
||||
|
||||
export interface ScreenshotDeletionResponse {
|
||||
bSuccess: boolean;
|
||||
rgFailedRequestIndices: number[];
|
||||
}
|
||||
|
||||
export enum EUCMFilePrivacyState {
|
||||
Invalid = -1,
|
||||
Private = 1 << 1,
|
||||
FriendsOnly = 1 << 2,
|
||||
Public = 1 << 3,
|
||||
Unlisted = 1 << 4,
|
||||
}
|
||||
372
src/globals/steam-client/ServerBrowser.ts
Normal file
372
src/globals/steam-client/ServerBrowser.ts
Normal file
@@ -0,0 +1,372 @@
|
||||
import { OperationResponse, Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents functionality for the server browser.
|
||||
*/
|
||||
export interface ServerBrowser {
|
||||
/**
|
||||
* Adds a favorite server.
|
||||
* @param server The server to add.
|
||||
* @returns an empty string if successful, `Invalid/missing IPv4?` if failed.
|
||||
*/
|
||||
AddFavoriteServer(server: GameServer): Promise<string>;
|
||||
|
||||
/**
|
||||
* Adds a favorite server by IP.
|
||||
* @param ip The IP to add to favorite servers.
|
||||
* @returns an empty string if successful, localization string if failed.
|
||||
*/
|
||||
AddFavoriteServersByIP(ip: string): Promise<string>;
|
||||
|
||||
CancelServerQuery(dialogId: number, queryServer: number): void;
|
||||
|
||||
/**
|
||||
* Connects to a server from a given dialog.
|
||||
* @param dialogId The dialog ID to use.
|
||||
* @param password Server password, empty if none.
|
||||
* @returns a connection status.
|
||||
*/
|
||||
ConnectToServer(dialogId: number, password: string): Promise<EJoinServerError>;
|
||||
|
||||
/**
|
||||
* Creates a server info dialog for the server your friend is currently playing on.
|
||||
* @param pid 0
|
||||
* @param steamId A Steam64 ID of a friend.
|
||||
*/
|
||||
CreateFriendGameInfoDialog(pid: number, steamId: string): void;
|
||||
|
||||
/**
|
||||
* Creates a server info dialog.
|
||||
* @param ip The server IP.
|
||||
* @param port The server port.
|
||||
* @param queryPort
|
||||
* @returns the created dialog ID.
|
||||
*/
|
||||
CreateServerGameInfoDialog(ip: string, port: number, queryPort: number): Promise<number>;
|
||||
|
||||
/**
|
||||
* Retrieves the server list.
|
||||
* @param appId The game ID, 0 for every game.
|
||||
* @param queryType The tab to use.
|
||||
* @param filters Server filters.
|
||||
* @param serverCallback What to do with the found server?
|
||||
* @param requestCompletedCallback The callback function to be called when the request is completed.
|
||||
* @returns the current server list request ID.
|
||||
* @throws Throws if the query type is unknown.
|
||||
* @throws Throws if the filter list isn't key/value pairs, i.e. of an even length.
|
||||
* @remarks Stops at 10000 if there are more servers to be found.
|
||||
* @example
|
||||
* Filter examples, may be combined:
|
||||
* ```
|
||||
* [ 'gamedir', 'cstrike' ] // Doesn't work?
|
||||
* [ 'hasplayers', '1' ] // Only works with "1"?
|
||||
* [ 'notfull', '1' ] // Doesn't work?
|
||||
* [ 'map', 'cs_office' ] // Has to be an exact match!
|
||||
* ```
|
||||
*/
|
||||
|
||||
/*
|
||||
The enum in question:
|
||||
|
||||
(t =
|
||||
'lan' == this.id
|
||||
? this.all_servers.length > 0
|
||||
? '#ServerBrowser_NoServersMatch'
|
||||
: '#ServerBrowser_NoLanServers'
|
||||
: 'internet' == this.id
|
||||
? this.all_servers.length > 0
|
||||
? '#ServerBrowser_NoInternetGamesMatch'
|
||||
: e == l.zS.k_EServerFailedToRespond
|
||||
? '#ServerBrowser_MasterServerNotResponsive'
|
||||
: e == l.zS.k_ENoServersListedOnMasterServer
|
||||
? '#ServerBrowser_MasterServerHasNoServersListed'
|
||||
: '#ServerBrowser_NoInternetGamesResponded'
|
||||
: 'favorites' == this.id
|
||||
? this.all_servers.length > 0
|
||||
? '#ServerBrowser_NoServersMatch'
|
||||
: '#ServerBrowser_NoFavoriteServers'
|
||||
: 'history' == this.id
|
||||
? this.all_servers.length > 0
|
||||
? '#ServerBrowser_NoHistoryServersMatch'
|
||||
: '#ServerBrowser_NoServersPlayed'
|
||||
: 'friends' == this.id
|
||||
? this.all_servers.length > 0
|
||||
? '#ServerBrowser_NoServersMatch'
|
||||
: '#ServerBrowser_NoFriendsServers'
|
||||
: 'BUGBUG'),
|
||||
*/
|
||||
CreateServerListRequest(
|
||||
appId: number,
|
||||
queryType: ServerBrowserTab_t,
|
||||
filters: string[],
|
||||
serverCallback: (server: GameServer) => void,
|
||||
requestCompletedCallback: (response: number) => void,
|
||||
): Promise<number | OperationResponse>;
|
||||
|
||||
/**
|
||||
* Destroys the game info dialog functions (but not the window).
|
||||
* @param dialogId The dialog ID to use.
|
||||
* @remarks ServerBrowser.CancelServerQuery may throw if it tries to ping the server.
|
||||
*/
|
||||
DestroyGameInfoDialog(dialogId: number): void;
|
||||
|
||||
/**
|
||||
* Stops retrieving the server list.
|
||||
* @param activeServerListRequestId The active server request ID to use.
|
||||
*/
|
||||
DestroyServerListRequest(activeServerListRequestId: number): void;
|
||||
|
||||
/**
|
||||
* Gets a list of games that support the server browser feature.
|
||||
* @returns a list of games.
|
||||
*/
|
||||
GetMultiplayerGames(): Promise<ServerBrowserGame[]>;
|
||||
|
||||
/**
|
||||
* Gets the server browser preferences.
|
||||
* @returns server browser preferences.
|
||||
*/
|
||||
GetServerListPreferences(): Promise<ServerBrowserPreferences>;
|
||||
|
||||
/**
|
||||
* Pings the server of a specified dialog ID.
|
||||
* @param dialogId The dialog ID to use.
|
||||
*/
|
||||
PingServer(dialogId: number): Promise<number | OperationResponse>;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when a server gets added to favorite servers.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForFavorites(callback: (list: ServerBrowserFavoritesAndHistory) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when idk
|
||||
* @param dialogId The dialog ID to use.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForFriendGamePlayed(
|
||||
dialogId: number,
|
||||
callback: (server: ServerBrowserFriendServer) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when a server info dialog opens.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForGameInfoDialogs(callback: (dialogs: ServerBrowserDialog[]) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when player details get requested.
|
||||
* @param dialogId The dialog ID to use.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForPlayerDetails(
|
||||
dialogId: number,
|
||||
callback: (player: PlayerDetails) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when a server gets pinged.
|
||||
* @param dialogId The dialog ID to use.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForServerInfo(dialogId: number, callback: (server: GameServer) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Removes a server from favorite servers.
|
||||
* @param server The server to remove.
|
||||
*/
|
||||
RemoveFavoriteServer(server: GameServer): void;
|
||||
|
||||
/**
|
||||
* Removes a server from history of played servers.
|
||||
* @param server The server to remove.
|
||||
*/
|
||||
RemoveHistoryServer(server: GameServer): void;
|
||||
|
||||
/**
|
||||
* Requests player details for a specific dialog.
|
||||
* @param dialogId The dialog ID to use.
|
||||
*/
|
||||
RequestPlayerDetails(dialogId: number): Promise<number | OperationResponse>;
|
||||
|
||||
/**
|
||||
* Sets the server browser preferences.
|
||||
* @param prefs Server list preferences.
|
||||
*/
|
||||
SetServerListPreferences(prefs: ServerBrowserPreferences): void;
|
||||
}
|
||||
|
||||
|
||||
|
||||
export type ServerBrowserTab_t = 'internet' | 'favorites' | 'history' | 'lan' | 'friends';
|
||||
|
||||
export interface ServerBrowserGame {
|
||||
/** The ID of the game. */
|
||||
appid: number;
|
||||
/** The ID of the game. */
|
||||
gameid: string;
|
||||
/** The game folder. */
|
||||
gamedir: string;
|
||||
/** The game's name. */
|
||||
name: string;
|
||||
}
|
||||
|
||||
export interface ServerBrowserPreferences {
|
||||
GameList: string;
|
||||
filters: ServerBrowserTabFilters;
|
||||
}
|
||||
|
||||
export type ServerBrowserTabFilters = {
|
||||
[tab in ServerBrowserTab_t]: ServerBrowserGameFilter;
|
||||
};
|
||||
|
||||
export interface ServerBrowserGameFilter {
|
||||
/** Has users playing */
|
||||
NoEmpty: boolean;
|
||||
/** Server not full */
|
||||
NoFull: boolean;
|
||||
/** Is not password protected */
|
||||
NoPassword: boolean;
|
||||
/** Anti-cheat */
|
||||
Secure: EServerBrowserGameFilterAntiCheat;
|
||||
/** The ID of the game */
|
||||
appid: number;
|
||||
/** The game folder */
|
||||
game: string;
|
||||
/** Map filter */
|
||||
map: string;
|
||||
/** Latency */
|
||||
ping: EServerBrowserGameFilterPing;
|
||||
}
|
||||
|
||||
export enum EServerBrowserGameFilterAntiCheat {
|
||||
All,
|
||||
Secure,
|
||||
NotSecure,
|
||||
}
|
||||
|
||||
export enum EServerBrowserGameFilterPing {
|
||||
All,
|
||||
LessThan50 = 50,
|
||||
LessThan100 = 100,
|
||||
LessThan150 = 150,
|
||||
LessThan250 = 250,
|
||||
}
|
||||
|
||||
export interface ServerBrowserFavoritesAndHistory {
|
||||
favorites: GameServer[];
|
||||
history: GameServer[];
|
||||
}
|
||||
|
||||
export interface ServerBrowserFriendServer {
|
||||
/** The ID of the game. */
|
||||
appid: number;
|
||||
/** Non-Steam server? */
|
||||
bNonSteamServer: boolean;
|
||||
gameText: string;
|
||||
/** The ID of the game. */
|
||||
gameid: string;
|
||||
steamIDLobby: string;
|
||||
}
|
||||
|
||||
export interface ServerBrowserDialog {
|
||||
dialogID: number;
|
||||
ip: number;
|
||||
port: number;
|
||||
queryPort: number;
|
||||
}
|
||||
|
||||
export interface GameServer {
|
||||
/** The ID of the game. */
|
||||
appid: number;
|
||||
/** Do not refresh if had unsuccessful response? */
|
||||
bDoNotRefresh?: boolean;
|
||||
/** Found the server? */
|
||||
bHadSuccessfulResponse: boolean;
|
||||
/** Has password? */
|
||||
bPassword: boolean;
|
||||
/** Is VAC secured? */
|
||||
bSecure: boolean;
|
||||
/** How many bot players there currently are. */
|
||||
botPlayers: number;
|
||||
/** The server's game name/description. */
|
||||
gameDesc: string;
|
||||
/** The game folder. */
|
||||
gameDir: string;
|
||||
/** Server tags, separated by a comma. */
|
||||
gameTags: string;
|
||||
/** The server IP. */
|
||||
ip: string;
|
||||
/** Last time played as a UNIX timestamp. */
|
||||
lastPlayed: number;
|
||||
/** Current server map. */
|
||||
map: string;
|
||||
/** Max players on the server. */
|
||||
maxPlayers: number;
|
||||
/** The server name. */
|
||||
name: string;
|
||||
/** The latency to the server. */
|
||||
ping: number;
|
||||
/** How many players there currently are. */
|
||||
players: number;
|
||||
/** The server port. */
|
||||
port: number;
|
||||
queryPort: number;
|
||||
/** The server's game version it is running on. */
|
||||
serverVersion: number;
|
||||
/** Game server account ID. */
|
||||
steamID: string;
|
||||
}
|
||||
|
||||
export enum EJoinServerError {
|
||||
PingFailed = -3,
|
||||
Connecting,
|
||||
Pinging,
|
||||
None,
|
||||
VACBanned,
|
||||
ServerFull,
|
||||
ModNotInstalled,
|
||||
AppNotFound,
|
||||
NotInitialized,
|
||||
}
|
||||
|
||||
export interface PlayerDetails {
|
||||
/**
|
||||
* `true` is the server refresh is successful.
|
||||
*/
|
||||
bSuccess: boolean;
|
||||
|
||||
/**
|
||||
* `true` when the server refresh is done.
|
||||
*/
|
||||
bRefreshComplete: boolean;
|
||||
|
||||
/**
|
||||
* Player name.
|
||||
*
|
||||
* @note Defined when {@link bRefreshComplete} is `true`.
|
||||
*/
|
||||
playerName?: string;
|
||||
|
||||
/**
|
||||
* Player score.
|
||||
*
|
||||
* @note Defined when {@link bRefreshComplete} is `true`.
|
||||
*/
|
||||
score?: number;
|
||||
|
||||
/**
|
||||
* Time played on the server in seconds
|
||||
*
|
||||
* @note Defined when {@link bRefreshComplete} is `true`.
|
||||
*/
|
||||
timePlayed?: number;
|
||||
}
|
||||
|
||||
663
src/globals/steam-client/Settings.ts
Normal file
663
src/globals/steam-client/Settings.ts
Normal file
@@ -0,0 +1,663 @@
|
||||
import {CompatibilityTool as CompatibilityTool} from "./App";
|
||||
import { JsPbMessage, OperationResponse, Unregisterable } from "./shared";
|
||||
|
||||
export interface Settings {
|
||||
AddClientBeta(name: string, password: string): void;
|
||||
|
||||
/**
|
||||
* Clears HTTP cache located in `<STEAMPATH>/appcache/httpcache`.
|
||||
*/
|
||||
ClearAllHTTPCaches(): void;
|
||||
|
||||
/**
|
||||
* Clears download cache and logs you out.
|
||||
*/
|
||||
ClearDownloadCache(): void;
|
||||
|
||||
GetAccountSettings(): Promise<AccountSettings>;
|
||||
|
||||
GetAppUsesP2PVoice(appId: number): Promise<boolean>;
|
||||
|
||||
GetAvailableLanguages(): Promise<Language[]>;
|
||||
|
||||
GetAvailableTimeZones(): Promise<TimeZone[]>;
|
||||
|
||||
// Returns the current language "english"
|
||||
GetCurrentLanguage(): Promise<string>;
|
||||
|
||||
GetGlobalCompatTools(): Promise<CompatibilityTool[]>;
|
||||
|
||||
/**
|
||||
* @returns a ProtoBuf message. If deserialized, returns {@link MsgMonitorInfo}.
|
||||
*/
|
||||
GetMonitorInfo(): Promise<ArrayBuffer>;
|
||||
|
||||
GetOOBETestMode(): Promise<boolean>;
|
||||
|
||||
GetRegisteredSteamDeck(): Promise<RegisteredSteamDeck>;
|
||||
|
||||
// Returns the current timezone
|
||||
GetTimeZone(): Promise<string>;
|
||||
|
||||
GetWindowed(): Promise<boolean>;
|
||||
|
||||
IgnoreSteamDeckRewards(): void;
|
||||
|
||||
/**
|
||||
* Opens the Windows microphones dialog.
|
||||
*/
|
||||
OpenWindowsMicSettings(): void;
|
||||
|
||||
RegisterForMicVolumeUpdates: Unregisterable;
|
||||
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link MsgClientSettings}.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForSettingsArrayChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
RegisterForSettingsChanges(callback: (settings: SteamSettings) => void): Unregisterable;
|
||||
|
||||
RegisterForTimeZoneChange(callback: (timezoneId: string) => void): Unregisterable; // When timezone is changed from settings, callback will return new timezoneId
|
||||
ReinitMicSettings(): void;
|
||||
|
||||
RenderHotkey(event: KeyCaptureEvent): Promise<string>;
|
||||
|
||||
RequestDeviceAuthInfo(): void;
|
||||
|
||||
SelectClientBeta(nBetaID: number): void;
|
||||
|
||||
// Get from available languages
|
||||
SetCurrentLanguage(strShortName: string): void;
|
||||
|
||||
SetEnableSoftProcessKill(value: boolean): void; // Default value is false, this is Valve internal menu
|
||||
|
||||
SetHostname(hostname: string): void;
|
||||
|
||||
SetMicTestMode(value: boolean): void;
|
||||
|
||||
SetOOBETestMode(value: boolean): void;
|
||||
|
||||
SetPreferredMonitor(monitor: string): void;
|
||||
|
||||
SetRegisteredSteamDeck(steam64Id: string, serialNumber: string): void;
|
||||
|
||||
/**
|
||||
* Sets the "Don't save account credentials on this computer" option.
|
||||
* @param value Whether to save account credentials.
|
||||
*/
|
||||
SetSaveAccountCredentials(value: boolean): void;
|
||||
|
||||
/**
|
||||
* @param base64 Serialized base64 message from `CMsgClientSettings`.
|
||||
* @returns a boolean indicating whether the operation was successful.
|
||||
*/
|
||||
SetSetting(base64: string): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* You can get valid timezoneIds from {@link GetAvailableTimeZones}.
|
||||
*/
|
||||
SetTimeZone(timezoneId: string): void;
|
||||
|
||||
SetUseNintendoButtonLayout(controllerIndex: number, value: boolean): void;
|
||||
|
||||
SetUseUniversalFaceButtonGlyphs(nControllerIndex: number, value: boolean): void;
|
||||
|
||||
SetWindowed(value: boolean): void;
|
||||
|
||||
SpecifyGlobalCompatTool(strToolName: string): void;
|
||||
|
||||
ToggleSteamInstall(): Promise<OperationResponse>;
|
||||
}
|
||||
|
||||
export interface AccountSettings {
|
||||
strEmail: string;
|
||||
bEmailValidated: boolean;
|
||||
bHasAnyVACBans: boolean;
|
||||
bHasTwoFactor: boolean;
|
||||
eSteamGuardState: ESteamGuardState;
|
||||
rtSteamGuardEnableTime: number;
|
||||
bSaveAccountCredentials: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @todo unconfirmed, taken from localization strings
|
||||
*/
|
||||
export enum ESteamGuardState {
|
||||
EmailUnverified,
|
||||
Protected,
|
||||
Disabled,
|
||||
Offline,
|
||||
NotEnabled,
|
||||
}
|
||||
|
||||
export interface KeyCaptureEvent {
|
||||
alt_key: boolean;
|
||||
ctrl_key: boolean;
|
||||
display_name: string;
|
||||
meta_key: boolean;
|
||||
shift_key: boolean;
|
||||
}
|
||||
|
||||
export interface Language {
|
||||
language: ELanguage;
|
||||
strShortName: string;
|
||||
}
|
||||
|
||||
export enum ELanguage {
|
||||
None = -1,
|
||||
English,
|
||||
German,
|
||||
French,
|
||||
Italian,
|
||||
Korean,
|
||||
Spanish,
|
||||
SimplifiedChinese,
|
||||
TraditionalChinese,
|
||||
Russian,
|
||||
Thai,
|
||||
Japanese,
|
||||
Portuguese,
|
||||
Polish,
|
||||
Danish,
|
||||
Dutch,
|
||||
Finnish,
|
||||
Norwegian,
|
||||
Swedish,
|
||||
Hungarian,
|
||||
Czech,
|
||||
Romanian,
|
||||
Turkish,
|
||||
Brazilian,
|
||||
Bulgarian,
|
||||
Greek,
|
||||
Arabic,
|
||||
Ukrainian,
|
||||
LatamSpanish,
|
||||
Vietnamese,
|
||||
SteamChina_SChinese,
|
||||
Max,
|
||||
}
|
||||
export interface RegisteredSteamDeck {
|
||||
bRegistered: boolean;
|
||||
bIgnoreRegistrationPrompt: boolean;
|
||||
strSteamID: string;
|
||||
strSerialNumber: string;
|
||||
}
|
||||
|
||||
export interface TimeZone {
|
||||
utcOffset: number;
|
||||
timezoneID: string;
|
||||
timezoneLocalizationToken: string;
|
||||
regionsLocalizationToken: string;
|
||||
}
|
||||
|
||||
interface Region {
|
||||
nRegionID: number;
|
||||
strRegionName: string;
|
||||
}
|
||||
|
||||
interface Hour {
|
||||
nHour: number;
|
||||
strDisplay: string;
|
||||
}
|
||||
|
||||
interface AvailableClientBeta {
|
||||
nBetaID: number;
|
||||
strName: string;
|
||||
}
|
||||
|
||||
interface SteamSettings {
|
||||
bIsInClientBeta: boolean;
|
||||
bIsSteamSideload: boolean;
|
||||
eClientBetaState: EClientBetaState;
|
||||
strSelectedBetaName: string;
|
||||
nAvailableBetas: number;
|
||||
bChangeBetaEnabled: boolean;
|
||||
nSelectedBetaID: number;
|
||||
vecAvailableClientBetas: AvailableClientBeta[];
|
||||
bIsValveEmail: boolean;
|
||||
bIsInDesktopUIBeta: boolean;
|
||||
bEnableSoftProcessKill: boolean;
|
||||
vecValidDownloadRegions: Region[];
|
||||
vecValidAutoUpdateRestrictHours: Hour[];
|
||||
bCompatEnabled: boolean;
|
||||
bCompatEnabledForOtherTitles: boolean;
|
||||
strCompatTool: string;
|
||||
strDisplayName: string;
|
||||
bDisplayIsExternal: boolean;
|
||||
flAutoDisplayScaleFactor: number;
|
||||
flCurrentDisplayScaleFactor: number;
|
||||
bDisplayIsUsingAutoScale: boolean;
|
||||
flMinDisplayScaleFactor: number;
|
||||
flMaxDisplayScaleFactor: number;
|
||||
flCurrentUnderscanLevel: number;
|
||||
bUnderscanEnabled: boolean;
|
||||
vecNightModeScheduledHours: Hour[];
|
||||
}
|
||||
|
||||
export enum EClientBetaState {
|
||||
None,
|
||||
NoneChosen,
|
||||
NoneChosenNonAdmin,
|
||||
InBeta,
|
||||
InBetaNonAdmin,
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* CMsgMonitorInfo
|
||||
*/
|
||||
export interface MsgMonitorInfo extends JsPbMessage {
|
||||
monitors(): Monitor[];
|
||||
|
||||
selected_display_name(): string;
|
||||
|
||||
add_monitors(param0: any, param1: any): any;
|
||||
|
||||
set_monitors(param0: any): any;
|
||||
|
||||
set_selected_display_name(param0: any): any;
|
||||
}
|
||||
|
||||
/**
|
||||
* @todo Doesn't work on Linux ?
|
||||
*/
|
||||
export interface Monitor {
|
||||
monitor_device_name: string;
|
||||
monitor_display_name: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* CMsgClientSettings
|
||||
*/
|
||||
export interface MsgClientSettings extends JsPbMessage {
|
||||
always_show_user_chooser(): boolean;
|
||||
|
||||
always_use_gamepadui_overlay(): boolean;
|
||||
|
||||
auto_scale_factor(): number;
|
||||
|
||||
bigpicture_windowed(): boolean;
|
||||
|
||||
broadcast_bitrate(): number;
|
||||
|
||||
broadcast_chat_corner(): number;
|
||||
|
||||
broadcast_encoding_option(): EBroadcastEncoderSetting;
|
||||
|
||||
broadcast_output_height(): number;
|
||||
|
||||
broadcast_output_width(): number;
|
||||
|
||||
broadcast_permissions(): EBroadcastPermission;
|
||||
|
||||
broadcast_record_all_audio(): boolean;
|
||||
|
||||
broadcast_record_all_video(): boolean;
|
||||
|
||||
broadcast_record_microphone(): boolean;
|
||||
|
||||
broadcast_show_live_reminder(): boolean;
|
||||
|
||||
broadcast_show_upload_stats(): boolean;
|
||||
|
||||
cef_remote_debugging_enabled(): boolean;
|
||||
|
||||
cloud_enabled(): boolean;
|
||||
|
||||
controller_combine_nintendo_joycons(): boolean;
|
||||
controller_enable_chord(): boolean;
|
||||
|
||||
controller_generic_support(): boolean;
|
||||
|
||||
controller_guide_button_focus_steam(): boolean;
|
||||
|
||||
controller_poll_rate(): boolean;
|
||||
controller_power_off_timeout(): number;
|
||||
|
||||
controller_ps_support(): number;
|
||||
|
||||
controller_switch_support(): boolean;
|
||||
|
||||
controller_xbox_driver(): boolean;
|
||||
|
||||
controller_xbox_support(): boolean;
|
||||
|
||||
default_ping_rate(): number;
|
||||
|
||||
disable_all_toasts(): boolean;
|
||||
|
||||
disable_toasts_in_game(): boolean;
|
||||
|
||||
display_name(): string;
|
||||
|
||||
download_peer_content(): number;
|
||||
|
||||
download_rate_bits_per_s(): boolean;
|
||||
|
||||
download_region(): number;
|
||||
|
||||
download_throttle_rate(): number;
|
||||
|
||||
download_throttle_while_streaming(): boolean;
|
||||
|
||||
download_while_app_running(): boolean;
|
||||
|
||||
enable_avif_screenshots(): boolean;
|
||||
|
||||
enable_dpi_scaling(): boolean;
|
||||
|
||||
enable_gpu_accelerated_webviews(): boolean;
|
||||
|
||||
enable_hardware_video_decoding(): boolean;
|
||||
|
||||
enable_marketing_messages(): boolean;
|
||||
|
||||
enable_overlay(): boolean;
|
||||
|
||||
enable_screenshot_notification(): boolean;
|
||||
|
||||
enable_screenshot_sound(): boolean;
|
||||
|
||||
enable_shader_background_processing(): boolean;
|
||||
|
||||
enable_shader_precache(): boolean;
|
||||
|
||||
enable_ui_sounds(): boolean;
|
||||
|
||||
force_deck_perf_tab(): boolean;
|
||||
|
||||
force_fake_mandatory_update(): boolean;
|
||||
|
||||
force_oobe(): boolean;
|
||||
|
||||
g_background_audio(): EGRAudio;
|
||||
|
||||
g_background_a_m(): number;
|
||||
|
||||
g_background_a_s(): boolean;
|
||||
|
||||
g_background_path(): string;
|
||||
|
||||
g_background_max_keep(): string;
|
||||
|
||||
g_background_mode(): EGRMode;
|
||||
|
||||
g_background_time_resolution(): number;
|
||||
|
||||
g_background_mk(): CMsgHotkey;
|
||||
|
||||
g_background_tg(): CMsgHotkey;
|
||||
|
||||
g_max_fps(): number;
|
||||
|
||||
gamerecording_automatic_gain_control(): boolean;
|
||||
gamerecording_export_codec(): EExportCodec;
|
||||
gamerecording_export_directory(): number;
|
||||
gamerecording_export_limit_bitrate(): number;
|
||||
gamerecording_export_limit_frame_rate(): number;
|
||||
gamerecording_export_limit_height(): number;
|
||||
gamerecording_export_limit_size_mb(): number;
|
||||
gamerecording_export_limit_width(): number;
|
||||
gamerecording_export_limit_type(): EGRExportLimitType;
|
||||
gamerecording_force_mic_mono(): boolean;
|
||||
gamerecording_hotkey_ic(): CMsgHotkey;
|
||||
gamerecording_ic_seconds(): number;
|
||||
gamerecording_video_bitrate(): string;
|
||||
gamerecording_video_maxheight(): number;
|
||||
|
||||
game_notes_enable_spellcheck(): boolean;
|
||||
|
||||
gamescope_allow_tearing(): boolean;
|
||||
|
||||
gamescope_app_target_framerate(): number;
|
||||
|
||||
gamescope_composite_debug(): boolean;
|
||||
|
||||
gamescope_disable_framelimit(): boolean;
|
||||
|
||||
gamescope_disable_mura_correction(): boolean;
|
||||
|
||||
gamescope_display_refresh_rate(): number;
|
||||
|
||||
gamescope_enable_app_target_framerate(): boolean;
|
||||
|
||||
gamescope_force_composite(): boolean;
|
||||
|
||||
gamescope_hdr_visualization(): EHDRVisualization;
|
||||
|
||||
gamescope_include_steamui_in_screenshots(): boolean;
|
||||
|
||||
gamescope_use_game_refresh_rate_in_steam(): boolean;
|
||||
|
||||
gamestream_enable_video_h265(): boolean;
|
||||
gamestream_hardware_video_encode(): boolean;
|
||||
|
||||
hdr_compat_testing(): boolean;
|
||||
|
||||
in_client_beta(): boolean;
|
||||
|
||||
is_external_display(): boolean;
|
||||
|
||||
is_steam_sideloaded(): boolean;
|
||||
|
||||
jumplist_flags(): number;
|
||||
|
||||
library_disable_community_content(): boolean;
|
||||
|
||||
library_display_icon_in_game_list(): boolean;
|
||||
|
||||
library_display_size(): number;
|
||||
|
||||
library_low_bandwidth_mode(): boolean;
|
||||
|
||||
library_low_perf_mode(): boolean;
|
||||
|
||||
library_whats_new_show_only_product_updates(): boolean;
|
||||
|
||||
max_scale_factor(): number;
|
||||
|
||||
min_scale_factor(): number;
|
||||
|
||||
music_download_high_quality(): boolean;
|
||||
|
||||
music_pause_on_app_start(): boolean;
|
||||
|
||||
music_pause_on_voice_chat(): boolean;
|
||||
|
||||
music_playlist_notification(): boolean;
|
||||
|
||||
music_volume(): number;
|
||||
|
||||
needs_steam_service_repair(): boolean;
|
||||
|
||||
no_save_personal_info(): boolean;
|
||||
|
||||
oobe_test_mode_enabled(): boolean;
|
||||
|
||||
os_version_unsupported(): boolean;
|
||||
|
||||
overlay_fps_counter_corner(): number;
|
||||
|
||||
overlay_fps_counter_high_contrast(): boolean;
|
||||
|
||||
overlay_key(): CMsgHotkey;
|
||||
|
||||
overlay_restore_browser_tabs(): boolean;
|
||||
|
||||
overlay_scale_interface(): boolean;
|
||||
|
||||
overlay_tabs(): string;
|
||||
|
||||
overlay_toolbar_list_view(): boolean;
|
||||
|
||||
override_browser_composer_mode(): number;
|
||||
|
||||
play_sound_on_toast(): boolean;
|
||||
|
||||
preferred_monitor(): string;
|
||||
|
||||
ready_to_play_includes_streaming(): boolean;
|
||||
|
||||
restrict_auto_updates(): boolean;
|
||||
|
||||
restrict_auto_updates_end(): number;
|
||||
|
||||
restrict_auto_updates_start(): number;
|
||||
|
||||
run_at_startup(): boolean;
|
||||
|
||||
save_uncompressed_screenshots(): boolean;
|
||||
|
||||
screenshot_items_per_row(): number;
|
||||
|
||||
screenshot_key(): CMsgHotkey;
|
||||
|
||||
screenshots_path(): string;
|
||||
|
||||
server_ping_rate(): number;
|
||||
|
||||
setting_validation_bool(): boolean;
|
||||
|
||||
setting_validation_enum(): EHDRVisualization;
|
||||
|
||||
setting_validation_int32(): number;
|
||||
|
||||
setting_validation_uint32(): number;
|
||||
|
||||
setting_validation_uint64(): number;
|
||||
|
||||
setting_validation_float(): number;
|
||||
|
||||
setting_validation_string(): string;
|
||||
|
||||
shader_precached_size(): string;
|
||||
|
||||
show_copy_count_in_library(): boolean;
|
||||
|
||||
show_family_sharing_notifications(): boolean;
|
||||
|
||||
show_screenshot_manager(): boolean;
|
||||
|
||||
show_steam_deck_info(): boolean;
|
||||
|
||||
show_store_content_on_home(): boolean;
|
||||
|
||||
show_timestamps_in_console(): boolean;
|
||||
|
||||
skip_steamvr_install_dialog(): boolean;
|
||||
|
||||
small_mode(): boolean;
|
||||
|
||||
smooth_scroll_webviews(): boolean;
|
||||
|
||||
start_in_big_picture_mode(): boolean;
|
||||
|
||||
start_page(): string;
|
||||
|
||||
startup_movie_id(): string;
|
||||
|
||||
startup_movie_local_path(): string;
|
||||
|
||||
startup_movie_shuffle(): boolean;
|
||||
|
||||
startup_movie_used_for_resume(): boolean;
|
||||
|
||||
steam_cef_gpu_blocklist_disabled(): boolean;
|
||||
|
||||
steam_input_configurator_error_msg_enable(): boolean;
|
||||
|
||||
steam_networking_share_ip(): number;
|
||||
|
||||
steam_os_underscan_enabled(): boolean;
|
||||
|
||||
steam_os_underscan_level(): number;
|
||||
|
||||
steamos_cec_enabled(): boolean;
|
||||
|
||||
steamos_cec_wake_on_resume(): boolean;
|
||||
|
||||
steamos_magnifier_scale(): number;
|
||||
|
||||
steamos_status_led_brightness(): number;
|
||||
|
||||
steamos_tdp_limit(): number;
|
||||
|
||||
steamos_tdp_limit_enabled(): boolean;
|
||||
|
||||
steamos_wifi_debug(): boolean;
|
||||
|
||||
steamos_wifi_force_wpa_supplicant(): boolean;
|
||||
|
||||
system_bluetooth_enabled(): boolean;
|
||||
|
||||
turn_off_controller_on_exit(): boolean;
|
||||
|
||||
voice_mic_device_name(): string;
|
||||
|
||||
voice_mic_input_gain(): number;
|
||||
|
||||
voice_push_to_talk_key(): CMsgHotkey;
|
||||
|
||||
voice_push_to_talk_setting(): number;
|
||||
|
||||
voice_speaker_output_gain(): number;
|
||||
|
||||
web_browser_home(): string;
|
||||
}
|
||||
|
||||
export interface CMsgHotkey extends JsPbMessage {
|
||||
key_code(): number;
|
||||
alt_key(): boolean;
|
||||
shift_key(): boolean;
|
||||
ctrl_key(): boolean;
|
||||
meta_key(): boolean;
|
||||
display_name(): string;
|
||||
}
|
||||
|
||||
export enum EBroadcastEncoderSetting {
|
||||
BestQuality,
|
||||
BestPerformance,
|
||||
}
|
||||
|
||||
export enum EBroadcastPermission {
|
||||
Disabled,
|
||||
FriendsApprove,
|
||||
FriendsAllowed,
|
||||
Public,
|
||||
Subscribers,
|
||||
}
|
||||
|
||||
export enum EExportCodec {
|
||||
Default,
|
||||
H264,
|
||||
H265,
|
||||
}
|
||||
|
||||
export enum EGRAudio {
|
||||
Game,
|
||||
System,
|
||||
Select,
|
||||
}
|
||||
|
||||
export enum EGRExportLimitType {
|
||||
Native,
|
||||
FileSize,
|
||||
Advanced,
|
||||
}
|
||||
|
||||
export enum EGRMode {
|
||||
Never,
|
||||
Always,
|
||||
Manual,
|
||||
}
|
||||
|
||||
export enum EHDRVisualization {
|
||||
None,
|
||||
Heatmap,
|
||||
Analysis,
|
||||
HeatmapExtended,
|
||||
HeatmapClassic,
|
||||
}
|
||||
43
src/globals/steam-client/SharedConnection.ts
Normal file
43
src/globals/steam-client/SharedConnection.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
import { ESteamRealm, Unregisterable } from "./shared";
|
||||
|
||||
/**
|
||||
* `hSharedConnection` is the number from {@link AllocateSharedConnection}.
|
||||
*/
|
||||
export interface SharedConnection {
|
||||
AllocateSharedConnection(): Promise<number>;
|
||||
|
||||
// if no such number, sends this warning:
|
||||
// src\clientdll\clientsharedconnection.cpp (154) : m_mapSharedConnections.HasElement( hSharedConnection )
|
||||
Close(hSharedConnection: number): void;
|
||||
|
||||
RegisterOnBinaryMessageReceived(hSharedConnection: number, callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
RegisterOnLogonInfoChanged(hSharedConnection: number, callback: (info: LogonInfo) => void): Unregisterable;
|
||||
|
||||
RegisterOnMessageReceived(hSharedConnection: number, callback: (param0: any) => void): Unregisterable;
|
||||
|
||||
SendMsg: any;
|
||||
SendMsgAndAwaitBinaryResponse: any;
|
||||
|
||||
SendMsgAndAwaitResponse(hSharedConnection: number, msg: string): Promise<any>;
|
||||
|
||||
SubscribeToClientServiceMethod(hSharedConnection: number, param1: any): any;
|
||||
|
||||
SubscribeToEMsg(hSharedConnection: number, param1: any): any;
|
||||
}
|
||||
|
||||
export interface LogonInfo {
|
||||
/** `true` if logged on. */
|
||||
bLoggedOn: boolean;
|
||||
eUniverse: ESteamRealm;
|
||||
/** Account username. Empty if not logged on. */
|
||||
strAccountName: string;
|
||||
/** URL for community content. */
|
||||
strCommunityImagesURL: string;
|
||||
/** Account nickname. Empty if not logged on. */
|
||||
strPersonaName: string;
|
||||
/** Steam64 ID. */
|
||||
strSteamid: string;
|
||||
/** Country code. */
|
||||
strUserCountry: string;
|
||||
}
|
||||
10
src/globals/steam-client/Stats.ts
Normal file
10
src/globals/steam-client/Stats.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
export interface Stats {
|
||||
// param0 - AppDetailsReviewSection, Showcases, LibraryReviewSpotlight
|
||||
// param1 -
|
||||
// AppDetailsReviewSection: PositiveClicked, NegativeClicked, NeutralClicked, PositiveReviewPosted, NegativeReviewPosted, EditClicked, ReviewCanceled
|
||||
// LibraryReviewSpotlight: ReviseClicked, PositiveClicked, ReviseCloseClicked, NegativeClicked, PositiveRevisePosted, NegativeRevisePosted, ReviseCanceled, ReviewCanceled, CloseClicked
|
||||
// Showcases: Delete, Save-Modify, Save-New
|
||||
RecordActivationEvent(param0: string, param1: string): void;
|
||||
|
||||
RecordDisplayEvent(param0: boolean, param1: string, param2: string): void;
|
||||
}
|
||||
3
src/globals/steam-client/SteamChina.ts
Normal file
3
src/globals/steam-client/SteamChina.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
export interface SteamChina {
|
||||
GetCustomLauncherAppID(): Promise<number>;
|
||||
}
|
||||
24
src/globals/steam-client/Storage.ts
Normal file
24
src/globals/steam-client/Storage.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
import { OperationResponse } from "./shared";
|
||||
|
||||
/**
|
||||
* SteamClient.MachineStorage affects the "STEAMPATH/config/config.vdf" file.
|
||||
* SteamClient.RoamingStorage affects the "STEAMPATH/userdata/STEAMID3/7/remote/sharedconfig.vdf" file.
|
||||
* SteamClient.Storage affects the "STEAMPATH/userdata/STEAMID3/config/localconfig.vdf" file.
|
||||
*/
|
||||
export interface Storage {
|
||||
DeleteKey(key: string): Promise<OperationResponse | undefined>;
|
||||
|
||||
/**
|
||||
* @remarks Use {@link SetObject} to set.
|
||||
*/
|
||||
GetJSON(key: string): Promise<OperationResponse | string>;
|
||||
|
||||
GetString(key: string): Promise<OperationResponse | string>;
|
||||
|
||||
/**
|
||||
* @remarks Use {@link SetObject} to get.
|
||||
*/
|
||||
SetObject(key: string, value: object): Promise<OperationResponse | undefined>;
|
||||
|
||||
SetString(key: string, value: string): Promise<OperationResponse | undefined>;
|
||||
}
|
||||
59
src/globals/steam-client/Streaming.ts
Normal file
59
src/globals/steam-client/Streaming.ts
Normal file
@@ -0,0 +1,59 @@
|
||||
import { EResult, Unregisterable } from "./shared";
|
||||
import {LaunchOption} from "./App";
|
||||
|
||||
export interface Streaming {
|
||||
AcceptStreamingEULA(appId: number, id: string, version: number): void;
|
||||
|
||||
CancelStreamGame(): void; // existing stream
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the streaming client finishes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStreamingClientFinished(callback: (code: EResult, result: string) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when there is progress in the launch of the streaming client.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStreamingClientLaunchProgress(
|
||||
callback: (actionType: string, taskDetails: string, done: number, total: number) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the streaming client is started (e.g., when clicking the stream button).
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStreamingClientStarted(callback: (appId: number) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the streaming launch is complete.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStreamingLaunchComplete(callback: (code: EResult, result: string) => void): Unregisterable;
|
||||
|
||||
RegisterForStreamingShowEula(callback: (appId: number) => void): Unregisterable;
|
||||
|
||||
RegisterForStreamingShowIntro(callback: (appId: number, param: string) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the streaming client receives launch options from the host.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStreamingShowLaunchOptions(
|
||||
callback: (appId: number, launchOptions: LaunchOption[]) => void,
|
||||
): Unregisterable; // Callback when streaming client receives launch options from host
|
||||
|
||||
StreamingContinueStreamGame(): void; // existing game running on another streaming capable device
|
||||
|
||||
/**
|
||||
* Chooses the launch option for the streamed app by its index
|
||||
* and restarts the stream.
|
||||
*/
|
||||
StreamingSetLaunchOption(index: number): void;
|
||||
}
|
||||
90
src/globals/steam-client/UI.ts
Normal file
90
src/globals/steam-client/UI.ts
Normal file
@@ -0,0 +1,90 @@
|
||||
import { EUIMode, Unregisterable } from "./shared";
|
||||
import {EOSType} from "./system";
|
||||
|
||||
export interface UI {
|
||||
EnsureMainWindowCreated(): void;
|
||||
|
||||
ExitBigPictureMode(): void;
|
||||
|
||||
GetDesiredSteamUIWindows(): Promise<SteamWindow[]>;
|
||||
|
||||
/**
|
||||
* Gets information about whether your OS will be unsupported in the future or not.
|
||||
*/
|
||||
GetOSEndOfLifeInfo(): Promise<OSEndOfLifeInfo>;
|
||||
|
||||
/**
|
||||
* Retrieves the current UI mode.
|
||||
* @returns the current UI mode.
|
||||
*/
|
||||
GetUIMode(): Promise<EUIMode>;
|
||||
|
||||
NotifyAppInitialized(): void;
|
||||
|
||||
RegisterDesiredSteamUIWindowsChanged(callback: () => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when a convar's value gets changed.
|
||||
*
|
||||
* Hard crashes if such a convar does not exist or if you can't set it.
|
||||
*
|
||||
* @param convar The ConVar to watch.
|
||||
* @param callback The callback function to be called.
|
||||
*/
|
||||
RegisterForClientConVar(convar: string, callback: (value: string) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @todo param{0,1} are enums
|
||||
*/
|
||||
RegisterForErrorCondition(callback: (param0: number, param1: number) => void): Unregisterable;
|
||||
|
||||
RegisterForKioskModeResetSignal(callback: () => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @todo This fires multiple times.
|
||||
*/
|
||||
RegisterForStartupFinished(callback: () => void): Unregisterable;
|
||||
|
||||
RegisterForUIModeChanged(callback: (mode: EUIMode) => void): Unregisterable;
|
||||
|
||||
ResetErrorCondition(): void;
|
||||
|
||||
/**
|
||||
* Sets the UI mode to the specified value.
|
||||
* @param mode The UI mode to set.
|
||||
*/
|
||||
SetUIMode(mode: EUIMode): void;
|
||||
}
|
||||
|
||||
export enum EWindowType {
|
||||
MainGamepadUI,
|
||||
OverlayGamepadUI,
|
||||
Keyboard,
|
||||
ControllerConfigurator,
|
||||
VR,
|
||||
MainDesktopUI,
|
||||
DesktopLogin,
|
||||
OverlayDesktopUI,
|
||||
SteamChinaReviewLauncher,
|
||||
}
|
||||
|
||||
export interface OSEndOfLifeInfo {
|
||||
bOSWillBeUnsupported: boolean;
|
||||
osType: EOSType;
|
||||
}
|
||||
|
||||
/**
|
||||
* The following might have more correct information:
|
||||
* https://github.com/SteamDatabase/SteamTracking/blob/master/Protobufs/webuimessages_sharedjscontext.proto
|
||||
*/
|
||||
export interface SteamWindow {
|
||||
appid: number;
|
||||
hwndParent: number;
|
||||
nBrowserID: number;
|
||||
strAppName: string;
|
||||
unID: number;
|
||||
unPID: number;
|
||||
windowType: EWindowType;
|
||||
x: number;
|
||||
y: number;
|
||||
}
|
||||
174
src/globals/steam-client/URL.ts
Normal file
174
src/globals/steam-client/URL.ts
Normal file
@@ -0,0 +1,174 @@
|
||||
import { Unregisterable } from "./shared";
|
||||
|
||||
export interface URL {
|
||||
/**
|
||||
* Executes a steam:// URL.
|
||||
* @param url The URL to execute.
|
||||
*/
|
||||
ExecuteSteamURL(url: string): void;
|
||||
|
||||
/**
|
||||
* @param urls Additional URLs to get. May be empty.
|
||||
*/
|
||||
GetSteamURLList(urls: SteamWebURL_t[]): Promise<SteamURLs>;
|
||||
|
||||
GetWebSessionID(): Promise<string>;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when a steam:// URL gets executed.
|
||||
* @param section `rungameid`, `open`, etc.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForRunSteamURL(section: string, callback: (param0: number, url: string) => void): Unregisterable;
|
||||
|
||||
RegisterForSteamURLChanges(callback: () => void): void;
|
||||
}
|
||||
|
||||
export type SteamWebURL_t =
|
||||
| "AllNotifications"
|
||||
| "AppHoverPublic"
|
||||
| "AppHoverPublicFull"
|
||||
| "AppNewsPage"
|
||||
| "AsyncGames"
|
||||
| "AvatarBaseURL"
|
||||
| "BaseURLSharedCDN"
|
||||
| "Chat"
|
||||
| "ChatRoot"
|
||||
| "ClaimEntitlements"
|
||||
| "ClanAssetCDN"
|
||||
| "CommentNotifications"
|
||||
| "CommunityHome"
|
||||
| "CommunityAddFriends"
|
||||
| "CommunityCDN"
|
||||
| "CommunityFilePage"
|
||||
| "CommunityFriendsThatPlay"
|
||||
| "CommunityFrontPage"
|
||||
| "CommunityGroupSearch"
|
||||
| "CommunityImages"
|
||||
| "CommunityInventory"
|
||||
| "CommunityMarket"
|
||||
| "CommunityMarketApp"
|
||||
| "CommunityRecommendations"
|
||||
| "CommunityScreenshots"
|
||||
| "CommunitySingleScreenshot"
|
||||
| "CurrentlyPlayedWith"
|
||||
| "EventAnnouncementPage"
|
||||
| "FamilyManagement"
|
||||
| "FamilySharing"
|
||||
| "GameHub"
|
||||
| "GameHubBroadcasts"
|
||||
| "GameHubDiscussions"
|
||||
| "GameHubGuides"
|
||||
| "GameHubNews"
|
||||
| "GameHubReviews"
|
||||
| "GlobalAchievementStatsPage"
|
||||
| "GlobalLeaderboardsPage"
|
||||
| "GroupSteamIDPage"
|
||||
| "HardwareSurvey"
|
||||
| "HelpAppPage"
|
||||
| "HelpChangeEmail"
|
||||
| "HelpChangePassword"
|
||||
| "HelpFAQ"
|
||||
| "HelpFrontPage"
|
||||
| "HelpWithLogin"
|
||||
| "HelpWithLoginInfo"
|
||||
| "HelpWithSteamGuardCode"
|
||||
| "HelpVacBans"
|
||||
| "ItemStorePage"
|
||||
| "ItemStoreDetailPage"
|
||||
| "JoinTrade"
|
||||
| "LegalInformation"
|
||||
| "LibraryAppDetails"
|
||||
| "LibraryAppReview"
|
||||
| "LibraryFeaturedBroadcasts"
|
||||
| "ManageGiftsPage"
|
||||
| "ManageSteamGuard"
|
||||
| "ModeratorMessages"
|
||||
| "Mobile"
|
||||
| "MyHelpRequests"
|
||||
| "OfficialGameGroupPage"
|
||||
| "NewsHomePage"
|
||||
| "ParentalBlocked"
|
||||
| "ParentalSetup"
|
||||
| "PendingFriends"
|
||||
| "PendingGift"
|
||||
| "PointsShop"
|
||||
| "PrivacyPolicy"
|
||||
| "RecommendGame"
|
||||
| "RedeemWalletVoucher"
|
||||
| "RegisterKey"
|
||||
| "RegisterKeyNoParams"
|
||||
| "SSA"
|
||||
| "SteamAnnouncements"
|
||||
| "SteamClientBetaBugReports"
|
||||
| "SteamClientBetaNewsPage"
|
||||
| "SteamClientBetaNewsPageFancy"
|
||||
| "SteamClientNewsPage"
|
||||
| "SteamClientPatchNotes"
|
||||
| "SteamClientBetaPatchNotes"
|
||||
| "SteamDiscussions"
|
||||
| "SteamIDAchievementsPage"
|
||||
| "SteamIDAppTradingCardsPage"
|
||||
| "SteamIDBadgeInfo"
|
||||
| "SteamIDBadgePage"
|
||||
| "SteamIDBroadcastPage"
|
||||
| "SteamIDEditPage"
|
||||
| "SteamIDEditPrivacyPage"
|
||||
| "SteamIDFriendsList"
|
||||
| "SteamIDFriendsPage"
|
||||
| "SteamIDGroupsPage"
|
||||
| "SteamIDMyProfile"
|
||||
| "SteamIDPage"
|
||||
| "SteamLanguage"
|
||||
| "SteamPreferences"
|
||||
| "SteamVRHMDHelp"
|
||||
| "SteamWorkshop"
|
||||
| "SteamWorkshopPage"
|
||||
| "SteamWorkshopSubscriptions"
|
||||
| "SteamWorkshopUpdatedSubscriptions"
|
||||
| "StoreAccount"
|
||||
| "StoreAddFundsPage"
|
||||
| "StoreAppHover"
|
||||
| "StoreAppImages"
|
||||
| "StoreAppPage"
|
||||
| "StoreAppPageAddToCart"
|
||||
| "StoreCart"
|
||||
| "StoreCDN"
|
||||
| "StoreDlcPage"
|
||||
| "StoreExplore"
|
||||
| "StoreExploreNew"
|
||||
| "StoreFreeToPlay"
|
||||
| "StoreFrontPage"
|
||||
| "StoreGameSearchPage"
|
||||
| "StoreGreatOnDeck"
|
||||
| "StorePublisherPage"
|
||||
| "StoreSpecials"
|
||||
| "StoreStats"
|
||||
| "StoreVR"
|
||||
| "StoreWebMicroTxnPage"
|
||||
| "SupportMessages"
|
||||
| "TextFilterSettings"
|
||||
| "TodayPage"
|
||||
| "TradeOffers"
|
||||
| "VideoCDN"
|
||||
| "UserAchievementsPage"
|
||||
| "UserLeaderboardsPage"
|
||||
| "UserStatsPage"
|
||||
| "UserWishlist"
|
||||
| "WatchVideo"
|
||||
| "WebAPI"
|
||||
| "WorkshopEula"
|
||||
| "YearInReview";
|
||||
|
||||
export interface SteamURL {
|
||||
url: string;
|
||||
/**
|
||||
* @todo enum?
|
||||
*/
|
||||
feature: number;
|
||||
}
|
||||
|
||||
export type SteamURLs = {
|
||||
[url in SteamWebURL_t]: SteamURL;
|
||||
}
|
||||
101
src/globals/steam-client/Updates.ts
Normal file
101
src/globals/steam-client/Updates.ts
Normal file
@@ -0,0 +1,101 @@
|
||||
import { EResult, JsPbMessage, OperationResponse, Unregisterable } from "./shared";
|
||||
|
||||
export interface Updates {
|
||||
/**
|
||||
* @param base64 Serialized base64 message from `CMsgSystemUpdateApplyParams`.
|
||||
*/
|
||||
ApplyUpdates(base64: string): Promise<OperationResponse>;
|
||||
|
||||
CheckForUpdates(): Promise<OperationResponse>; // Checks for software updates
|
||||
|
||||
GetCurrentOSBranch(): Promise<OSBranch>;
|
||||
|
||||
GetOSBranchList(): Promise<any[]>;
|
||||
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link MsgSystemUpdateState}.
|
||||
* @returns a ProtoBuf message.
|
||||
*/
|
||||
RegisterForUpdateStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @param base64 Serialized base64 message from `CMsgSelectOSBranchParams`.
|
||||
*/
|
||||
SelectOSBranch(base64: string): Promise<OperationResponse>;
|
||||
}
|
||||
|
||||
|
||||
export interface OSBranch {
|
||||
eBranch: EOSBranch; // 1 - Stable
|
||||
sRawName: string;
|
||||
}
|
||||
|
||||
export enum EOSBranch {
|
||||
Unknown,
|
||||
Release,
|
||||
ReleaseCandidate,
|
||||
Beta,
|
||||
BetaCandidate,
|
||||
Preview,
|
||||
PreviewCandidate,
|
||||
Main,
|
||||
Staging,
|
||||
}
|
||||
|
||||
/**
|
||||
* CMsgSystemUpdateState
|
||||
*/
|
||||
export interface MsgSystemUpdateState extends JsPbMessage {
|
||||
state(): EUpdaterState | undefined;
|
||||
|
||||
progress(): UpdateProgress | undefined;
|
||||
|
||||
supports_os_updates(): boolean | undefined;
|
||||
|
||||
update_apply_results(): UpdateApplyResult[];
|
||||
|
||||
update_check_results(): UpdateCheckResult[];
|
||||
}
|
||||
|
||||
export interface UpdateApplyResult {
|
||||
type: EUpdaterType;
|
||||
eresult: EResult;
|
||||
requires_client_restart: boolean;
|
||||
requires_system_restart: boolean;
|
||||
}
|
||||
|
||||
export interface UpdateCheckResult {
|
||||
type: EUpdaterType;
|
||||
eresult: EResult;
|
||||
rtime_checked: number;
|
||||
available: boolean;
|
||||
}
|
||||
|
||||
export interface UpdateProgress {
|
||||
stage_progress: number | undefined;
|
||||
stage_size_bytes: number | undefined;
|
||||
rtime_estimated_completion: number | undefined;
|
||||
}
|
||||
|
||||
export enum EUpdaterState {
|
||||
Invalid,
|
||||
// ty valve
|
||||
UpToDate = 2,
|
||||
Checking,
|
||||
Available,
|
||||
Applying,
|
||||
ClientRestartPending,
|
||||
SystemRestartPending,
|
||||
RollBack,
|
||||
}
|
||||
|
||||
export enum EUpdaterType {
|
||||
Invalid,
|
||||
Client,
|
||||
OS,
|
||||
BIOS,
|
||||
Aggregated,
|
||||
Test1,
|
||||
Test2,
|
||||
Dummy,
|
||||
}
|
||||
266
src/globals/steam-client/User.ts
Normal file
266
src/globals/steam-client/User.ts
Normal file
@@ -0,0 +1,266 @@
|
||||
import { EResult, OperationResponse, Unregisterable } from "./shared";
|
||||
|
||||
export interface User {
|
||||
AuthorizeMicrotxn(txnId: number | string): void;
|
||||
|
||||
CancelLogin(): void;
|
||||
|
||||
CancelMicrotxn(txnId: number | string): void;
|
||||
|
||||
/**
|
||||
* Tries to cancel Steam shutdown.
|
||||
* @remarks Used in the "Shutting down" dialog.
|
||||
*/
|
||||
CancelShutdown(): void;
|
||||
|
||||
/**
|
||||
* Opens the "Change Account" dialog.
|
||||
*/
|
||||
ChangeUser(): void;
|
||||
|
||||
Connect(): Promise<OperationResponse>;
|
||||
|
||||
FlipToLogin(): void;
|
||||
|
||||
/**
|
||||
* Forces a shutdown while shutting down.
|
||||
* @remarks Used in the "Shutting down" dialog.
|
||||
*/
|
||||
ForceShutdown(): void;
|
||||
|
||||
/**
|
||||
* Forgets an account's password.
|
||||
* @param accountName Login of the account to forget.
|
||||
* @returns a boolean indicating whether the operation succeeded or not.
|
||||
*/
|
||||
ForgetPassword(accountName: string): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Gets your country code.
|
||||
* @returns a string containing your country code.
|
||||
*/
|
||||
GetIPCountry(): Promise<string>;
|
||||
|
||||
/**
|
||||
* @todo param0 mirrors param3 of {@link RegisterForLoginStateChange}
|
||||
*/
|
||||
GetLoginProgress(callback: (param0: number, param1: number) => void): Unregisterable;
|
||||
|
||||
GetLoginUsers(): Promise<LoginUser[]>;
|
||||
|
||||
GoOffline(): void;
|
||||
|
||||
GoOnline(): void;
|
||||
|
||||
OptOutOfSurvey(): void;
|
||||
|
||||
PrepareForSystemSuspend(): Promise<{
|
||||
result: EResult;
|
||||
}>;
|
||||
|
||||
Reconnect(): void;
|
||||
|
||||
RegisterForConnectionAttemptsThrottled(callback: (data: ConnectionAttempt) => void): Unregisterable;
|
||||
|
||||
RegisterForCurrentUserChanges(callback: (user: CurrentUser) => void): void;
|
||||
|
||||
RegisterForLoginStateChange(
|
||||
callback: (
|
||||
/**
|
||||
* Empty if not logged in.
|
||||
*/
|
||||
accountName: string,
|
||||
state: ELoginState,
|
||||
result: EResult,
|
||||
param3: number,
|
||||
percentage: number,
|
||||
/**
|
||||
* @todo name is from CLoginStore, but it's always empty, unused ?
|
||||
*/
|
||||
emailDomain: string,
|
||||
) => void
|
||||
): Unregisterable;
|
||||
|
||||
RegisterForPrepareForSystemSuspendProgress(callback: (progress: SuspendProgress) => void): Unregisterable;
|
||||
|
||||
RegisterForResumeSuspendedGamesProgress(callback: (progress: SuspendProgress) => void): Unregisterable;
|
||||
|
||||
RegisterForShowHardwareSurvey(callback: () => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Register a function to be executed when shutdown completes.
|
||||
* @param callback The function to be executed on completion.
|
||||
*/
|
||||
RegisterForShutdownDone(callback: (state: EShutdownStep, appid: number, param2: boolean) => void): Unregisterable;
|
||||
|
||||
RegisterForShutdownFailed(callback: (state: EShutdownStep, appid: number, success: boolean) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Register a function to be executed when Steam starts shutting down.
|
||||
* @param callback The function to be executed on shutdown start.
|
||||
*/
|
||||
RegisterForShutdownStart(callback: (param0: boolean) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Register a function to be executed when shutdown state changes.
|
||||
* @param callback The function to be executed on change.
|
||||
*/
|
||||
RegisterForShutdownState(callback: (state: EShutdownStep, appid: number, allowForceQuit: boolean) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Removes an account from remembered users.
|
||||
* @param accountName The account to remove.
|
||||
*/
|
||||
RemoveUser(accountName: string): void;
|
||||
|
||||
RequestSupportSystemReport(reportId: string): Promise<{
|
||||
bSuccess: boolean;
|
||||
}>;
|
||||
|
||||
ResumeSuspendedGames(param0: boolean): Promise<ResumeSuspendedGamesResult>;
|
||||
|
||||
// Hardware survey information
|
||||
RunSurvey(callback: (surveySections: SurveySection[]) => void): void;
|
||||
|
||||
SendSurvey(): void;
|
||||
|
||||
SetAsyncNotificationEnabled(appId: number, enable: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets given login credentials, but don't log in to that account.
|
||||
* @param accountName Account name.
|
||||
* @param password Account password.
|
||||
* @param rememberMe Whether to remember that account.
|
||||
*/
|
||||
SetLoginCredentials(accountName: string, password: string, rememberMe: boolean): void;
|
||||
|
||||
SetOOBEComplete(): void;
|
||||
|
||||
ShouldShowUserChooser(): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Signs out and restarts Steam.
|
||||
*/
|
||||
SignOutAndRestart(): void;
|
||||
|
||||
/**
|
||||
* Relogin after disabling offline mode. Not sure what else it's useful for,
|
||||
* there isn't even a single mention of it in steam's js, lol
|
||||
*/
|
||||
StartLogin(): void;
|
||||
|
||||
/**
|
||||
* Toggles offline mode.
|
||||
*
|
||||
* Note that after disabling offline mode, you have to relogin with
|
||||
* {@link StartLogin}.
|
||||
*/
|
||||
StartOffline(value: boolean): void;
|
||||
|
||||
/**
|
||||
* Restarts the Steam client.
|
||||
*
|
||||
* @todo I don't remember what the arg is, but IIRC with `true` it disables
|
||||
* some ldd check or whatever, really it's only noticeable on slow PCs.
|
||||
*/
|
||||
StartRestart(force: boolean): void;
|
||||
|
||||
/**
|
||||
* @todo I don't remember what the arg is, but IIRC with `true` it disables
|
||||
* some ldd check or whatever, really it's only noticeable on slow PCs.
|
||||
*/
|
||||
StartShutdown(force: boolean): void;
|
||||
}
|
||||
|
||||
export interface ConnectionAttempt {
|
||||
rtCooldownExpiration: number;
|
||||
}
|
||||
|
||||
export interface CurrentUser {
|
||||
NotificationCounts: {
|
||||
async_game_updates: number;
|
||||
comments: number;
|
||||
gifts: number;
|
||||
help_request_replies: number;
|
||||
inventory_items: number;
|
||||
invites: number;
|
||||
moderator_messages: number;
|
||||
offline_messages: number;
|
||||
trade_offers: number;
|
||||
};
|
||||
bHWSurveyPending: boolean;
|
||||
bIsLimited: boolean;
|
||||
bIsOfflineMode: boolean;
|
||||
bPromptToChangePassword: boolean;
|
||||
bSupportAckOnlyMessages: boolean;
|
||||
bSupportAlertActive: boolean;
|
||||
bSupportPopupMessage: boolean;
|
||||
clientinstanceid: string;
|
||||
strAccountBalance: string;
|
||||
strAccountBalancePending: string;
|
||||
strAccountName: string;
|
||||
strFamilyGroupID: string;
|
||||
strSteamID: string;
|
||||
}
|
||||
|
||||
export enum ELoginState {
|
||||
None,
|
||||
WelcomeDialog,
|
||||
WaitingForCreateUser,
|
||||
WaitingForCredentials,
|
||||
WaitingForNetwork,
|
||||
WaitingForServerResponse,
|
||||
WaitingForLibraryReady,
|
||||
Success,
|
||||
Quit,
|
||||
}
|
||||
|
||||
export enum EShutdownStep {
|
||||
None,
|
||||
Start,
|
||||
WaitForGames,
|
||||
WaitForCloud,
|
||||
FinishingDownload,
|
||||
WaitForDownload,
|
||||
WaitForServiceApps,
|
||||
WaitForLogOff,
|
||||
Done,
|
||||
// TODO: RegisterForShutdownDone outputs 9 here
|
||||
}
|
||||
|
||||
export enum ESuspendResumeProgressState {
|
||||
Invalid,
|
||||
Complete,
|
||||
CloudSync,
|
||||
LoggingIn,
|
||||
WaitingForApp,
|
||||
Working,
|
||||
}
|
||||
|
||||
export interface LoginUser {
|
||||
personaName: string;
|
||||
accountName: string;
|
||||
hasPin: boolean;
|
||||
rememberPassword: boolean;
|
||||
avatarUrl: string;
|
||||
}
|
||||
|
||||
export interface ResumeSuspendedGamesResult {
|
||||
nAppIDPlayingElsewhere: number;
|
||||
result: EResult;
|
||||
}
|
||||
|
||||
export interface SuspendProgress {
|
||||
bGameSuspended: boolean;
|
||||
state: ESuspendResumeProgressState;
|
||||
}
|
||||
|
||||
export interface SurveyEntry {
|
||||
strName: string;
|
||||
vecArgs: string[];
|
||||
}
|
||||
|
||||
export interface SurveySection {
|
||||
strSectionName: string;
|
||||
vecEntries: SurveyEntry[];
|
||||
}
|
||||
164
src/globals/steam-client/WebChat.ts
Normal file
164
src/globals/steam-client/WebChat.ts
Normal file
@@ -0,0 +1,164 @@
|
||||
import {OverlayBrowserInfo} from "./Overlay";
|
||||
import { EResult, EUIMode, Unregisterable } from "./shared";
|
||||
|
||||
export interface WebChat {
|
||||
BSuppressPopupsInRestore(): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Gets your Steam3 ID.
|
||||
* @returns a Steam3 ID.
|
||||
*/
|
||||
GetCurrentUserAccountID(): Promise<number>;
|
||||
|
||||
/**
|
||||
* Gets the current user's 64x64 avatar as a data URL.
|
||||
* @returns the data URL.
|
||||
*/
|
||||
GetLocalAvatarBase64(): Promise<string>;
|
||||
|
||||
/**
|
||||
* Gets the current user's nickname.
|
||||
* @returns the nickname.
|
||||
*/
|
||||
GetLocalPersonaName(): Promise<string>;
|
||||
|
||||
GetOverlayChatBrowserInfo(): Promise<OverlayBrowserInfo[]>;
|
||||
|
||||
// param0 - appid ?
|
||||
GetPrivateConnectString(param0: number): Promise<string>;
|
||||
|
||||
/**
|
||||
* Gets information about push-to-Talk.
|
||||
* @returns
|
||||
*/
|
||||
GetPushToTalkEnabled(): Promise<PushToTalkInfo>;
|
||||
|
||||
/**
|
||||
* Gets the "Sign in to friends when Steam starts" option value.
|
||||
* @returns a boolean indicating whether the option is enabled or not.
|
||||
*/
|
||||
GetSignIntoFriendsOnStart(): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Retrieves the current UI mode.
|
||||
* @returns the current UI mode.
|
||||
*/
|
||||
GetUIMode(): Promise<EUIMode>;
|
||||
|
||||
OnGroupChatUserStateChange(chatGroupId: number, accountId: number, action: number): void;
|
||||
|
||||
OnNewGroupChatMsgAdded(
|
||||
groupId: string,
|
||||
chatId: string,
|
||||
accountId: number,
|
||||
timestamp: number,
|
||||
param4: number,
|
||||
message: string,
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Opens a provided URL in the Steam client. Does NOT work on desktop mode -
|
||||
* will open in default web browser instead!
|
||||
* @param url The URL to open.
|
||||
*/
|
||||
OpenURLInClient(url: string, pid: number, forceExternal: boolean): void;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the computer's active state changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
* @todo Changes to 2 after 10 seconds?
|
||||
* @todo Does not affect the keyboard?
|
||||
*/
|
||||
RegisterForComputerActiveStateChange(
|
||||
callback: (state: EComputerActiveState, time: number) => void,
|
||||
): Unregisterable;
|
||||
|
||||
/**
|
||||
* @todo WebChat.ShowFriendChatDialog does this.
|
||||
*/
|
||||
RegisterForFriendPostMessage(callback: (data: FriendChatDialogData) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* To unregister, use {@link UnregisterForMouseXButtonDown}.
|
||||
*/
|
||||
RegisterForMouseXButtonDown(callback: (param0: number) => void): void;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the push-to-talk state changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForPushToTalkStateChange(callback: (state: boolean) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the UI mode is changed.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForUIModeChange(callback: (mode: EUIMode) => void): Unregisterable;
|
||||
|
||||
RegisterOverlayChatBrowserInfoChanged(callback: () => void): Unregisterable;
|
||||
|
||||
SetActiveClanChatIDs(clanChatIds: number[]): void;
|
||||
|
||||
SetNumChatsWithUnreadPriorityMessages(size: number): void;
|
||||
|
||||
SetPersonaName(value: string): Promise<SetPersonaNameResult>;
|
||||
|
||||
SetPushToMuteEnabled(value: boolean): void;
|
||||
|
||||
SetPushToTalkEnabled(value: boolean): void;
|
||||
|
||||
SetPushToTalkHotKey(param0: number): void;
|
||||
|
||||
SetPushToTalkMouseButton(param0: number): void;
|
||||
|
||||
SetVoiceChatActive(value: boolean): void;
|
||||
SetVoiceChatStatus(muted: boolean, deafened: boolean): void;
|
||||
ShowChatRoomGroupDialog(param0: number, param1: number): void;
|
||||
|
||||
ShowFriendChatDialog(steamid64: string): void;
|
||||
|
||||
UnregisterForMouseXButtonDown(): void;
|
||||
}
|
||||
|
||||
export enum EComputerActiveState {
|
||||
Invalid,
|
||||
Active,
|
||||
Idle,
|
||||
}
|
||||
|
||||
export interface FriendChatDialog {
|
||||
browserid: number;
|
||||
btakefocus: string;
|
||||
command: string;
|
||||
pid: number;
|
||||
steamid: string;
|
||||
}
|
||||
|
||||
export interface FriendChatDialogData {
|
||||
data: FriendChatDialog;
|
||||
}
|
||||
|
||||
interface SetPersonaNameResult {
|
||||
eResult: EResult;
|
||||
/**
|
||||
* Localization token. Empty if success.
|
||||
*/
|
||||
strMessageToken: string;
|
||||
}
|
||||
|
||||
export interface PushToTalkInfo {
|
||||
/** Indicates whether push-to-talk is enabled. */
|
||||
bEnabled: boolean;
|
||||
/** Indicates whether push-to-mute is in use instead. */
|
||||
bPushToMute: boolean;
|
||||
/**
|
||||
* Push-to-talk hotkey.
|
||||
* @todo enum? this is not EHIDKeyboardKey
|
||||
*/
|
||||
vkHotKey: number;
|
||||
/** Push-to-talk hotkey name. */
|
||||
strKeyName: string;
|
||||
}
|
||||
21
src/globals/steam-client/WebUITransport.ts
Normal file
21
src/globals/steam-client/WebUITransport.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
import { OperationResponse } from "./shared";
|
||||
|
||||
export interface WebUITransport {
|
||||
GetTransportInfo(): Promise<TransportInfo>;
|
||||
|
||||
/**
|
||||
* Tells Steam the websocket failed and opens a troubleshooting dialog.
|
||||
*
|
||||
* The responsible message for this is `CMsgWebUITransportFailure`.
|
||||
*
|
||||
* @param base64 Serialized ProtoBuf message.
|
||||
*/
|
||||
NotifyTransportFailure(base64: string): Promise<OperationResponse>;
|
||||
}
|
||||
|
||||
export interface TransportInfo {
|
||||
authKeyClientdll: string;
|
||||
authKeySteamUI: string;
|
||||
portClientdll: number;
|
||||
portSteamUI: number;
|
||||
}
|
||||
235
src/globals/steam-client/Window.ts
Normal file
235
src/globals/steam-client/Window.ts
Normal file
@@ -0,0 +1,235 @@
|
||||
import { EUIComposition } from "./shared";
|
||||
|
||||
/**
|
||||
* Represents functionality for managing Steam's windows.
|
||||
*
|
||||
* "Restore details" here refers to a string that is similiar to
|
||||
* `1&x=604&y=257&w=1010&h=600`, which is usable with certain
|
||||
* `window.open()` parameters and methods from here.
|
||||
*
|
||||
* Note that methods here have to be called from the
|
||||
* window you want to use (not SharedJSContext).
|
||||
*/
|
||||
export interface Window {
|
||||
BringToFront(forceOS?: EWindowBringToFront): void;
|
||||
|
||||
/**
|
||||
* Closes the window.
|
||||
*/
|
||||
Close(): void;
|
||||
|
||||
/**
|
||||
* @returns the window's fullscreen state.
|
||||
*/
|
||||
DefaultMonitorHasFullscreenWindow(): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Flashes the window in the taskbar.
|
||||
*/
|
||||
FlashWindow(): void;
|
||||
|
||||
GetDefaultMonitorDimensions(): Promise<MonitorDimensions>;
|
||||
|
||||
/**
|
||||
* @returns the mouse position's restore details.
|
||||
*/
|
||||
GetMousePositionDetails(): Promise<string>;
|
||||
|
||||
/**
|
||||
* @returns the window's details.
|
||||
*/
|
||||
GetWindowDetails(): Promise<WindowDetails>;
|
||||
|
||||
/**
|
||||
* @returns the window's dimensions.
|
||||
*/
|
||||
GetWindowDimensions(): Promise<WindowDimensions>;
|
||||
|
||||
/**
|
||||
* @returns the window's restore details.
|
||||
*/
|
||||
GetWindowRestoreDetails(): Promise<string>;
|
||||
|
||||
/**
|
||||
* Hides the window.
|
||||
*/
|
||||
HideWindow(): void;
|
||||
|
||||
/**
|
||||
* @returns the window's maximized state.
|
||||
*/
|
||||
IsWindowMaximized(): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* @returns the window's minimized state.
|
||||
*/
|
||||
IsWindowMinimized(): Promise<boolean>;
|
||||
|
||||
MarkLastFocused(): void;
|
||||
|
||||
/**
|
||||
* Minimizes the window.
|
||||
*/
|
||||
Minimize(): void;
|
||||
|
||||
/**
|
||||
* Moves the window to given coordinates.
|
||||
* @param x Window X position.
|
||||
* @param y Window Y position.
|
||||
* @param dpi Screen DPI.
|
||||
*/
|
||||
MoveTo(x: number, y: number, dpi?: number): void;
|
||||
|
||||
/**
|
||||
* Moves the window to a given location.
|
||||
* @param location Window location.
|
||||
* @param offset X/Y offset.
|
||||
*/
|
||||
MoveToLocation(location: WindowLocation_t, offset?: number): void;
|
||||
|
||||
/**
|
||||
* Moves the window relatively to given details.
|
||||
* @param details Window restore details string from {@link GetWindowRestoreDetails}.
|
||||
* @param x Window X position.
|
||||
* @param y Window Y position.
|
||||
* @param width Window width.
|
||||
* @param height Window height.
|
||||
*
|
||||
* @example
|
||||
* Move the window to bottom right by 50 pixels:
|
||||
* ```
|
||||
* SteamClient.Window.GetWindowRestoreDetails((e) => {
|
||||
* SteamClient.Window.PositionWindowRelative(e, 50, 50, 0, 0);
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
PositionWindowRelative(details: string, x: number, y: number, width: number, height: number): void;
|
||||
|
||||
/**
|
||||
* @returns `true` if yje naun [tpcess od about to shut down.]
|
||||
*/
|
||||
ProcessShuttingDown(): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Resizes the window to given dimension.
|
||||
* The window has to be created with the resizable flag.
|
||||
* @param width Window width.
|
||||
* @param height Window height.
|
||||
* @param applyBrowserScaleOrDPIValue
|
||||
*/
|
||||
ResizeTo(width: number, height: number, applyBrowserScaleOrDPIValue: boolean | number): void;
|
||||
|
||||
/**
|
||||
* Moves the window to given details.
|
||||
* @param details Window details string from `Window.GetWindowRestoreDetails`.
|
||||
*/
|
||||
RestoreWindowSizeAndPosition(details: string): void;
|
||||
|
||||
SetAutoDisplayScale(value: boolean): void;
|
||||
|
||||
SetComposition(mode: EUIComposition, appIdCompositionQueue: number[], windowId: number): void;
|
||||
|
||||
/**
|
||||
* Makes the window hide, but not close on pressing the close button.
|
||||
* @param value Hide on close?
|
||||
*/
|
||||
SetHideOnClose(value: boolean): void;
|
||||
|
||||
SetKeyFocus(value: boolean): void;
|
||||
|
||||
SetManualDisplayScaleFactor(displayScaleFactor: number): void;
|
||||
|
||||
/**
|
||||
* Sets the window's max size.
|
||||
* @param width Window's max width.
|
||||
* @param height Window's max height.
|
||||
*/
|
||||
SetMaxSize(width: number, height: number): void;
|
||||
|
||||
/**
|
||||
* Sets the window's min size.
|
||||
* @param width Window's max width.
|
||||
* @param height Window's max height.
|
||||
*/
|
||||
SetMinSize(width: number, height: number): void;
|
||||
|
||||
SetModal(value: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets the window's resize grip size.
|
||||
* The window has to be created with the resizable flag for this to take any effect.
|
||||
* @param width Resize grip width.
|
||||
* @param height Resize grip height.
|
||||
*/
|
||||
SetResizeGrip(width: number, height: number): void;
|
||||
|
||||
/**
|
||||
* Set the window's icon.
|
||||
* @param icon The window icon to be used.
|
||||
*/
|
||||
SetWindowIcon(icon: WindowIcon_t): void;
|
||||
|
||||
/**
|
||||
* Shows the window.
|
||||
*/
|
||||
ShowWindow(): void;
|
||||
|
||||
/**
|
||||
* Stops the window's taskbar flashing.
|
||||
*/
|
||||
StopFlashWindow(): void;
|
||||
|
||||
/**
|
||||
* Toggles the window's fullscreen state.
|
||||
*/
|
||||
ToggleFullscreen(): void;
|
||||
|
||||
/**
|
||||
* Toggles the window's maximized state.
|
||||
*/
|
||||
ToggleMaximize(): void;
|
||||
}
|
||||
|
||||
export enum EWindowBringToFront {
|
||||
Invalid,
|
||||
AndForceOS,
|
||||
WithoutForcingOS,
|
||||
}
|
||||
|
||||
export type WindowLocation_t =
|
||||
| 'upper-left'
|
||||
| 'lower-left'
|
||||
| 'center-top'
|
||||
| 'center-bottom'
|
||||
| 'upper-right'
|
||||
| 'lower-right';
|
||||
|
||||
export type WindowIcon_t = 'steam' | 'messages' | 'voice';
|
||||
|
||||
/**
|
||||
* "Usable" here refers to space that is not taken by the taskbar.
|
||||
*/
|
||||
export interface MonitorDimensions {
|
||||
flHorizontalScale: number;
|
||||
flVerticalScale: number;
|
||||
nFullHeight: number;
|
||||
nFullLeft: number;
|
||||
nFullTop: number;
|
||||
nFullWidth: number;
|
||||
nUsableHeight: number;
|
||||
nUsableLeft: number;
|
||||
nUsableTop: number;
|
||||
nUsableWidth: number;
|
||||
}
|
||||
|
||||
export interface WindowDetails {
|
||||
bGPUEnabled: boolean;
|
||||
bUnderlaySupported: boolean;
|
||||
}
|
||||
|
||||
export interface WindowDimensions {
|
||||
x: number;
|
||||
y: number;
|
||||
width: number;
|
||||
height: number;
|
||||
}
|
||||
393
src/globals/steam-client/browser-view/BrowserViewPopup.ts
Normal file
393
src/globals/steam-client/browser-view/BrowserViewPopup.ts
Normal file
@@ -0,0 +1,393 @@
|
||||
import {ETouchGesture} from '../Browser';
|
||||
import { BrowserView } from '.';
|
||||
|
||||
export interface BrowserViewPopup {
|
||||
/**
|
||||
* Blur the popup contents.
|
||||
* @param enabled Is the blur enabled?
|
||||
* @param useBackgroundColor
|
||||
* @param blur
|
||||
*/
|
||||
AddGlass(enabled: boolean, useBackgroundColor: boolean, blur: boolean): void;
|
||||
|
||||
/**
|
||||
* @returns `true` if you can go backward in history.
|
||||
*/
|
||||
CanGoBackward(): boolean;
|
||||
|
||||
/**
|
||||
* @returns `true` if you can go forward in history.
|
||||
*/
|
||||
CanGoForward(): boolean;
|
||||
|
||||
// alert() i assume
|
||||
DialogResponse(param0: boolean): void;
|
||||
|
||||
EnableSteamInput(): void;
|
||||
|
||||
/**
|
||||
* Find a string in the page.
|
||||
* @param input The string to find.
|
||||
* @param param1
|
||||
* @param previous `true` for previous match, `false` for next match.
|
||||
*/
|
||||
FindInPage(input: string, param1: boolean, previous: boolean): void;
|
||||
|
||||
/**
|
||||
* Get the current popup position. Only updates when using {@link SetBounds}!
|
||||
* @returns the window position.
|
||||
*/
|
||||
GetBounds(): BrowserViewBounds;
|
||||
|
||||
/**
|
||||
* Go back in history.
|
||||
*/
|
||||
GoBack(): void;
|
||||
|
||||
/**
|
||||
* Go forward in history.
|
||||
*/
|
||||
GoForward(): void;
|
||||
|
||||
/**
|
||||
* @param command See {@link BrowserViewContextMenu.custom_commands}.
|
||||
*/
|
||||
HandleContextMenuCommand(command: number, param2: BrowserViewContextMenu): void;
|
||||
|
||||
/**
|
||||
* Load the specified URL.
|
||||
* @param url The URL to go to.
|
||||
*/
|
||||
LoadURL(url: string): void;
|
||||
|
||||
NotifyUserActivation(): void;
|
||||
|
||||
/**
|
||||
* Paste the current clipboard selection.
|
||||
*/
|
||||
Paste(): void;
|
||||
|
||||
/**
|
||||
* @returns a boolean indicating whether the operation was successful. Will
|
||||
* always be `false` if there are no listeners created by
|
||||
* {@link BrowserView.RegisterForMessageFromParent}.
|
||||
*/
|
||||
PostMessage(message: string, args: string): boolean;
|
||||
|
||||
/**
|
||||
* Reload the page.
|
||||
*/
|
||||
Reload(): void;
|
||||
|
||||
/**
|
||||
* Load the specified URL, but don't save history.
|
||||
* @param url The URL to go to.
|
||||
*/
|
||||
ReplaceURL(url: string): void;
|
||||
|
||||
/**
|
||||
* Define blocked protocols, like https, etc.
|
||||
* @param protocols The protocols to block, separated by a semicolon.
|
||||
*/
|
||||
SetBlockedProtocols(protocols: string): void;
|
||||
|
||||
/**
|
||||
* Sets the browser window position.
|
||||
* @param x Browser window X position.
|
||||
* @param y Browser window Y position.
|
||||
* @param width Browser window width.
|
||||
* @param height Browser window height.
|
||||
*/
|
||||
SetBounds(x: number, y: number, width: number, height: number): void;
|
||||
|
||||
/**
|
||||
* Sets the browser window focus state.
|
||||
* @param value Is the window focused?
|
||||
*/
|
||||
SetFocus(value: boolean): void;
|
||||
|
||||
SetName(browserName: string): void;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when a context menu is shown.
|
||||
* @param callback The callback function to be called.
|
||||
*/
|
||||
SetShowContextMenuCallback(callback: (data: BrowserViewContextMenu) => void): void;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when a steam:// URL is loaded.
|
||||
*/
|
||||
SetSteamURLCallback(callback: (url: string) => void): void;
|
||||
|
||||
/**
|
||||
* @todo unconfirmed
|
||||
*/
|
||||
SetTouchGesturesToCancel(gestures: ETouchGesture[]): void;
|
||||
|
||||
SetVRKeyboardVisibility(value: boolean): void;
|
||||
|
||||
SetVisible(value: boolean): void;
|
||||
|
||||
SetWindowStackingOrder(value: EWindowStackingOrder): void;
|
||||
|
||||
/**
|
||||
* Stop the 'find in page' function.
|
||||
*/
|
||||
StopFindInPage(): void;
|
||||
|
||||
/**
|
||||
* Stop listening for an event.
|
||||
* @param event The event to stop listening to.
|
||||
* @param callback The callback function to be called.
|
||||
*/
|
||||
off<K extends keyof BrowserViewEventMap>(event: K, callback: BrowserViewEventMap[K]): void;
|
||||
|
||||
/**
|
||||
* Start listening for an event.
|
||||
* @param event The event to start listening to.
|
||||
* @param callback The callback function to be called.
|
||||
*/
|
||||
on<K extends keyof BrowserViewEventMap>(event: K, callback: BrowserViewEventMap[K]): void;
|
||||
}
|
||||
|
||||
interface BrowserViewEventMap {
|
||||
/**
|
||||
* Fires when an `alert()` dialog appears.
|
||||
*/
|
||||
'alert-dialog': (message: string) => void;
|
||||
|
||||
/**
|
||||
* Fires when the browser is about to get destroyed.
|
||||
*/
|
||||
'before-close': () => void;
|
||||
|
||||
/**
|
||||
* Fires when a URL gets blocked.
|
||||
* @todo not SetBlockedProtocols, maybe only steam links
|
||||
*/
|
||||
'blocked-request': (blockedURL: string) => void;
|
||||
|
||||
/**
|
||||
* Fires when {@link BrowserViewPopup.CanGoBackward} or
|
||||
* {@link BrowserViewPopup.CanGoForward} state changes.
|
||||
*/
|
||||
'can-go-back-forward-changed': (
|
||||
canGoBackward: boolean,
|
||||
canGoForward: boolean,
|
||||
) => void;
|
||||
|
||||
/**
|
||||
* Fires when a `confirm()` dialog appears.
|
||||
*/
|
||||
'confirm-dialog': (message: string) => void;
|
||||
|
||||
/**
|
||||
* Fires when the browser's favicon changes.
|
||||
*/
|
||||
'favicon-urls-changed': (faviconURLs: string[]) => void;
|
||||
|
||||
/**
|
||||
* Fires when 'Find in page' gets its results.
|
||||
*/
|
||||
'find-in-page-results': (results: number, activeResultIndex: number) => void;
|
||||
|
||||
/**
|
||||
* Fires when the page finishes loading.
|
||||
*/
|
||||
'finished-request': (currentURL: string, previousURL: string) => void;
|
||||
|
||||
/**
|
||||
* Fires when the browser goes focused or vice versa.
|
||||
*/
|
||||
'focus-changed': (focused: boolean) => void;
|
||||
|
||||
/**
|
||||
* Fires when the browser goes fullscreen or vice versa.
|
||||
*/
|
||||
'full-screen': (fullscreen: boolean) => void;
|
||||
|
||||
/**
|
||||
* Fires when history changes occur.
|
||||
*/
|
||||
'history-changed': (history: BrowserViewHistory) => void;
|
||||
|
||||
/**
|
||||
* Fires when the URL fails to load.
|
||||
*/
|
||||
'load-error': (
|
||||
errorCode: number,
|
||||
errorURL: string,
|
||||
errorDescription: string,
|
||||
) => void;
|
||||
|
||||
/**
|
||||
* Fires when a message gets sent with {@link BrowserView.PostMessageToParent}.
|
||||
*/
|
||||
'message': (message: string, args: string, currentURL: string) => void;
|
||||
|
||||
'new-tab': (url: string, param1: boolean) => void;
|
||||
|
||||
/**
|
||||
* Fires when a node gets focused.
|
||||
*/
|
||||
'node-has-focus': (
|
||||
/**
|
||||
* Same as {@link Element.tagName}, but the value is the element's ID when exists.
|
||||
*/
|
||||
elementIdOrTagName: string,
|
||||
/**
|
||||
* Same as {@link Element.tagName}.
|
||||
*/
|
||||
elementTag: string,
|
||||
/**
|
||||
* The `type` attribute of an `<input>` element.
|
||||
*/
|
||||
inputType: string,
|
||||
/**
|
||||
* @todo Localization token that doesn't seem to exist? (#Web_FormSubmit)
|
||||
*/
|
||||
token: string,
|
||||
param4: boolean,
|
||||
) => void;
|
||||
|
||||
'page-security': (url: string, pageSecurity: BrowserViewPageSecurity) => void;
|
||||
|
||||
/**
|
||||
* Fires when the page's `<title>` changes.
|
||||
*/
|
||||
'set-title': (title: string) => void;
|
||||
|
||||
/**
|
||||
* Fires when the page starts loading.
|
||||
*/
|
||||
'start-loading': (url: string, param1: boolean) => void;
|
||||
|
||||
/**
|
||||
* Fires when the page starts loading.
|
||||
*/
|
||||
'start-request': (url: string) => void;
|
||||
|
||||
/**
|
||||
* Fires when "Find in page" gets toggled.
|
||||
*/
|
||||
'toggle-find-in-page': () => void;
|
||||
}
|
||||
|
||||
export interface BrowserViewBounds {
|
||||
x: number;
|
||||
y: number;
|
||||
width: number;
|
||||
height: number;
|
||||
}
|
||||
|
||||
export interface BrowserViewContextMenu {
|
||||
/**
|
||||
* Mouse X position inside the browser view.
|
||||
*/
|
||||
coord_x: number;
|
||||
|
||||
/**
|
||||
* Mouse Y position inside the browser view.
|
||||
*/
|
||||
coord_y: number;
|
||||
|
||||
custom_commands: BrowserViewContextMenuCustomCommand[];
|
||||
|
||||
/**
|
||||
* Bitmask representing edit state. Appears on editable elements like `<input>`, etc.
|
||||
* @see {@link EBrowserViewContextMenuEditFlag}
|
||||
*/
|
||||
edit_state_flags?: number;
|
||||
|
||||
/**
|
||||
* The misspelled word the cursor is on. Appears on an editable element with text.
|
||||
*/
|
||||
misspelled_word?: string;
|
||||
|
||||
/**
|
||||
* Browser page URL.
|
||||
* @todo Appears when there is selected text?
|
||||
*/
|
||||
link_url?: string;
|
||||
|
||||
/**
|
||||
* Browser page URL.
|
||||
*/
|
||||
page_url: string;
|
||||
|
||||
/**
|
||||
* Selected text. Appears when there is selected text.
|
||||
*/
|
||||
selection_text?: string;
|
||||
|
||||
/**
|
||||
* Bitmask representing context menu type.
|
||||
* @see {@link EBrowserViewContextMenuTypeFlag}
|
||||
*/
|
||||
type_flags: number;
|
||||
|
||||
/**
|
||||
* Browser page URL.
|
||||
* @todo Appears when there is selected text?
|
||||
*/
|
||||
unfiltered_link_url?: string;
|
||||
}
|
||||
|
||||
export interface BrowserViewContextMenuCustomCommand {
|
||||
id: number;
|
||||
label: string;
|
||||
}
|
||||
|
||||
export enum EBrowserViewContextMenuTypeFlag {
|
||||
None,
|
||||
Page = 1 << 0,
|
||||
Frame = 1 << 1,
|
||||
Link = 1 << 2,
|
||||
Media = 1 << 3,
|
||||
Selection = 1 << 4,
|
||||
Editable = 1 << 5,
|
||||
}
|
||||
|
||||
export enum EBrowserViewContextMenuEditFlag {
|
||||
None,
|
||||
CanUndo = 1 << 0,
|
||||
CanRedo = 1 << 1,
|
||||
CanCut = 1 << 2,
|
||||
CanCopy = 1 << 3,
|
||||
CanPaste = 1 << 4,
|
||||
CanDelete = 1 << 5,
|
||||
CanSelectAll = 1 << 6,
|
||||
CanTranslate = 1 << 7,
|
||||
}
|
||||
|
||||
export enum EBrowserViewContextMenuCommand {
|
||||
Close = -1,
|
||||
OpenDevTools = 26500,
|
||||
CloseDevTools,
|
||||
InspectElement,
|
||||
OpenLinkInNewTab,
|
||||
}
|
||||
|
||||
export enum EWindowStackingOrder {
|
||||
Bottom,
|
||||
Top,
|
||||
}
|
||||
|
||||
export interface BrowserViewHistory {
|
||||
index: number;
|
||||
entries: BrowserViewHistoryEntry[];
|
||||
}
|
||||
|
||||
export interface BrowserViewHistoryEntry {
|
||||
url: string;
|
||||
}
|
||||
|
||||
export interface BrowserViewPageSecurity {
|
||||
bHasCertError: boolean;
|
||||
bIsEVCert: boolean;
|
||||
bIsSecure: boolean;
|
||||
certExpiry: number;
|
||||
certName: string;
|
||||
issuerName: string;
|
||||
nCertBits: number;
|
||||
}
|
||||
54
src/globals/steam-client/browser-view/index.ts
Normal file
54
src/globals/steam-client/browser-view/index.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
import { Unregisterable } from "../shared";
|
||||
import {BrowserViewPopup} from "./BrowserViewPopup";
|
||||
|
||||
export interface BrowserView {
|
||||
/**
|
||||
* @note Not available on a created BrowserView.
|
||||
*/
|
||||
Create(options?: BrowserViewCreateOptions): BrowserViewPopup;
|
||||
|
||||
/**
|
||||
* Like {@link Create}, but:
|
||||
*
|
||||
* - Lets you create a BrowserView with
|
||||
* `window.open()` instead, while still letting you control the BrowserView
|
||||
* the same way.
|
||||
*
|
||||
* @note Not available on a created BrowserView.
|
||||
*/
|
||||
CreatePopup(options?: BrowserViewCreateOptions): {
|
||||
/**
|
||||
* URL to use with `window.open()`.
|
||||
*/
|
||||
strCreateURL: string;
|
||||
browserView: BrowserViewPopup;
|
||||
};
|
||||
|
||||
/**
|
||||
* @note Not available on a created BrowserView.
|
||||
*/
|
||||
Destroy(browserView: BrowserViewPopup): void;
|
||||
|
||||
/**
|
||||
* @note Only works on a created BrowserView.
|
||||
*/
|
||||
PostMessageToParent(message: string, args: string): void;
|
||||
|
||||
/**
|
||||
* Register a callback to be called when a message gets sent with
|
||||
* {@link BrowserViewPopup.PostMessage}.
|
||||
*
|
||||
* @note Only available on a created BrowserView.
|
||||
*/
|
||||
RegisterForMessageFromParent(callback: (message: string, args: string) => void): Unregisterable;
|
||||
}
|
||||
|
||||
export interface BrowserViewCreateOptions {
|
||||
bOnlyAllowTrustedPopups?: boolean;
|
||||
parentPopupBrowserID?: number;
|
||||
/** Initial URL to load. */
|
||||
strInitialURL?: string;
|
||||
strUserAgentIdentifier?: string;
|
||||
strUserAgentOverride?: string;
|
||||
strVROverlayKey?: string;
|
||||
}
|
||||
90
src/globals/steam-client/index.ts
Normal file
90
src/globals/steam-client/index.ts
Normal file
@@ -0,0 +1,90 @@
|
||||
import { Apps } from "./App";
|
||||
import {Auth} from "./Auth";
|
||||
import {Broadcast} from "./Broadcast";
|
||||
import {Browser} from "./Browser";
|
||||
import {BrowserView} from "./browser-view";
|
||||
import {ClientNotifications} from "./ClientNotifications";
|
||||
import {Cloud} from "./Cloud";
|
||||
import {CommunityItems} from "./CommunityItems";
|
||||
import {Console} from "./Console";
|
||||
import {Customization} from "./Customization";
|
||||
import {Downloads} from "./Downloads";
|
||||
import {FamilySharing} from "./FamilySharing";
|
||||
import {FriendSettings} from "./FriendSettings";
|
||||
import {Friends} from "./Friends";
|
||||
import {GameNotes} from "./GameNotes";
|
||||
import {GameRecording} from "./GameRecording";
|
||||
import {GameSessions} from "./GameSessions";
|
||||
import {Input} from "./Input";
|
||||
import {InstallFolder} from "./InstallFolder";
|
||||
import {Installs} from "./Installs";
|
||||
import {Messaging} from "./Messaging";
|
||||
import {Music} from "./Music";
|
||||
import {Notifications} from "./Notifications";
|
||||
import {OpenVR} from "./OpenVR";
|
||||
import {Overlay} from "./Overlay";
|
||||
import {Storage} from "./Storage";
|
||||
import {Parental} from "./Parental";
|
||||
import {RemotePlay} from "./RemotePlay";
|
||||
import {ServerBrowser} from "./ServerBrowser";
|
||||
import {Screenshots} from "./Screenshots";
|
||||
import {Settings} from "./Settings";
|
||||
import {SharedConnection} from "./SharedConnection";
|
||||
import {Stats} from "./Stats";
|
||||
import {SteamChina} from "./SteamChina";
|
||||
import {Streaming} from "./Streaming";
|
||||
import {System} from "./system";
|
||||
import {UI} from "./UI";
|
||||
import {Updates} from "./Updates";
|
||||
import {User} from "./User";
|
||||
import {WebChat} from "./WebChat";
|
||||
import {WebUITransport} from "./WebUITransport";
|
||||
import {Window} from "./Window";
|
||||
|
||||
export interface SteamClient {
|
||||
Apps: Apps;
|
||||
Auth: Auth;
|
||||
Broadcast: Broadcast;
|
||||
Browser: Browser;
|
||||
BrowserView: BrowserView;
|
||||
ClientNotifications: ClientNotifications;
|
||||
Cloud: Cloud;
|
||||
CommunityItems: CommunityItems;
|
||||
Console: Console;
|
||||
Customization: Customization;
|
||||
Downloads: Downloads;
|
||||
FamilySharing: FamilySharing;
|
||||
Friends: Friends;
|
||||
FriendSettings: FriendSettings;
|
||||
GameNotes: GameNotes;
|
||||
GameRecording: GameRecording;
|
||||
GameSessions: GameSessions;
|
||||
Input: Input;
|
||||
InstallFolder: InstallFolder;
|
||||
Installs: Installs;
|
||||
MachineStorage: Storage;
|
||||
Messaging: Messaging;
|
||||
Music: Music;
|
||||
Notifications: Notifications;
|
||||
OpenVR: OpenVR;
|
||||
Overlay: Overlay;
|
||||
Parental: Parental;
|
||||
RemotePlay: RemotePlay;
|
||||
RoamingStorage: Storage;
|
||||
Screenshots: Screenshots;
|
||||
ServerBrowser: ServerBrowser;
|
||||
Settings: Settings;
|
||||
SharedConnection: SharedConnection;
|
||||
Stats: Stats;
|
||||
SteamChina: SteamChina;
|
||||
Storage: Storage;
|
||||
Streaming: Streaming;
|
||||
System: System;
|
||||
UI: UI;
|
||||
URL: URL;
|
||||
Updates: Updates;
|
||||
User: User;
|
||||
WebChat: WebChat;
|
||||
WebUITransport: WebUITransport;
|
||||
Window: Window;
|
||||
}
|
||||
262
src/globals/steam-client/shared.ts
Normal file
262
src/globals/steam-client/shared.ts
Normal file
@@ -0,0 +1,262 @@
|
||||
export enum EResult {
|
||||
OK = 1,
|
||||
Fail,
|
||||
NoConnection,
|
||||
InvalidPassword = 5,
|
||||
LoggedInElsewhere,
|
||||
InvalidProtocolVer,
|
||||
InvalidParam,
|
||||
FileNotFound,
|
||||
Busy,
|
||||
InvalidState,
|
||||
InvalidName,
|
||||
InvalidEmail,
|
||||
DuplicateName,
|
||||
AccessDenied,
|
||||
Timeout,
|
||||
Banned,
|
||||
AccountNotFound,
|
||||
InvalidSteamID,
|
||||
ServiceUnavailable,
|
||||
NotLoggedOn,
|
||||
Pending,
|
||||
EncryptionFailure,
|
||||
InsufficientPrivilege,
|
||||
LimitExceeded,
|
||||
Revoked,
|
||||
Expired,
|
||||
AlreadyRedeemed,
|
||||
DuplicateRequest,
|
||||
AlreadyOwned,
|
||||
IPNotFound,
|
||||
PersistFailed,
|
||||
LockingFailed,
|
||||
LogonSessionReplaced,
|
||||
ConnectFailed,
|
||||
HandshakeFailed,
|
||||
IOFailure,
|
||||
RemoteDisconnect,
|
||||
ShoppingCartNotFound,
|
||||
Blocked,
|
||||
Ignored,
|
||||
NoMatch,
|
||||
AccountDisabled,
|
||||
ServiceReadOnly,
|
||||
AccountNotFeatured,
|
||||
AdministratorOK,
|
||||
ContentVersion,
|
||||
TryAnotherCM,
|
||||
PasswordRequiredToKickSession,
|
||||
AlreadyLoggedInElsewhere,
|
||||
Suspended,
|
||||
Cancelled,
|
||||
DataCorruption,
|
||||
DiskFull,
|
||||
RemoteCallFailed,
|
||||
PasswordUnset,
|
||||
ExternalAccountUnlinked,
|
||||
PSNTicketInvalid,
|
||||
ExternalAccountAlreadyLinked,
|
||||
RemoteFileConflict,
|
||||
IllegalPassword,
|
||||
SameAsPreviousValue,
|
||||
AccountLogonDenied,
|
||||
CannotUseOldPassword,
|
||||
InvalidLoginAuthCode,
|
||||
AccountLogonDeniedNoMail,
|
||||
HardwareNotCapableOfIPT,
|
||||
IPTInitError,
|
||||
ParentalControlRestricted,
|
||||
FacebookQueryError,
|
||||
ExpiredLoginAuthCode,
|
||||
IPLoginRestrictionFailed,
|
||||
AccountLockedDown,
|
||||
AccountLogonDeniedVerifiedEmailRequired,
|
||||
NoMatchingURL,
|
||||
BadResponse,
|
||||
RequirePasswordReEntry,
|
||||
ValueOutOfRange,
|
||||
UnexpectedError,
|
||||
Disabled,
|
||||
InvalidCEGSubmission,
|
||||
RestrictedDevice,
|
||||
RegionLocked,
|
||||
RateLimitExceeded,
|
||||
AccountLoginDeniedNeedTwoFactor,
|
||||
ItemDeleted,
|
||||
AccountLoginDeniedThrottle,
|
||||
TwoFactorCodeMismatch,
|
||||
TwoFactorActivationCodeMismatch,
|
||||
AccountAssociatedToMultiplePartners,
|
||||
NotModified,
|
||||
NoMobileDevice,
|
||||
TimeNotSynced,
|
||||
SmsCodeFailed,
|
||||
AccountLimitExceeded,
|
||||
AccountActivityLimitExceeded,
|
||||
PhoneActivityLimitExceeded,
|
||||
RefundToWallet,
|
||||
EmailSendFailure,
|
||||
NotSettled,
|
||||
NeedCaptcha,
|
||||
GSLTDenied,
|
||||
GSOwnerDenied,
|
||||
InvalidItemType,
|
||||
IPBanned,
|
||||
GSLTExpired,
|
||||
InsufficientFunds,
|
||||
TooManyPending,
|
||||
NoSiteLicensesFound,
|
||||
WGNetworkSendExceeded,
|
||||
AccountNotFriends,
|
||||
LimitedUserAccount,
|
||||
}
|
||||
|
||||
export enum EBrowserType {
|
||||
/**
|
||||
* No window is created (like SharedJSContext).
|
||||
*/
|
||||
OffScreen,
|
||||
OpenVROverlay,
|
||||
OpenVROverlay_Dashboard,
|
||||
/**
|
||||
* A normal window.
|
||||
*/
|
||||
DirectHWND,
|
||||
/**
|
||||
* A borderless window.
|
||||
*/
|
||||
DirectHWND_Borderless,
|
||||
/**
|
||||
* An initially hidden window.
|
||||
* May be shown with {@link SteamClient.Window.ShowWindow}.
|
||||
*/
|
||||
DirectHWND_Hidden,
|
||||
ChildHWNDNative,
|
||||
Offscreen_SteamUI = 12,
|
||||
OpenVROverlay_Subview,
|
||||
}
|
||||
|
||||
export enum ESteamRealm {
|
||||
Unknown,
|
||||
Global,
|
||||
China,
|
||||
}
|
||||
|
||||
/**
|
||||
* Controls how Gamescope renders the GamepadUI window when a game is running.
|
||||
*/
|
||||
export enum EUIComposition {
|
||||
/** Steam is not rendered on the screen. */
|
||||
Hidden,
|
||||
|
||||
/**
|
||||
* Transparent divs will allow pixels from the app behind Steam to penetrate.
|
||||
* Input goes to **the app**.
|
||||
*/
|
||||
Notification,
|
||||
|
||||
/**
|
||||
* Transparent divs will allow pixels from the app behind Steam to penetrate.
|
||||
* Input goes to **Steam**.
|
||||
*/
|
||||
Overlay,
|
||||
|
||||
/** Take all of the pixels on the screen, nothing "behind" Steam is shown. */
|
||||
Opaque,
|
||||
|
||||
/**
|
||||
* Special composition mode that matches {@link Overlay}, but forwards synthetic keyboard
|
||||
* events to the Gamescope foreground app (game) instead of Steam.
|
||||
*/
|
||||
OverlayKeyboard,
|
||||
}
|
||||
|
||||
export enum EUIMode {
|
||||
Unknown = -1,
|
||||
GamePad = 4,
|
||||
Desktop = 7,
|
||||
}
|
||||
|
||||
/** 0 - false, 1 - true */
|
||||
export type VDFBoolean_t = 0 | 1;
|
||||
|
||||
export interface BrowserContext {
|
||||
/**
|
||||
* Window type.
|
||||
*/
|
||||
m_eBrowserType?: EBrowserType;
|
||||
|
||||
/**
|
||||
* The UI mode in use.
|
||||
*/
|
||||
m_eUIMode?: EUIMode;
|
||||
|
||||
/**
|
||||
* @todo Appears when {@link m_eBrowserType} == 0 ?
|
||||
*/
|
||||
m_gameID?: string;
|
||||
|
||||
/**
|
||||
* @todo Same as `SteamClient.Browser.GetBrowserID()` ?
|
||||
*/
|
||||
m_nBrowserID: number;
|
||||
|
||||
/**
|
||||
* Game's app ID.
|
||||
*/
|
||||
m_unAppID?: number;
|
||||
|
||||
/**
|
||||
* If overlay, game's PID.
|
||||
*/
|
||||
m_unPID: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents the response of an operation. It appears to be not necessary to await for this operation response. It is only used to indicate the result of an operation.
|
||||
*/
|
||||
export interface OperationResponse {
|
||||
/**
|
||||
* The result code of the operation.
|
||||
*/
|
||||
result: EResult;
|
||||
|
||||
/**
|
||||
* An unlocalized message describing the result of the operation.
|
||||
*/
|
||||
message: string;
|
||||
}
|
||||
|
||||
export interface Unregisterable {
|
||||
/**
|
||||
* Unregister the callback.
|
||||
*/
|
||||
unregister(): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* ProtoBuf message class.
|
||||
*/
|
||||
export interface JsPbMessageClass {
|
||||
/**
|
||||
* @todo Returns {@link JsPbMessage}, but not sure how to do it for the messages.
|
||||
*/
|
||||
deserializeBinary(data: ArrayBuffer): any;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserialized ProtoBuf message.
|
||||
*/
|
||||
export interface JsPbMessage {
|
||||
getClassName(): string;
|
||||
|
||||
serializeBase64String(): string;
|
||||
|
||||
serializeBinary(): Uint8Array;
|
||||
|
||||
/**
|
||||
* Converts the message to an object.
|
||||
*/
|
||||
toObject(includeJsPbInstance: boolean): any;
|
||||
}
|
||||
202
src/globals/steam-client/system/Audio.ts
Normal file
202
src/globals/steam-client/system/Audio.ts
Normal file
@@ -0,0 +1,202 @@
|
||||
import { OperationResponse, Unregisterable } from "../shared";
|
||||
|
||||
/**
|
||||
* Represents various functions related to Steam system audio.
|
||||
*/
|
||||
export interface Audio {
|
||||
/**
|
||||
* Clears the default device override for a specified audio type.
|
||||
* @param audioType The audio type (0 for input, 1 for output).
|
||||
*/
|
||||
ClearDefaultDeviceOverride(audioType: number): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Retrieves information about audio applications.
|
||||
* @returns information about audio applications.
|
||||
*/
|
||||
GetApps(): Promise<ApplicationsAudio>;
|
||||
|
||||
/**
|
||||
* Retrieves information about audio devices.
|
||||
* @returns information about audio devices.
|
||||
*/
|
||||
GetDevices(): Promise<AudioDeviceInfo>;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when a new audio application is added.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForAppAdded(callback: (app: ApplicationAudio) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when an audio application is removed.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForAppRemoved(callback: (appAudioId: number) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when the volume of an audio application changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForAppVolumeChanged(callback: (appAudioId: number, volume: number) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when a new audio device is added.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForDeviceAdded(callback: (device: AudioDevice) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when an audio device is removed.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForDeviceRemoved(callback: (audioDeviceId: number) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when the volume of an audio device changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForDeviceVolumeChanged(callback: (audioDeviceId: number, audioType: number, volume: number) => void): Unregisterable;
|
||||
|
||||
RegisterForServiceConnectionStateChanges(callback: (param0: any) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Registers a callback to be called when volume buttons are pressed.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForVolumeButtonPressed(callback: (volumeUpPressed: boolean) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Sets the volume of an audio application.
|
||||
* @param appAudioId The ID of the audio application.
|
||||
* @param volume The volume level (floating point value between 0 and 1).
|
||||
*/
|
||||
SetAppVolume(appAudioId: number, volume: number): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Sets the default device override for a specified audio type.
|
||||
* @param audioDeviceId The ID of the audio device.
|
||||
* @param audioType The audio type (0 for input, 1 for output).
|
||||
*/
|
||||
SetDefaultDeviceOverride(audioDeviceId: number, audioType: number): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Sets the volume of an audio device.
|
||||
* @param audioDeviceId The ID of the audio device.
|
||||
* @param audioType The audio type (0 for input, 1 for output).
|
||||
* @param volume The volume level (floating point value between 0 and 1).
|
||||
*/
|
||||
SetDeviceVolume(audioDeviceId: number, audioType: number, volume: number): Promise<OperationResponse>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents details about an array of application audio sessions.
|
||||
*/
|
||||
export interface ApplicationsAudio {
|
||||
/**
|
||||
* An array of application audio sessions.
|
||||
*/
|
||||
apps: ApplicationAudio[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents details about an application audio session.
|
||||
*/
|
||||
export interface ApplicationAudio {
|
||||
/**
|
||||
* The ID of the application audio.
|
||||
*/
|
||||
id: number;
|
||||
|
||||
/**
|
||||
* The name of the application (e.g., Spotify, YouTube from a browser, etc.).
|
||||
*/
|
||||
strName: string;
|
||||
|
||||
/**
|
||||
* The volume level of the application (floating point value between 0 and 1).
|
||||
*/
|
||||
flVolume: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents details about audio devices and information about the active audio device.
|
||||
*/
|
||||
export interface AudioDeviceInfo {
|
||||
/**
|
||||
* The ID of the active output audio device.
|
||||
*/
|
||||
activeOutputDeviceId: number;
|
||||
|
||||
/**
|
||||
* The ID of the active input audio device.
|
||||
*/
|
||||
activeInputDeviceId: number;
|
||||
|
||||
/**
|
||||
* The ID of the overridden output audio device (-1 if not overridden).
|
||||
*/
|
||||
overrideOutputDeviceId: number;
|
||||
|
||||
/**
|
||||
* The ID of the overridden input audio device (-1 if not overridden).
|
||||
*/
|
||||
overrideInputDeviceId: number;
|
||||
|
||||
/**
|
||||
* An array of audio devices.
|
||||
*/
|
||||
vecDevices: AudioDevice[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents details about an audio device.
|
||||
*/
|
||||
export interface AudioDevice {
|
||||
/**
|
||||
* The identifier of the audio device.
|
||||
*/
|
||||
id: number;
|
||||
|
||||
/**
|
||||
* The name of the audio device.
|
||||
*/
|
||||
sName: string;
|
||||
|
||||
/**
|
||||
* Indicates if the device has audio output.
|
||||
*/
|
||||
bHasOutput: boolean;
|
||||
|
||||
/**
|
||||
* Indicates if the device is the default output device.
|
||||
*/
|
||||
bIsDefaultOutputDevice: boolean;
|
||||
|
||||
/**
|
||||
* The volume level of the audio output device (floating point value between 0 and 1).
|
||||
*/
|
||||
flOutputVolume: number;
|
||||
|
||||
/**
|
||||
* Indicates if the device has audio input.
|
||||
*/
|
||||
bHasInput: boolean;
|
||||
|
||||
/**
|
||||
* Indicates if the device is the default input device.
|
||||
*/
|
||||
bIsDefaultInputDevice: boolean;
|
||||
|
||||
/**
|
||||
* The volume level of the audio input device (floating point value between 0 and 1).
|
||||
*/
|
||||
flInputVolume: number;
|
||||
}
|
||||
116
src/globals/steam-client/system/AudioDevice.ts
Normal file
116
src/globals/steam-client/system/AudioDevice.ts
Normal file
@@ -0,0 +1,116 @@
|
||||
import { JsPbMessage, Unregisterable } from "../shared";
|
||||
|
||||
export interface AudioDevice {
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link CMsgSystemAudioManagerState}.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @param base64 Serialized base64 message from `CMsgSystemAudioManagerUpdateSomething`.
|
||||
*/
|
||||
UpdateSomething(base64: string): void;
|
||||
}
|
||||
|
||||
export interface CMsgSystemAudioManagerState extends JsPbMessage {
|
||||
counter(): number | undefined;
|
||||
|
||||
hw(): MsgSystemAudioManagerStateHW | undefined;
|
||||
|
||||
rtime_filter(): number | undefined;
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioManagerStateHW {
|
||||
devices: MsgSystemAudioManagerDevice[];
|
||||
nodes: MsgSystemAudioManagerNode[];
|
||||
ports: MsgSystemAudioManagerPort[];
|
||||
links: MsgSystemAudioManagerLink[];
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioManagerDevice {
|
||||
base: MsgSystemAudioManagerObject | undefined;
|
||||
name: string | undefined;
|
||||
nick: string | undefined;
|
||||
description: string | undefined;
|
||||
api: string | undefined;
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioManagerNode {
|
||||
base: MsgSystemAudioManagerObject | undefined;
|
||||
device_id: number | undefined;
|
||||
name: string | undefined;
|
||||
nick: string | undefined;
|
||||
description: string | undefined;
|
||||
edirection: ESystemAudioDirection | undefined;
|
||||
volume: MsgSystemAudioVolume | undefined;
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioManagerPort {
|
||||
base: MsgSystemAudioManagerObject | undefined;
|
||||
node_id: number | undefined;
|
||||
name: string | undefined;
|
||||
alias: string | undefined;
|
||||
etype: ESystemAudioPortType | undefined;
|
||||
edirection: ESystemAudioPortDirection | undefined;
|
||||
is_physical: boolean | undefined;
|
||||
is_terminal: boolean | undefined;
|
||||
is_control: boolean | undefined;
|
||||
is_monitor: boolean | undefined;
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioVolume {
|
||||
entries: MsgSystemAudioVolumeChannelEntry[] | undefined;
|
||||
is_muted: boolean | undefined;
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioVolumeChannelEntry {
|
||||
echannel: ESystemAudioChannel | undefined;
|
||||
volume: number | undefined;
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioManagerLink {
|
||||
base: MsgSystemAudioManagerObject | undefined;
|
||||
output_node_id: number | undefined;
|
||||
output_port_id: number | undefined;
|
||||
input_node_id: number | undefined;
|
||||
input_port_id: number | undefined;
|
||||
}
|
||||
|
||||
export interface MsgSystemAudioManagerObject {
|
||||
id: number | undefined;
|
||||
rtime_last_update: number | undefined;
|
||||
}
|
||||
|
||||
export enum ESystemAudioDirection {
|
||||
Invalid,
|
||||
Input,
|
||||
Output,
|
||||
}
|
||||
|
||||
export enum ESystemAudioPortDirection {
|
||||
Invalid,
|
||||
Input,
|
||||
Output,
|
||||
}
|
||||
|
||||
export enum ESystemAudioPortType {
|
||||
Invalid,
|
||||
Unknown,
|
||||
Audio32f,
|
||||
Midi8b,
|
||||
Video32RGBA,
|
||||
}
|
||||
|
||||
export enum ESystemAudioChannel {
|
||||
Invalid,
|
||||
Aggregated,
|
||||
FrontLeft,
|
||||
FrontRight,
|
||||
LFE,
|
||||
BackLeft,
|
||||
BackRight,
|
||||
FrontCenter,
|
||||
Unknown,
|
||||
Mono,
|
||||
}
|
||||
171
src/globals/steam-client/system/Bluetooth.ts
Normal file
171
src/globals/steam-client/system/Bluetooth.ts
Normal file
@@ -0,0 +1,171 @@
|
||||
import { OperationResponse, Unregisterable } from "../shared";
|
||||
|
||||
/**
|
||||
* Provides functionality for managing Bluetooth devices and interactions.
|
||||
*/
|
||||
export interface Bluetooth {
|
||||
/**
|
||||
* Cancels an ongoing pairing request with a Bluetooth device.
|
||||
* @param adapterId The ID of the Bluetooth adapter.
|
||||
* @param deviceId The ID of the Bluetooth device to cancel pairing with.
|
||||
*/
|
||||
CancelPairing(adapterId: number, deviceId: number): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Connects to a paired Bluetooth device using the specified adapter.
|
||||
* @param adapterId The ID of the Bluetooth adapter.
|
||||
* @param deviceId The ID of the paired Bluetooth device to connect to.
|
||||
*/
|
||||
Connect(adapterId: number, deviceId: number): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Disconnects from a currently connected Bluetooth device using the specified adapter.
|
||||
* @param adapterId The ID of the Bluetooth adapter.
|
||||
* @param deviceId The ID of the connected Bluetooth device to disconnect from.
|
||||
*/
|
||||
Disconnect(adapterId: number, deviceId: number): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Initiates pairing with a Bluetooth device using the specified adapter.
|
||||
* @param adapterId The ID of the Bluetooth adapter.
|
||||
* @param deviceId The ID of the Bluetooth device to initiate pairing with.
|
||||
*/
|
||||
Pair(adapterId: number, deviceId: number): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Registers a callback function to be called when the Bluetooth state changes.
|
||||
* @param callback The callback function to be called.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStateChanges(callback: (state: BluetoothState) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* Sets whether the Bluetooth adapter should be in discovering mode.
|
||||
* @param adapterId The ID of the Bluetooth adapter.
|
||||
* @param value `true` to enable discovering mode, `false` to disable it.
|
||||
*/
|
||||
SetAdapterDiscovering(adapterId: number, value: boolean): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Enables or disables Bluetooth functionality.
|
||||
* @param value `true` to enable Bluetooth, `false` to disable it.
|
||||
*/
|
||||
SetEnabled(value: boolean): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* Unpairs a Bluetooth device from the adapter.
|
||||
* @param adapterId The ID of the Bluetooth adapter.
|
||||
* @param deviceId The ID of the Bluetooth device to unpair with.
|
||||
*/
|
||||
UnPair(adapterId: number, deviceId: number): Promise<OperationResponse>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a change in the state of Bluetooth adapters and devices.
|
||||
*/
|
||||
export interface BluetoothState {
|
||||
/**
|
||||
* An array of Bluetooth adapters with their current state.
|
||||
*/
|
||||
vecAdapters: BluetoothAdapter[];
|
||||
|
||||
/**
|
||||
* An array of Bluetooth devices with their current state.
|
||||
*/
|
||||
vecDevices: BluetoothDevice[];
|
||||
|
||||
/**
|
||||
* Indicates whether Bluetooth is enabled (`true`) or disabled (`false`).
|
||||
*/
|
||||
bEnabled: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents information about a Bluetooth adapter.
|
||||
*/
|
||||
export interface BluetoothAdapter {
|
||||
/**
|
||||
* The unique identifier of the Bluetooth adapter.
|
||||
*/
|
||||
nId: number;
|
||||
|
||||
/**
|
||||
* The MAC address of the Bluetooth adapter.
|
||||
*/
|
||||
sMAC: string;
|
||||
|
||||
/**
|
||||
* The name of the Bluetooth adapter.
|
||||
*/
|
||||
sName: string;
|
||||
|
||||
/**
|
||||
* Indicates whether the Bluetooth adapter is enabled.
|
||||
*/
|
||||
bEnabled: boolean;
|
||||
|
||||
/**
|
||||
* Indicates whether the Bluetooth adapter is in discovering mode.
|
||||
*/
|
||||
bDiscovering: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents information about a Bluetooth device.
|
||||
*/
|
||||
export interface BluetoothDevice {
|
||||
/**
|
||||
* The unique identifier of the Bluetooth device.
|
||||
*/
|
||||
nId: number;
|
||||
|
||||
/**
|
||||
* The ID of the Bluetooth adapter to which this device is discovered by / connected to.
|
||||
*/
|
||||
nAdapterId: number;
|
||||
|
||||
/**
|
||||
* The type of the Bluetooth device (e.g., headphones, mouse, keyboard).
|
||||
*/
|
||||
eType: EBluetoothDeviceType;
|
||||
|
||||
/**
|
||||
* The MAC address of the Bluetooth device.
|
||||
*/
|
||||
sMAC: string;
|
||||
|
||||
/**
|
||||
* The name of the Bluetooth device.
|
||||
*/
|
||||
sName: string;
|
||||
|
||||
/**
|
||||
* Indicates whether the Bluetooth device is currently connected to the adapter.
|
||||
*/
|
||||
bConnected: boolean;
|
||||
|
||||
/**
|
||||
* Indicates whether the Bluetooth device is paired to the adapter.
|
||||
*/
|
||||
bPaired: boolean;
|
||||
|
||||
/**
|
||||
* The raw signal strength of the Bluetooth device.
|
||||
*/
|
||||
nStrengthRaw: number;
|
||||
}
|
||||
|
||||
export enum EBluetoothDeviceType {
|
||||
Invalid,
|
||||
Unknown,
|
||||
Phone,
|
||||
Computer,
|
||||
Headset,
|
||||
Headphones,
|
||||
Speakers,
|
||||
OtherAudio,
|
||||
Mouse,
|
||||
Joystick,
|
||||
Gamepad,
|
||||
Keyboard,
|
||||
}
|
||||
11
src/globals/steam-client/system/Devkit.ts
Normal file
11
src/globals/steam-client/system/Devkit.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import { Unregisterable } from "../shared";
|
||||
|
||||
export interface Devkit {
|
||||
DeveloperModeChanged(state: boolean): any;
|
||||
|
||||
RegisterForPairingPrompt(callback: (param0: any) => any): Unregisterable;
|
||||
|
||||
RespondToPairingPrompt(param0: any, param1: any): any;
|
||||
|
||||
SetPairing(param0: any): any;
|
||||
}
|
||||
15
src/globals/steam-client/system/Display.ts
Normal file
15
src/globals/steam-client/system/Display.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
import { Unregisterable } from "../shared";
|
||||
|
||||
export interface Display {
|
||||
EnableUnderscan(param0: boolean): any;
|
||||
|
||||
RegisterForBrightnessChanges(callback: (state: BrightnessState) => void): Unregisterable;
|
||||
|
||||
SetBrightness(brightness: number): any;
|
||||
|
||||
SetUnderscanLevel(param0: any): any;
|
||||
}
|
||||
|
||||
export interface BrightnessState {
|
||||
flBrightness: number;
|
||||
}
|
||||
16
src/globals/steam-client/system/DisplayManager.ts
Normal file
16
src/globals/steam-client/system/DisplayManager.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
import { Unregisterable } from "../shared";
|
||||
|
||||
// CMsgSystemDisplayManagerState, CMsgSystemDisplayManagerSetMode
|
||||
export interface DisplayManager {
|
||||
ClearModeOverride(displayId: any): any;
|
||||
|
||||
GetState: any;
|
||||
|
||||
RegisterForStateChanges(callback: () => void): Unregisterable;
|
||||
|
||||
SetCompatibilityMode(displayId: any): any;
|
||||
|
||||
SetGamescopeInternalResolution(width: number, height: number): any;
|
||||
|
||||
SetMode(base64: string): any; //
|
||||
}
|
||||
34
src/globals/steam-client/system/Dock.ts
Normal file
34
src/globals/steam-client/system/Dock.ts
Normal file
@@ -0,0 +1,34 @@
|
||||
import { JsPbMessage, Unregisterable } from "../shared";
|
||||
import {EUpdaterState} from "../Updates";
|
||||
|
||||
export interface Dock {
|
||||
DisarmSafetyNet(): void;
|
||||
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link MsgSystemDockState}.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @param base64 Serialized base64 message from `CMsgSystemDockUpdateFirmware`.
|
||||
*/
|
||||
UpdateFirmware(base64: string): any;
|
||||
}
|
||||
|
||||
/**
|
||||
* CMsgSystemDockState
|
||||
*/
|
||||
export interface MsgSystemDockState extends JsPbMessage {
|
||||
update_state(): SystemDockUpdateState | undefined;
|
||||
}
|
||||
|
||||
export interface SystemDockUpdateState {
|
||||
state: EUpdaterState | undefined;
|
||||
rtime_last_checked: number | undefined;
|
||||
version_current: string | undefined;
|
||||
version_available: string | undefined;
|
||||
stage_progress: number | undefined;
|
||||
rtime_estimated_completion: number | undefined;
|
||||
old_fw_workaround: number | undefined;
|
||||
}
|
||||
194
src/globals/steam-client/system/Perf.ts
Normal file
194
src/globals/steam-client/system/Perf.ts
Normal file
@@ -0,0 +1,194 @@
|
||||
import { JsPbMessage } from "../shared";
|
||||
import { Unregisterable } from "../shared";
|
||||
|
||||
// CMsgSystemPerfUpdateSettings, CMsgSystemPerfState, CMsgSystemPerfSettings
|
||||
export interface Perf {
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link CMsgSystemPerfDiagnosticInfo}.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForDiagnosticInfoChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link CMsgSystemPerfState}.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @param base64 Serialized base64 message from `CMsgSystemPerfUpdateSettings`.
|
||||
*/
|
||||
UpdateSettings(base64: string): any;
|
||||
}
|
||||
|
||||
export interface CMsgSystemPerfDiagnosticInfo extends JsPbMessage {
|
||||
battery_temp_c(): number | undefined;
|
||||
|
||||
entries(): SystemPerfDiagnosticEntry[] | undefined;
|
||||
|
||||
interfaces(): SystemPerfNetworkInterface[] | undefined;
|
||||
}
|
||||
|
||||
export interface SystemPerfDiagnosticEntry {
|
||||
name: string | undefined;
|
||||
value: string | undefined;
|
||||
}
|
||||
|
||||
export interface SystemPerfNetworkInterface {
|
||||
name: string | undefined;
|
||||
timestamp: number | undefined;
|
||||
tx_bytes_total: number | undefined;
|
||||
rx_bytes_total: number | undefined;
|
||||
tx_bytes_per_sec: number | undefined;
|
||||
rx_bytes_per_sec: number | undefined;
|
||||
}
|
||||
|
||||
export interface CMsgSystemPerfState extends JsPbMessage {
|
||||
active_profile_game_id(): string | undefined;
|
||||
|
||||
current_game_id(): string | undefined;
|
||||
|
||||
limits(): SystemPerfLimits | undefined;
|
||||
|
||||
settings(): SystemPerfSettings | undefined;
|
||||
}
|
||||
|
||||
export interface SystemPerfLimits {
|
||||
cpu_governor_manual_min_mhz: number | undefined;
|
||||
cpu_governor_manual_max_mhz: number | undefined;
|
||||
fsr_sharpness_min: number | undefined;
|
||||
fsr_sharpness_max: number | undefined;
|
||||
gpu_performance_manual_min_mhz: number | undefined;
|
||||
gpu_performance_manual_max_mhz: number | undefined;
|
||||
perf_overlay_is_standalone: boolean | undefined;
|
||||
is_dynamic_vrs_available: boolean | undefined;
|
||||
is_manual_display_refresh_rate_available: boolean | undefined;
|
||||
gpu_performance_levels_available: EGPUPerformanceLevel[];
|
||||
display_refresh_manual_hz_min: number | undefined;
|
||||
display_refresh_manual_hz_max: number | undefined;
|
||||
fps_limit_options: number[] | undefined;
|
||||
tdp_limit_min: number | undefined;
|
||||
tdp_limit_max: number | undefined;
|
||||
is_nis_supported: boolean | undefined;
|
||||
nis_sharpness_min: number | undefined;
|
||||
nis_sharpness_max: number | undefined;
|
||||
display_external_refresh_manual_hz_min: number | undefined;
|
||||
display_external_refresh_manual_hz_max: number | undefined;
|
||||
fps_limit_options_external: number[] | undefined;
|
||||
is_tearing_supported: boolean | undefined;
|
||||
is_vrr_supported: boolean | undefined;
|
||||
is_dynamic_refresh_rate_in_steam_supported: boolean | undefined;
|
||||
is_split_scaling_and_filtering_supported: boolean | undefined;
|
||||
split_scaling_filters_available: ESplitScalingFilter[];
|
||||
split_scaling_scalers_available: ESplitScalingScaler[];
|
||||
is_hdr_supported: boolean | undefined;
|
||||
display_refresh_manual_hz_oc_max: number | undefined;
|
||||
disable_refresh_rate_management: boolean | undefined;
|
||||
}
|
||||
|
||||
export enum EGPUPerformanceLevel {
|
||||
Invalid,
|
||||
Auto,
|
||||
Manual,
|
||||
Low,
|
||||
High,
|
||||
Profiling,
|
||||
}
|
||||
|
||||
export enum ESplitScalingFilter {
|
||||
Invalid,
|
||||
Linear,
|
||||
Nearest,
|
||||
FSR,
|
||||
NIS,
|
||||
}
|
||||
|
||||
export enum ESplitScalingScaler {
|
||||
Invalid,
|
||||
Auto,
|
||||
Integer,
|
||||
Fit,
|
||||
Fill,
|
||||
Stretch,
|
||||
}
|
||||
|
||||
export interface SystemPerfSettings {
|
||||
global: SystemPerfSettingsGlobal | undefined;
|
||||
per_app: SystemPerfSettingsPerApp | undefined;
|
||||
}
|
||||
|
||||
export interface SystemPerfSettingsGlobal {
|
||||
diagnostic_update_rate: number;
|
||||
system_trace_service_state: ESystemServiceState;
|
||||
graphics_profiling_service_state: ESystemServiceState;
|
||||
perf_overlay_service_state: ESystemServiceState;
|
||||
perf_overlay_level: EGraphicsPerfOverlayLevel;
|
||||
is_show_perf_overlay_over_steam_enabled: boolean;
|
||||
is_advanced_settings_enabled: boolean;
|
||||
allow_external_display_refresh_control: boolean;
|
||||
is_hdr_enabled: boolean;
|
||||
hdr_on_sdr_tonemap_operator: EHDRToneMapOperator;
|
||||
is_hdr_debug_heatmap_enabled: boolean;
|
||||
force_hdr_wide_gammut_for_sdr: boolean;
|
||||
allow_experimental_hdr: boolean;
|
||||
sdr_to_hdr_brightness: number;
|
||||
debug_force_hdr_support: boolean;
|
||||
force_hdr_10pq_output_debug: boolean;
|
||||
is_display_oc_enabled: boolean;
|
||||
is_color_management_enabled: boolean;
|
||||
}
|
||||
|
||||
export enum ESystemServiceState {
|
||||
Unavailable,
|
||||
Disabled,
|
||||
Enabled,
|
||||
}
|
||||
|
||||
export enum EGraphicsPerfOverlayLevel {
|
||||
Hidden,
|
||||
Basic,
|
||||
Medium,
|
||||
Full,
|
||||
Minimal,
|
||||
}
|
||||
|
||||
export enum EHDRToneMapOperator {
|
||||
Invalid,
|
||||
Uncharted,
|
||||
Reinhard,
|
||||
}
|
||||
|
||||
export interface SystemPerfSettingsPerApp {
|
||||
gpu_performance_manual_mhz: number | undefined;
|
||||
fps_limit: number | undefined;
|
||||
is_variable_resolution_enabled: boolean | undefined;
|
||||
is_dynamic_refresh_rate_enabled: boolean | undefined;
|
||||
tdp_limit: number | undefined;
|
||||
cpu_governor: ECPUGovernor | undefined;
|
||||
cpu_governor_manual_mhz: number | undefined;
|
||||
scaling_filter: number | undefined;
|
||||
fsr_sharpness: number | undefined;
|
||||
is_fps_limit_enabled: boolean | undefined;
|
||||
is_tdp_limit_enabled: boolean | undefined;
|
||||
is_low_latency_mode_enabled: boolean | undefined;
|
||||
display_refresh_manual_hz: number | undefined;
|
||||
is_game_perf_profile_enabled: boolean | undefined;
|
||||
gpu_performance_level: EGPUPerformanceLevel | undefined;
|
||||
nis_sharpness: number | undefined;
|
||||
display_external_refresh_manual_hz: number | undefined;
|
||||
fps_limit_external: number | undefined;
|
||||
is_tearing_enabled: boolean | undefined;
|
||||
is_vrr_enabled: boolean | undefined;
|
||||
is_composite_debug_enabled: boolean | undefined;
|
||||
force_composite: boolean | undefined;
|
||||
use_dynamic_refresh_rate_in_steam: boolean | undefined;
|
||||
split_scaling_filter: ESplitScalingFilter | undefined;
|
||||
split_scaling_scaler: ESplitScalingScaler | undefined;
|
||||
}
|
||||
|
||||
export enum ECPUGovernor {
|
||||
Invalid,
|
||||
Perf,
|
||||
Powersave,
|
||||
Manual,
|
||||
}
|
||||
39
src/globals/steam-client/system/Report.ts
Normal file
39
src/globals/steam-client/system/Report.ts
Normal file
@@ -0,0 +1,39 @@
|
||||
import { JsPbMessage, OperationResponse } from "../shared";
|
||||
|
||||
export interface Report {
|
||||
/**
|
||||
* Generates a system report located in `/tmp/steamXXXXXX` (located in
|
||||
* https://steamloopback.host/systemreports).
|
||||
*/
|
||||
GenerateSystemReport(): Promise<SystemReportReply>;
|
||||
|
||||
/**
|
||||
* Saves a report in the Desktop directory.
|
||||
* @param reportId The report ID (file name) to save.
|
||||
*/
|
||||
SaveToDesktop(reportId: string): Promise<OperationResponse>;
|
||||
|
||||
/**
|
||||
* @param reportId The report ID (file name) to submit.
|
||||
* @todo times out ({@link Result.Timeout})
|
||||
*/
|
||||
Submit(reportId: string): Promise<OperationResponse>;
|
||||
}
|
||||
|
||||
export interface SystemReportReply extends OperationResponse {
|
||||
/**
|
||||
* If deserialized, returns {@link CMsgGenerateSystemReportReply}.
|
||||
*
|
||||
* Optional, since {@link Report.GenerateSystemReport} throws without this.
|
||||
*/
|
||||
reply?: ArrayBuffer;
|
||||
}
|
||||
|
||||
export interface CMsgGenerateSystemReportReply extends JsPbMessage {
|
||||
/**
|
||||
* The report file name.
|
||||
*/
|
||||
report_id(): string | undefined;
|
||||
|
||||
set_report_id(param0: any): any;
|
||||
}
|
||||
38
src/globals/steam-client/system/UI.ts
Normal file
38
src/globals/steam-client/system/UI.ts
Normal file
@@ -0,0 +1,38 @@
|
||||
import { Unregisterable } from "../shared";
|
||||
|
||||
export interface UI {
|
||||
CloseGameWindow(appId: number, windowId: number): void;
|
||||
|
||||
GetGameWindowsInfo(appId: number, windowIds: number[]): Promise<GameWindowInfo>;
|
||||
|
||||
RegisterForFocusChangeEvents(callback: (event: FocusChangeEvent) => void): Unregisterable;
|
||||
|
||||
// appId is 0 if unknown app is focused
|
||||
RegisterForOverlayGameWindowFocusChanged(callback: (appId: number, overlayPid: number) => void): Unregisterable;
|
||||
|
||||
RegisterForSystemKeyEvents(callback: (event: SystemKeyEvent) => void): Unregisterable;
|
||||
}
|
||||
|
||||
interface SystemKeyEvent {
|
||||
/** @todo enum */
|
||||
eKey: number;
|
||||
nControllerIndex: number;
|
||||
}
|
||||
|
||||
export interface FocusChangeEvent {
|
||||
focusedApp: FocusedApp;
|
||||
rgFocusable: FocusedApp[];
|
||||
}
|
||||
|
||||
export interface FocusedApp {
|
||||
appid: number;
|
||||
pid: number;
|
||||
windowid: number;
|
||||
strExeName: string;
|
||||
}
|
||||
|
||||
export interface GameWindowInfo {
|
||||
bCanClose: boolean;
|
||||
strTitle: string;
|
||||
windowid: number;
|
||||
}
|
||||
390
src/globals/steam-client/system/index.ts
Normal file
390
src/globals/steam-client/system/index.ts
Normal file
@@ -0,0 +1,390 @@
|
||||
import { JsPbMessage, OperationResponse, Unregisterable } from "../shared";
|
||||
import {Audio} from "./Audio";
|
||||
import {AudioDevice} from "./AudioDevice";
|
||||
import {Bluetooth} from "./Bluetooth";
|
||||
import {Devkit} from "./Devkit";
|
||||
import {Display} from "./Display";
|
||||
import {DisplayManager} from "./DisplayManager";
|
||||
import {Dock} from "./Dock";
|
||||
import {Network} from "./network";
|
||||
import {Perf} from "./Perf";
|
||||
import {Report} from "./Report";
|
||||
import {UI} from "./UI";
|
||||
|
||||
export interface System {
|
||||
Audio: Audio;
|
||||
AudioDevice: AudioDevice;
|
||||
Bluetooth: Bluetooth;
|
||||
|
||||
/**
|
||||
* @returns a boolean indicating whether the operation succeeded.
|
||||
*/
|
||||
CopyFile(target: string, destination: string): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Copies specified files to clipboard.
|
||||
* Does not throw if not found.
|
||||
* @param paths File paths to copy.
|
||||
*/
|
||||
CopyFilesToClipboard(paths: string[]): void;
|
||||
|
||||
/**
|
||||
* Creates a temporary folder.
|
||||
* @param path The folder to create.
|
||||
* @returns the created path.
|
||||
* @todo Does this support relative paths ? this has some weird behavior
|
||||
*/
|
||||
CreateTempPath(path: string): Promise<string>;
|
||||
|
||||
Devkit: Devkit;
|
||||
Display: Display;
|
||||
DisplayManager: DisplayManager;
|
||||
Dock: Dock;
|
||||
|
||||
ExitFakeCaptivePortal(): any;
|
||||
|
||||
FactoryReset(): any;
|
||||
|
||||
FormatStorage(force: boolean): any;
|
||||
|
||||
GetOSType(): Promise<EOSType>;
|
||||
|
||||
GetSystemInfo(): Promise<SystemInfo>;
|
||||
|
||||
IsDeckFactoryImage(): Promise<boolean>;
|
||||
|
||||
IsSteamInTournamentMode(): Promise<boolean>;
|
||||
|
||||
/**
|
||||
* Moves a file.
|
||||
* @param target Target file/folder.
|
||||
* @param destination Destination path.
|
||||
* @remarks Does not throw on error.
|
||||
*/
|
||||
MoveFile(target: string, destination: string): void;
|
||||
|
||||
Network: Network;
|
||||
|
||||
NotifyGameOverlayStateChanged(latestAppOverlayStateActive: boolean, appId: number): any;
|
||||
|
||||
/**
|
||||
* Open a dialog for choosing a file.
|
||||
* @param prefs Dialog preferences.
|
||||
* @returns the selected file name.
|
||||
* @throws OperationResponse if no file was selected.
|
||||
*/
|
||||
OpenFileDialog(prefs: FileDialog): Promise<string | OperationResponse>;
|
||||
|
||||
/**
|
||||
* Open a URL in the default web browser.
|
||||
*/
|
||||
OpenInSystemBrowser(url: string): void;
|
||||
|
||||
OpenLocalDirectoryInSystemExplorer(directory: string): void;
|
||||
Perf: Perf;
|
||||
|
||||
RebootToAlternateSystemPartition(): any;
|
||||
|
||||
RebootToFactoryTestImage(param0: any): any;
|
||||
|
||||
RegisterForAirplaneModeChanges(callback: (state: AirplaneModeState) => void): Unregisterable;
|
||||
|
||||
RegisterForBatteryStateChanges(callback: (state: BatteryState) => void): Unregisterable;
|
||||
|
||||
RegisterForFormatStorageProgress(callback: (progress: FormatStorageProgress) => void): Unregisterable;
|
||||
|
||||
RegisterForOnResumeFromSuspend(callback: () => void): Unregisterable;
|
||||
|
||||
RegisterForOnSuspendRequest(callback: () => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* @returns a ProtoBuf message. If deserialized, returns {@link CMsgSystemManagerSettings}.
|
||||
*/
|
||||
RegisterForSettingsChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
Report: Report;
|
||||
|
||||
/**
|
||||
* Restarts the system.
|
||||
*/
|
||||
RestartPC(): any;
|
||||
|
||||
SetAirplaneMode(value: boolean): void;
|
||||
|
||||
ShutdownPC(): any;
|
||||
|
||||
SteamRuntimeSystemInfo(): Promise<string>;
|
||||
|
||||
/**
|
||||
* Suspends the system.
|
||||
*/
|
||||
SuspendPC(): any;
|
||||
|
||||
/**
|
||||
* Switches to desktop mode.
|
||||
*/
|
||||
SwitchToDesktop(): any;
|
||||
|
||||
UI: UI;
|
||||
UpdateSettings: any;
|
||||
|
||||
VideoRecordingDriverCheck(): any;
|
||||
}
|
||||
|
||||
export interface AirplaneModeState {
|
||||
bEnabled: boolean;
|
||||
}
|
||||
|
||||
export interface BatteryState {
|
||||
bHasBattery: boolean;
|
||||
eACState: EACState;
|
||||
eBatteryState: EBatteryState;
|
||||
/**
|
||||
* Battery Percentage in floating point 0-1.
|
||||
*/
|
||||
flLevel: number;
|
||||
/**
|
||||
* Appears to be charge time remaining or time remaining on battery.
|
||||
*/
|
||||
nSecondsRemaining: number;
|
||||
bShutdownRequested: boolean;
|
||||
}
|
||||
|
||||
export interface FormatStorageProgress {
|
||||
flProgress: number;
|
||||
rtEstimatedCompletionTime: number;
|
||||
eStage: EStorageFormatStage;
|
||||
}
|
||||
|
||||
export enum EACState {
|
||||
Unknown,
|
||||
Disconnected,
|
||||
Connected,
|
||||
ConnectedSlow,
|
||||
}
|
||||
|
||||
export enum EBatteryState {
|
||||
Unknown,
|
||||
Discharging,
|
||||
Charging,
|
||||
Full,
|
||||
}
|
||||
|
||||
export enum EStorageFormatStage {
|
||||
Invalid,
|
||||
NotRunning,
|
||||
Starting,
|
||||
Testing,
|
||||
Rescuing,
|
||||
Formatting,
|
||||
Finalizing,
|
||||
}
|
||||
|
||||
export interface FileDialog {
|
||||
/** Whether to choose a directory instead. */
|
||||
bChooseDirectory?: boolean;
|
||||
/**
|
||||
* Array of file filters.
|
||||
* @example
|
||||
* Example from the "Add a Non-Steam Game" dialog:
|
||||
* ```
|
||||
* [
|
||||
* {
|
||||
* strFileTypeName: LocalizationManager.LocalizeString("#AddNonSteam_Filter_Exe_Linux"),
|
||||
* rFilePatterns: [ "*.application", "*.exe", "*.sh", "*.AppImage" ],
|
||||
* bUseAsDefault: true,
|
||||
* },
|
||||
* {
|
||||
* strFileTypeName: LocalizationManager.LocalizeString("#AddNonSteam_Filter_All"),
|
||||
* rFilePatterns: [ "*" ],
|
||||
* }
|
||||
* ]
|
||||
* ```
|
||||
*/
|
||||
rgFilters?: FileDialogFilter[];
|
||||
/** Initially selected file. */
|
||||
strInitialFile?: string;
|
||||
/** Window title. */
|
||||
strTitle?: string;
|
||||
}
|
||||
|
||||
export interface FileDialogFilter {
|
||||
/** A localization string for the file type. */
|
||||
strFileTypeName: string;
|
||||
/**
|
||||
* File patterns.
|
||||
* @example [ "*.application", "*.exe", "*.sh", "*.AppImage" ]
|
||||
*/
|
||||
rFilePatterns: string[];
|
||||
/** Whether to use this filter by default. */
|
||||
bUseAsDefault?: boolean;
|
||||
}
|
||||
|
||||
export enum EOSType {
|
||||
Web = -700,
|
||||
Ios = -600,
|
||||
Android = -500,
|
||||
Android6 = -499,
|
||||
Android7 = -498,
|
||||
Android8 = -497,
|
||||
Android9 = -496,
|
||||
Ps3os = -300,
|
||||
Linux = -203,
|
||||
Linux22 = -202,
|
||||
Linux24 = -201,
|
||||
Linux26 = -200,
|
||||
Linux32 = -199,
|
||||
Linux35 = -198,
|
||||
Linux36 = -197,
|
||||
Linux310 = -196,
|
||||
Linux316 = -195,
|
||||
Linux318 = -194,
|
||||
Linux3x = -193,
|
||||
Linux4x = -192,
|
||||
Linux41 = -191,
|
||||
Linux44 = -190,
|
||||
Linux49 = -189,
|
||||
Linux414 = -188,
|
||||
Linux419 = -187,
|
||||
Linux5x = -186,
|
||||
Linux54 = -185,
|
||||
Linux6x = -184,
|
||||
Linux7x = -183,
|
||||
Linux510 = -182,
|
||||
Macos = -102,
|
||||
Macos104 = -101,
|
||||
Macos105 = -100,
|
||||
Macos1058 = -99,
|
||||
Macos106_unused1 = -98,
|
||||
Macos106_unused2 = -97,
|
||||
Macos106_unused3 = -96,
|
||||
Macos106 = -95,
|
||||
Macos1063 = -94,
|
||||
Macos1064_slgu = -93,
|
||||
Macos1067 = -92,
|
||||
Macos1067_unused = -91,
|
||||
Macos107 = -90,
|
||||
Macos108 = -89,
|
||||
Macos109 = -88,
|
||||
Macos1010 = -87,
|
||||
Macos1011 = -86,
|
||||
Macos1012 = -85,
|
||||
Macos1013 = -84,
|
||||
Macos1014 = -83,
|
||||
Macos1015 = -82,
|
||||
Macos1016 = -81,
|
||||
Macos11 = -80,
|
||||
Macos111 = -79,
|
||||
Macos1017 = -78,
|
||||
Macos12 = -77,
|
||||
Macos1018 = -76,
|
||||
Macos13 = -75,
|
||||
Macos1019 = -74,
|
||||
Macos14 = -73,
|
||||
Macos1020 = -72,
|
||||
Macos15 = -71,
|
||||
Unknown = -1,
|
||||
Windows = 0,
|
||||
Win311 = 1,
|
||||
Win95 = 2,
|
||||
Win98 = 3,
|
||||
WinME = 4,
|
||||
WinNT = 5,
|
||||
Win200 = 6,
|
||||
WinXP = 7,
|
||||
Win2003 = 8,
|
||||
WinVista = 9,
|
||||
Win7 = 10,
|
||||
Win2008 = 11,
|
||||
Win2012 = 12,
|
||||
Win8 = 13,
|
||||
Win81 = 14,
|
||||
Win2012R2 = 15,
|
||||
Win10 = 16,
|
||||
Win2016 = 17,
|
||||
Win2019 = 18,
|
||||
Win2022 = 19,
|
||||
Win11 = 20,
|
||||
}
|
||||
|
||||
export interface SystemInfo {
|
||||
sOSName: string;
|
||||
sKernelVersion: string;
|
||||
sBIOSVersion: string;
|
||||
sHostname: string;
|
||||
sOSCodename: string;
|
||||
sOSVariantId: string;
|
||||
sOSVersionId: string;
|
||||
sOSBuildId: string;
|
||||
nSteamVersion: number;
|
||||
sSteamBuildDate: string;
|
||||
sSteamAPI: string;
|
||||
sCPUVendor: string;
|
||||
sCPUName: string;
|
||||
nCPUHz: number;
|
||||
nCPUPhysicalCores: number;
|
||||
nCPULogicalCores: number;
|
||||
nSystemRAMSizeMB: number;
|
||||
sVideoCardName: string;
|
||||
sVideoDriverVersion: string;
|
||||
nVideoRAMSizeMB: number;
|
||||
bIsUnsupportedPrototypeHardware: boolean;
|
||||
}
|
||||
|
||||
export interface CMsgSystemManagerSettings extends JsPbMessage {
|
||||
display_adaptive_brightness_enabled(): boolean;
|
||||
|
||||
display_colorgamut(): number;
|
||||
|
||||
display_colorgamut_labelset(): number;
|
||||
|
||||
display_colortemp(): number;
|
||||
|
||||
display_colortemp_default(): number;
|
||||
|
||||
display_colortemp_enabled(): boolean;
|
||||
|
||||
display_diagnostics_enabled(): boolean;
|
||||
|
||||
display_nightmode_blend(): number;
|
||||
|
||||
display_nightmode_enabled(): boolean;
|
||||
|
||||
display_nightmode_maxhue(): number;
|
||||
|
||||
display_nightmode_maxsat(): number;
|
||||
|
||||
display_nightmode_schedule_enabled(): boolean;
|
||||
|
||||
display_nightmode_schedule_endtime(): number;
|
||||
|
||||
display_nightmode_schedule_starttime(): number;
|
||||
|
||||
display_nightmode_tintstrength(): number;
|
||||
|
||||
display_nightmode_uiexp(): number;
|
||||
|
||||
fan_control_mode(): number;
|
||||
|
||||
idle_backlight_dim_ac_seconds(): number;
|
||||
|
||||
idle_backlight_dim_battery_seconds(): number;
|
||||
|
||||
idle_suspend_ac_seconds(): number;
|
||||
|
||||
idle_suspend_battery_seconds(): number;
|
||||
|
||||
idle_suspend_supressed(): boolean;
|
||||
|
||||
is_adaptive_brightness_available(): boolean;
|
||||
|
||||
is_display_brightness_available(): boolean;
|
||||
|
||||
is_display_colormanagement_available(): boolean;
|
||||
|
||||
is_display_colortemp_available(): boolean;
|
||||
|
||||
is_fan_control_available(): boolean;
|
||||
|
||||
is_wifi_powersave_enabled(): boolean;
|
||||
}
|
||||
17
src/globals/steam-client/system/network/Device.ts
Normal file
17
src/globals/steam-client/system/network/Device.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { OperationResponse } from "../../shared";
|
||||
|
||||
export interface Device {
|
||||
/**
|
||||
* @param base64 Serialized base64 message from `CMsgNetworkDeviceConnect`.
|
||||
*/
|
||||
Connect(base64: string): Promise<OperationResponse>;
|
||||
Disconnect(deviceId: number): Promise<OperationResponse>;
|
||||
|
||||
WirelessNetwork: WirelessNetwork;
|
||||
}
|
||||
|
||||
export interface WirelessNetwork {
|
||||
Forget(deviceId: any, deviceWapId: any): any;
|
||||
|
||||
SetAutoconnect(deviceId: any, deviceWapId: any, autoConnect: boolean): any;
|
||||
}
|
||||
403
src/globals/steam-client/system/network/index.ts
Normal file
403
src/globals/steam-client/system/network/index.ts
Normal file
@@ -0,0 +1,403 @@
|
||||
import { JsPbMessage, OperationResponse, Unregisterable } from "../../shared";
|
||||
import {Device} from "./Device";
|
||||
|
||||
export interface Network {
|
||||
Device: Device;
|
||||
|
||||
ForceRefresh(): Promise<OperationResponse>;
|
||||
|
||||
ForceTestConnectivity(): void;
|
||||
|
||||
GetProxyInfo(): Promise<ProxyInfo>;
|
||||
|
||||
RegisterForAppSummaryUpdate(callback: (data: AppSummary) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* If `state` is deserialized, returns {@link CGameNetworkingUI_ConnectionState}.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForConnectionStateUpdate(callback: (state: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
RegisterForConnectivityTestChanges(callback: (connectivityTest: ConnectivityTest) => void): Unregisterable;
|
||||
|
||||
/**
|
||||
* If `data` is deserialized, returns {@link CMsgNetworkDevicesData}.
|
||||
* @returns an object that can be used to unregister the callback.
|
||||
*/
|
||||
RegisterForDeviceChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
|
||||
|
||||
SetFakeLocalSystemState(state: ENetFakeLocalSystemState): void;
|
||||
|
||||
SetProxyInfo(mode: number, address: string, port: number, excludeLocal: boolean): void;
|
||||
|
||||
SetWifiEnabled(value: boolean): Promise<OperationResponse>;
|
||||
|
||||
StartScanningForNetworks(): Promise<OperationResponse>;
|
||||
|
||||
StopScanningForNetworks(): Promise<OperationResponse>;
|
||||
}
|
||||
|
||||
export interface ConnectivityTest {
|
||||
eConnectivityTestResult: EConnectivityTestResult;
|
||||
eFakeState: ENetFakeLocalSystemState;
|
||||
bChecking: boolean;
|
||||
}
|
||||
|
||||
export enum EConnectivityTestResult {
|
||||
Unknown,
|
||||
Connected,
|
||||
CaptivePortal,
|
||||
TimedOut,
|
||||
Failed,
|
||||
WifiDisabled,
|
||||
NoLAN,
|
||||
}
|
||||
|
||||
export interface ProxyInfo {
|
||||
proxy_mode: number;
|
||||
address: string;
|
||||
port: number;
|
||||
exclude_local: boolean;
|
||||
}
|
||||
|
||||
interface AppSummary {
|
||||
nAppID: number;
|
||||
/**
|
||||
* If deserialized, returns {@link CGameNetworkingUI_AppSummary}.
|
||||
*/
|
||||
serializedMessage: ArrayBuffer;
|
||||
}
|
||||
|
||||
export enum ENetFakeLocalSystemState {
|
||||
Normal,
|
||||
NoLAN,
|
||||
CaptivePortal_Redirected,
|
||||
CaptivePortal_InPlace,
|
||||
NoInternet,
|
||||
NoSteam,
|
||||
}
|
||||
|
||||
export interface CMsgNetworkDevicesData extends JsPbMessage {
|
||||
devices(): NetworkDevice[];
|
||||
|
||||
is_wifi_enabled(): boolean;
|
||||
|
||||
is_wifi_scanning_enabled(): boolean;
|
||||
}
|
||||
|
||||
export interface CGameNetworkingUI_ConnectionSummary {
|
||||
transport_kind?: number;
|
||||
connection_state?: number;
|
||||
sdrpop_local?: number;
|
||||
sdrpop_remote?: number;
|
||||
ping_ms?: number;
|
||||
packet_loss?: number;
|
||||
ping_default_internet_route?: number;
|
||||
ip_was_shared?: number;
|
||||
}
|
||||
|
||||
export interface CGameNetworkingUI_AppSummary {
|
||||
appid?: number;
|
||||
ip_was_shared_with_friend?: boolean;
|
||||
ip_was_shared_with_nonfriend?: boolean;
|
||||
active_connections?: number;
|
||||
main_cxn?: CGameNetworkingUI_ConnectionSummary;
|
||||
}
|
||||
|
||||
export interface SteamDatagramLinkInstantaneousStats {
|
||||
out_packets_per_sec_x10: number | undefined;
|
||||
out_bytes_per_sec: number | undefined;
|
||||
in_packets_per_sec_x10: number | undefined;
|
||||
in_bytes_per_sec: number | undefined;
|
||||
ping_ms: number | undefined;
|
||||
packets_dropped_pct: number | undefined;
|
||||
packets_weird_sequence_pct: number | undefined;
|
||||
peak_jitter_usec: number | undefined;
|
||||
}
|
||||
|
||||
export interface SteamDatagramLinkLifetimeStats {
|
||||
connected_seconds: number | undefined;
|
||||
packets_sent: number | undefined;
|
||||
kb_sent: number | undefined;
|
||||
packets_recv: number | undefined;
|
||||
kb_recv: number | undefined;
|
||||
packets_recv_sequenced: number | undefined;
|
||||
packets_recv_dropped: number | undefined;
|
||||
packets_recv_out_of_order: number | undefined;
|
||||
packets_recv_out_of_order_corrected: number | undefined;
|
||||
packets_recv_duplicate: number | undefined;
|
||||
packets_recv_lurch: number | undefined;
|
||||
multipath_packets_recv_sequenced: number[];
|
||||
multipath_packets_recv_later: number[];
|
||||
multipath_send_enabled: number | undefined;
|
||||
quality_histogram_100: number | undefined;
|
||||
quality_histogram_99: number | undefined;
|
||||
quality_histogram_97: number | undefined;
|
||||
quality_histogram_95: number | undefined;
|
||||
quality_histogram_90: number | undefined;
|
||||
quality_histogram_75: number | undefined;
|
||||
quality_histogram_50: number | undefined;
|
||||
quality_histogram_1: number | undefined;
|
||||
quality_histogram_dead: number | undefined;
|
||||
quality_ntile_2nd: number | undefined;
|
||||
quality_ntile_5th: number | undefined;
|
||||
quality_ntile_25th: number | undefined;
|
||||
quality_ntile_50th: number | undefined;
|
||||
ping_histogram_25: number | undefined;
|
||||
ping_histogram_50: number | undefined;
|
||||
ping_histogram_75: number | undefined;
|
||||
ping_histogram_100: number | undefined;
|
||||
ping_histogram_125: number | undefined;
|
||||
ping_histogram_150: number | undefined;
|
||||
ping_histogram_200: number | undefined;
|
||||
ping_histogram_300: number | undefined;
|
||||
ping_histogram_max: number | undefined;
|
||||
ping_ntile_5th: number | undefined;
|
||||
ping_ntile_50th: number | undefined;
|
||||
ping_ntile_75th: number | undefined;
|
||||
ping_ntile_95th: number | undefined;
|
||||
ping_ntile_98th: number | undefined;
|
||||
jitter_histogram_negligible: number | undefined;
|
||||
jitter_histogram_1: number | undefined;
|
||||
jitter_histogram_2: number | undefined;
|
||||
jitter_histogram_5: number | undefined;
|
||||
jitter_histogram_10: number | undefined;
|
||||
jitter_histogram_20: number | undefined;
|
||||
txspeed_max: number | undefined;
|
||||
txspeed_histogram_16: number | undefined;
|
||||
txspeed_histogram_32: number | undefined;
|
||||
txspeed_histogram_64: number | undefined;
|
||||
txspeed_histogram_128: number | undefined;
|
||||
txspeed_histogram_256: number | undefined;
|
||||
txspeed_histogram_512: number | undefined;
|
||||
txspeed_histogram_1024: number | undefined;
|
||||
txspeed_histogram_max: number | undefined;
|
||||
txspeed_ntile_5th: number | undefined;
|
||||
txspeed_ntile_50th: number | undefined;
|
||||
txspeed_ntile_75th: number | undefined;
|
||||
txspeed_ntile_95th: number | undefined;
|
||||
txspeed_ntile_98th: number | undefined;
|
||||
rxspeed_max: number | undefined;
|
||||
rxspeed_histogram_16: number | undefined;
|
||||
rxspeed_histogram_32: number | undefined;
|
||||
rxspeed_histogram_64: number | undefined;
|
||||
rxspeed_histogram_128: number | undefined;
|
||||
rxspeed_histogram_256: number | undefined;
|
||||
rxspeed_histogram_512: number | undefined;
|
||||
rxspeed_histogram_1024: number | undefined;
|
||||
rxspeed_histogram_max: number | undefined;
|
||||
rxspeed_ntile_5th: number | undefined;
|
||||
rxspeed_ntile_50th: number | undefined;
|
||||
rxspeed_ntile_75th: number | undefined;
|
||||
rxspeed_ntile_95th: number | undefined;
|
||||
rxspeed_ntile_98th: number | undefined;
|
||||
}
|
||||
|
||||
export interface SteamDatagramConnectionQuality {
|
||||
instantaneous: SteamDatagramLinkInstantaneousStats | undefined;
|
||||
lifetime: SteamDatagramLinkLifetimeStats | undefined;
|
||||
}
|
||||
|
||||
export interface SteamNetworkingICESessionSummary {
|
||||
failure_reason_code: number | undefined;
|
||||
local_candidate_types: number | undefined;
|
||||
remote_candidate_types: number | undefined;
|
||||
initial_route_kind: number | undefined;
|
||||
initial_ping: number | undefined;
|
||||
initial_score: number | undefined;
|
||||
negotiation_ms: number | undefined;
|
||||
best_route_kind: number | undefined;
|
||||
best_ping: number | undefined;
|
||||
best_score: number | undefined;
|
||||
best_time: number | undefined;
|
||||
selected_seconds: number | undefined;
|
||||
user_settings: number | undefined;
|
||||
ice_enable_var: number | undefined;
|
||||
local_candidate_types_allowed: number | undefined;
|
||||
}
|
||||
|
||||
export interface SteamNetworkingP2PSDRRoutingSummary {
|
||||
initial_ping: number | undefined;
|
||||
initial_ping_front_local: number | undefined;
|
||||
initial_ping_front_remote: number | undefined;
|
||||
initial_score: number | undefined;
|
||||
initial_pop_local: number | undefined;
|
||||
initial_pop_remote: number | undefined;
|
||||
best_ping: number | undefined;
|
||||
best_ping_front_local: number | undefined;
|
||||
best_ping_front_remote: number | undefined;
|
||||
best_score: number | undefined;
|
||||
best_pop_local: number | undefined;
|
||||
best_pop_remote: number | undefined;
|
||||
best_time: number | undefined;
|
||||
negotiation_ms: number | undefined;
|
||||
selected_seconds: number | undefined;
|
||||
}
|
||||
|
||||
export interface SteamDatagramP2PRoutingSummary {
|
||||
ice: SteamNetworkingICESessionSummary | undefined;
|
||||
sdr: SteamNetworkingP2PSDRRoutingSummary | undefined;
|
||||
}
|
||||
|
||||
export interface CGameNetworkingUI_ConnectionState extends JsPbMessage {
|
||||
connection_key(): string;
|
||||
|
||||
appid(): number;
|
||||
|
||||
connection_id_local(): number;
|
||||
|
||||
identity_local(): string;
|
||||
|
||||
identity_remote(): string;
|
||||
|
||||
connection_state(): number;
|
||||
|
||||
start_time(): number;
|
||||
|
||||
close_time(): number;
|
||||
|
||||
close_reason(): number;
|
||||
|
||||
close_message(): string;
|
||||
|
||||
status_loc_token(): string;
|
||||
|
||||
transport_kind(): number;
|
||||
|
||||
sdrpopid_local(): string;
|
||||
|
||||
sdrpopid_remote(): string;
|
||||
|
||||
address_remote(): string;
|
||||
|
||||
p2p_routing(): SteamDatagramP2PRoutingSummary;
|
||||
|
||||
ping_interior(): number;
|
||||
|
||||
ping_remote_front(): number;
|
||||
|
||||
ping_default_internet_route(): number;
|
||||
|
||||
e2e_quality_local(): SteamDatagramConnectionQuality;
|
||||
|
||||
e2e_quality_remote(): SteamDatagramConnectionQuality;
|
||||
|
||||
e2e_quality_remote_instantaneous_time(): string;
|
||||
|
||||
e2e_quality_remote_lifetime_time(): string;
|
||||
|
||||
front_quality_local(): SteamDatagramConnectionQuality;
|
||||
|
||||
front_quality_remote(): SteamDatagramConnectionQuality;
|
||||
|
||||
front_quality_remote_instantaneous_time(): string;
|
||||
|
||||
front_quality_remote_lifetime_time(): string;
|
||||
}
|
||||
|
||||
export interface NetworkDevice_Wireless {
|
||||
aps: WirelessAP[];
|
||||
/**
|
||||
* @remarks Not present if wired.
|
||||
* @todo enum
|
||||
*/
|
||||
esecurity_supported?: number;
|
||||
}
|
||||
|
||||
export interface WirelessAP {
|
||||
esecurity: EWirelessSecurityFlags;
|
||||
estrength: EWirelessEndpointStrength;
|
||||
id: number;
|
||||
is_active: boolean;
|
||||
is_autoconnect: boolean;
|
||||
password: string;
|
||||
ssid: string;
|
||||
strength_raw: number;
|
||||
user_name?: string;
|
||||
}
|
||||
|
||||
export enum EWirelessSecurityFlags {
|
||||
None,
|
||||
StaticWep = 1 << 0,
|
||||
DynamicWep = 1 << 1,
|
||||
Wpa = 1 << 2,
|
||||
WpaEnterprise = 1 << 3,
|
||||
Wpa2 = 1 << 4,
|
||||
Wpa2Enterprise = 1 << 5,
|
||||
/**
|
||||
* Special value to indicate that this platform does not support
|
||||
* the security methods required to connect to an access point
|
||||
*/
|
||||
Unsupported = 1 << 15,
|
||||
}
|
||||
|
||||
export interface NetworkDevice_Wired {
|
||||
friendly_name: string;
|
||||
is_cable_present: boolean;
|
||||
speed_mbit: number;
|
||||
}
|
||||
|
||||
export interface NetworkDevice {
|
||||
estate: ENetworkDeviceState;
|
||||
etype: ENetworkDeviceType;
|
||||
id: number;
|
||||
ipv4: {
|
||||
addresses: NetworkDeviceIPv4Address[];
|
||||
};
|
||||
ipv6: {
|
||||
addresses: NetworkDeviceIPv6Address[];
|
||||
};
|
||||
mac: string;
|
||||
product: string;
|
||||
vendor: string;
|
||||
/**
|
||||
* @remarks Present only if wired.
|
||||
*/
|
||||
wired?: NetworkDevice_Wired;
|
||||
/**
|
||||
* @remarks Present even if wired.
|
||||
*/
|
||||
wireless: NetworkDevice_Wireless;
|
||||
}
|
||||
|
||||
export interface NetworkDeviceIPv4Address {
|
||||
ip: number;
|
||||
netmask: number;
|
||||
}
|
||||
|
||||
export interface NetworkDeviceIPv6Address {
|
||||
ip: string;
|
||||
}
|
||||
|
||||
export interface NetworkDeviceIP {
|
||||
dns_ip: number[];
|
||||
gateway_ip: number;
|
||||
is_default_route: boolean;
|
||||
is_dhcp_enabled: boolean;
|
||||
is_enabled: boolean;
|
||||
}
|
||||
|
||||
export enum ENetworkDeviceState {
|
||||
NotPresent,
|
||||
Failed,
|
||||
Disconnected,
|
||||
Disconnecting,
|
||||
Connecting,
|
||||
Connected,
|
||||
Retrying,
|
||||
}
|
||||
|
||||
export enum ENetworkDeviceType {
|
||||
Unknown,
|
||||
Wired,
|
||||
Wireless,
|
||||
Virtual,
|
||||
}
|
||||
|
||||
export enum EWirelessEndpointStrength {
|
||||
None,
|
||||
Weak,
|
||||
Ok,
|
||||
Good,
|
||||
Excellent,
|
||||
}
|
||||
@@ -1,5 +1,21 @@
|
||||
import { WindowRouter } from '../modules/Router';
|
||||
import { AppDetails, LogoPosition, SteamAppOverview } from './SteamClient';
|
||||
import { AppDetails, LogoPosition, SteamAppOverview } from "./steam-client/App";
|
||||
|
||||
interface AppData {
|
||||
details: AppDetails;
|
||||
// more
|
||||
}
|
||||
|
||||
interface AppStoreAppOverview extends SteamAppOverview {
|
||||
m_setStoreCategories: Set<number>;
|
||||
m_setStoreTags: Set<number>;
|
||||
m_strPerClientData: Set<any> | undefined;
|
||||
m_strAssociations: Set<any> | undefined;
|
||||
|
||||
BIsModOrShortcut: () => boolean;
|
||||
BIsShortcut: () => boolean;
|
||||
}
|
||||
|
||||
declare global {
|
||||
interface Window {
|
||||
LocalizationManager: {
|
||||
@@ -31,21 +47,22 @@ declare global {
|
||||
};
|
||||
appStore: {
|
||||
GetAppOverviewByAppID: (appId: number) => SteamAppOverview | null;
|
||||
GetCustomVerticalCapsuleURLs: (app: SteamAppOverview) => string[];
|
||||
GetCustomLandcapeImageURLs: (app: SteamAppOverview) => string[];
|
||||
GetCustomHeroImageURLs: (app: SteamAppOverview) => string[];
|
||||
GetCustomLogoImageURLs: (app: SteamAppOverview) => string[];
|
||||
GetLandscapeImageURLForApp: (app: SteamAppOverview) => string;
|
||||
GetVerticalCapsuleURLForApp: (app: SteamAppOverview) => string;
|
||||
GetCachedLandscapeImageURLForApp: (app: SteamAppOverview) => string;
|
||||
GetCachedVerticalImageURLForApp: (app: SteamAppOverview) => string;
|
||||
GetPregeneratedVerticalCapsuleForApp: (app: SteamAppOverview) => string;
|
||||
GetIconURLForApp: (app: SteamAppOverview) => string;
|
||||
GetCustomVerticalCapsuleURLs: (app: AppStoreAppOverview) => string[];
|
||||
GetCustomLandcapeImageURLs: (app: AppStoreAppOverview) => string[];
|
||||
GetCustomHeroImageURLs: (app: AppStoreAppOverview) => string[];
|
||||
GetCustomLogoImageURLs: (app: AppStoreAppOverview) => string[];
|
||||
GetLandscapeImageURLForApp: (app: AppStoreAppOverview) => string;
|
||||
GetVerticalCapsuleURLForApp: (app: AppStoreAppOverview) => string;
|
||||
GetCachedLandscapeImageURLForApp: (app: AppStoreAppOverview) => string;
|
||||
GetCachedVerticalImageURLForApp: (app: AppStoreAppOverview) => string;
|
||||
GetPregeneratedVerticalCapsuleForApp: (app: AppStoreAppOverview) => string;
|
||||
GetIconURLForApp: (app: AppStoreAppOverview) => string;
|
||||
};
|
||||
appDetailsStore: {
|
||||
GetAppData: (appId: number) => AppData | null;
|
||||
GetAppDetails: (appId: number) => AppDetails | null;
|
||||
GetCustomLogoPosition: (app: SteamAppOverview) => LogoPosition | null;
|
||||
SaveCustomLogoPosition: (app: SteamAppOverview, logoPositions: LogoPosition) => any;
|
||||
GetCustomLogoPosition: (app: AppStoreAppOverview) => LogoPosition | null;
|
||||
SaveCustomLogoPosition: (app: AppStoreAppOverview, logoPositions: LogoPosition) => any;
|
||||
};
|
||||
SteamUIStore: {
|
||||
GetFocusedWindowInstance: () => WindowRouter;
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import Logger from '../logger';
|
||||
import { Export, findModuleExport } from '../webpack';
|
||||
import {EDisplayStatus} from "../globals/steam-client/App";
|
||||
|
||||
export enum SideMenu {
|
||||
None,
|
||||
@@ -19,49 +20,10 @@ export enum QuickAccessTab {
|
||||
Decky = 999,
|
||||
}
|
||||
|
||||
export enum DisplayStatus {
|
||||
Invalid = 0,
|
||||
Launching = 1,
|
||||
Uninstalling = 2,
|
||||
Installing = 3,
|
||||
Running = 4,
|
||||
Validating = 5,
|
||||
Updating = 6,
|
||||
Downloading = 7,
|
||||
Synchronizing = 8,
|
||||
ReadyToInstall = 9,
|
||||
ReadyToPreload = 10,
|
||||
ReadyToLaunch = 11,
|
||||
RegionRestricted = 12,
|
||||
PresaleOnly = 13,
|
||||
InvalidPlatform = 14,
|
||||
PreloadComplete = 16,
|
||||
BorrowerLocked = 17,
|
||||
UpdatePaused = 18,
|
||||
UpdateQueued = 19,
|
||||
UpdateRequired = 20,
|
||||
UpdateDisabled = 21,
|
||||
DownloadPaused = 22,
|
||||
DownloadQueued = 23,
|
||||
DownloadRequired = 24,
|
||||
DownloadDisabled = 25,
|
||||
LicensePending = 26,
|
||||
LicenseExpired = 27,
|
||||
AvailForFree = 28,
|
||||
AvailToBorrow = 29,
|
||||
AvailGuestPass = 30,
|
||||
Purchase = 31,
|
||||
Unavailable = 32,
|
||||
NotLaunchable = 33,
|
||||
CloudError = 34,
|
||||
CloudOutOfDate = 35,
|
||||
Terminating = 36,
|
||||
}
|
||||
|
||||
export type AppOverview = {
|
||||
appid: string;
|
||||
display_name: string;
|
||||
display_status: DisplayStatus;
|
||||
display_status: EDisplayStatus;
|
||||
sort_as: string;
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user