Module api.type.modhubπ
Contains all type definitions for the modhub.
global record Modhub
record ModValidatorMessage
context: string file: string level: LogLevel message: string consoleOnly: boolean endrecord ModValidatorResult
messages: {ModValidatorMessage} criticalPc: boolean criticalConsole: boolean cookedPcPath: string cookedConsolePath: string levelPc: LogLevel levelConsole: LogLevel endrecord SortType
Trending: SortType Rating: SortType SubscriberCount: SortType DateAdded: SortType DateUpdated: SortType Name: SortType Source: SortType Custom: SortType endrecord TagGroup
name: string values: {string} allowMultipleSelection: boolean noSortTag: boolean visible: boolean endrecord SortAndFilterOptions
tagGroups: {TagGroup} sortOrders: {SortOrder} statusTagGroupIndex: integer endrecord UserId
new: function(integer): UserId equals: function(UserId, UserId): boolean isValid: function(UserId): boolean value: integer endrecord ModManagementMode
Disabled: ModManagementMode Restricted: ModManagementMode Full: ModManagementMode endrecord InstallState
None: InstallState Downloading: InstallState UpdatePending: InstallState Installed: InstallState DownloadPending: InstallState InstallationPending: InstallState UninstallPending: InstallState Extracting: InstallState InsufficientSpace: InstallState MiscError: InstallState endrecord ModInfo
modId: ModId modSource: string visible: boolean numDownloads: integer numSubscribers: integer title: string url: string summary: string description: string descriptionHtml: string logoImage: string installSize: integer likes: integer dislikes: integer rating: number tags: {string} publishedUnixTimestamp: integer updatedUnixTimestamp: integer releaseInfo: ModReleaseInfo memoryUsage: integer endrecord ModMediaType
Logo: ModMediaType GalleryThumb180p: ModMediaType GalleryThumb720p: ModMediaType GalleryOriginal: ModMediaType AuthorAvatar: ModMediaType endrecord AuthenticationType
Email: AuthenticationType Steam: AuthenticationType SteamOffline: AuthenticationType Gog: AuthenticationType Epic: AuthenticationType XboxLive: AuthenticationType PSN: AuthenticationType Paradox: AuthenticationType endrecord ReportType
Generic: ReportType DMCA: ReportType NotWorking: ReportType RudeContent: ReportType IllegalContent: ReportType StolenContent: ReportType FalseInformation: ReportType Other: ReportType endrecord ModManagementState
uploading: boolean busy: boolean totalPending: integer pending: {ModId} finished: {ModId} progress: number currentModId: ModId endrecord Capabilities
allowForceUninstall: boolean authenticationTypes: {AuthenticationType} manualRefresh: boolean specialModRefresh: boolean allowReport: boolean isInfoOnly: boolean allowUnsubscribeInstalledMods: boolean allowRestrictedMode: boolean allowModUpload: boolean visibleInModHub: boolean endrecord AuthenticateUserEmailRequest
new: function(string): AuthenticateUserEmailRequest authCode: string endrecord TermsOfUseRequest
new: function(AuthenticationType): TermsOfUseRequest type: AuthenticationType endrecord AuthenticateUserExternalRequest
new: function(AuthenticationType): AuthenticateUserExternalRequest type: AuthenticationType email: string endrecord AuthenticateUserExternalData
response: Response endrecord Response
UnkownError: Response PortalSignInError: Response ValidationError: Response Authenticated: Response endrecord LogoutData
endrecord ListModsRequest
new: function(): ListModsRequest page: integer preferedPageSize: integer searchString: string sortType: SortType sortAscending: boolean tags: {integer} fetchLongDescription: boolean endrecord ModDetailsData
new: function(): ModDetailsData modInfo: ModInfo author: string userId: UserId userPortal: UserPortal numGalleryImages: integer logoImage: string galleryImages: {string} dependencies: {{ModId, string}} found: boolean endrecord GetModMediaRequest
new: function(ModId, ModMediaType, integer): GetModMediaRequest modId: ModId type: ModMediaType galleryIndex: integer endrecord ModMediaData
new: function(): ModMediaData width: integer height: integer channels: integer data: {integer} data_native: Vector<integer> endrecord SubscribeModRequest
new: function(ModId): SubscribeModRequest modId: ModId includeDependencies: boolean endrecord SubscriptionData
endrecord RefreshData
numRefreshed: integer endrecord ForceUninstallModData
endrecord SpecialRefreshModRequest
new: function(ModId, boolean): SpecialRefreshModRequest modId: ModId unsubscribe: boolean endrecord SpecialRefreshModData
endrecord RestartModBackendData
endrecord SubmitModRatingRequest
new: function(ModId, RatingType): SubmitModRatingRequest modId: ModId rating: RatingType endrecord SubmitModReportRequest
new: function(ModId, ReportType, string, string, string): SubmitModReportRequest modId: ModId type: ReportType reportDescription: string reporterName: string reporterContact: string endtype BackendId = integerrecord AsyncResult<T>
isSuccess: function(AsyncResult<T>): boolean getData: function(AsyncResult<T>): T getError: function(AsyncResult<T>): ModHubErrorCode endrecord ModBrowserDisplayData
entries: {Entry} error: Modhub.ModHubErrorCode currentPage: integer numPages: integer displayPerPage: integer totalResults: integer appendResults: boolean searchString: string sortType: Modhub.SortType hasNoSortTag: boolean filterTags: {string} excludeTags: {string} endrecord ModBrowserDataProvider
new: function(BackendId, integer): ModBrowserDataProvider newForSelector: function(integer, function(Mod.ModId, Mod.ModId), {Mod.GameModDesc}): ModBrowserDataProvider suspend: function(ModBrowserDataProvider) resume: function(ModBrowserDataProvider) getDisplayData: function(ModBrowserDataProvider): ModBrowserDisplayData setLoadPage: function(ModBrowserDataProvider, integer) setNextContinuousPage: function(ModBrowserDataProvider) setCurrentPage: function(ModBrowserDataProvider, integer) setSearchString: function(ModBrowserDataProvider, string) setSearchUserId: function(ModBrowserDataProvider, UserId) setNextPage: function(ModBrowserDataProvider) setPreviousPage: function(ModBrowserDataProvider) refreshCurrentPage: function(ModBrowserDataProvider, boolean) getSortType: function(ModBrowserDataProvider): Modhub.SortType getTagToggled: function(ModBrowserDataProvider, string): boolean setSortType: function(ModBrowserDataProvider, SortType) setNextSortType: function(ModBrowserDataProvider) toggleTag: function(ModBrowserDataProvider, string) resetFilters: function(ModBrowserDataProvider) getSortAndFilterOptions: function(ModBrowserDataProvider): Modhub.SortAndFilterOptions endrecord StagingModData
equals: function(StagingModData, StagingModData): boolean localModhubDetails: Modhub.ModDetailsData state: State modhubId: Modhub.ModId modhubDetails: Modhub.ModDetailsData publishResult: AsyncResult<UploadModData> endrecord PublishSettings
new: function(): PublishSettings changeLog: string updateMetadata: boolean setPublic: boolean endendrecord ModPublishHelper
new: function(BackendId): ModPublishHelper hasAnyStagingMods: function(publishHelper : ModPublishHelper): boolean canRefresh: function(publishHelper : ModPublishHelper): boolean refresh: function(publishHelper : ModPublishHelper): AsyncResult<RefreshData> hasStagingMod: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): boolean getStagingModData: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): StagingModData setModDetails: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, modDetailsData : Modhub.ModDetailsData) setRemoteModId: function(publishHelper : ModPublishHelper, localModId : Modhub.ModId, remoteModId : Modhub.ModId) publish: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishSettings : PublishSettings, validationResult : Modhub.ModValidatorResult): AsyncResult<UploadModData> abortPublish: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): UniquePendingRequestId addLogoImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, image : string) removeLogoImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId) addGalleryImages: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, images : {string}) removeGalleryImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, index : integer) moveGalleryImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, fromIndex : integer, toIndex : integer) setPostPublishFn: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishFn : function(Modhub.ModId)) openFolder: function(publishHelper : ModPublishHelper, modId : Modhub.ModId) getSortAndFilterOptions: function(publishHelper : ModPublishHelper): Modhub.SortAndFilterOptions end
Category: mainπ
Modhubπ
global record Modhub
record ModValidatorMessage
context: string file: string level: LogLevel message: string consoleOnly: boolean endrecord ModValidatorResult
messages: {ModValidatorMessage} criticalPc: boolean criticalConsole: boolean cookedPcPath: string cookedConsolePath: string levelPc: LogLevel levelConsole: LogLevel endrecord SortType
Trending: SortType Rating: SortType SubscriberCount: SortType DateAdded: SortType DateUpdated: SortType Name: SortType Source: SortType Custom: SortType endrecord TagGroup
name: string values: {string} allowMultipleSelection: boolean noSortTag: boolean visible: boolean endrecord SortAndFilterOptions
tagGroups: {TagGroup} sortOrders: {SortOrder} statusTagGroupIndex: integer endrecord UserId
new: function(integer): UserId equals: function(UserId, UserId): boolean isValid: function(UserId): boolean value: integer endrecord ModManagementMode
Disabled: ModManagementMode Restricted: ModManagementMode Full: ModManagementMode endrecord InstallState
None: InstallState Downloading: InstallState UpdatePending: InstallState Installed: InstallState DownloadPending: InstallState InstallationPending: InstallState UninstallPending: InstallState Extracting: InstallState InsufficientSpace: InstallState MiscError: InstallState endrecord ModInfo
modId: ModId modSource: string visible: boolean numDownloads: integer numSubscribers: integer title: string url: string summary: string description: string descriptionHtml: string logoImage: string installSize: integer likes: integer dislikes: integer rating: number tags: {string} publishedUnixTimestamp: integer updatedUnixTimestamp: integer releaseInfo: ModReleaseInfo memoryUsage: integer endrecord ModMediaType
Logo: ModMediaType GalleryThumb180p: ModMediaType GalleryThumb720p: ModMediaType GalleryOriginal: ModMediaType AuthorAvatar: ModMediaType endrecord AuthenticationType
Email: AuthenticationType Steam: AuthenticationType SteamOffline: AuthenticationType Gog: AuthenticationType Epic: AuthenticationType XboxLive: AuthenticationType PSN: AuthenticationType Paradox: AuthenticationType endrecord ReportType
Generic: ReportType DMCA: ReportType NotWorking: ReportType RudeContent: ReportType IllegalContent: ReportType StolenContent: ReportType FalseInformation: ReportType Other: ReportType endrecord ModManagementState
uploading: boolean busy: boolean totalPending: integer pending: {ModId} finished: {ModId} progress: number currentModId: ModId endrecord Capabilities
allowForceUninstall: boolean authenticationTypes: {AuthenticationType} manualRefresh: boolean specialModRefresh: boolean allowReport: boolean isInfoOnly: boolean allowUnsubscribeInstalledMods: boolean allowRestrictedMode: boolean allowModUpload: boolean visibleInModHub: boolean endrecord AuthenticateUserEmailRequest
new: function(string): AuthenticateUserEmailRequest authCode: string endrecord TermsOfUseRequest
new: function(AuthenticationType): TermsOfUseRequest type: AuthenticationType endrecord AuthenticateUserExternalRequest
new: function(AuthenticationType): AuthenticateUserExternalRequest type: AuthenticationType email: string endrecord AuthenticateUserExternalData
response: Response endrecord Response
UnkownError: Response PortalSignInError: Response ValidationError: Response Authenticated: Response endrecord LogoutData
endrecord ListModsRequest
new: function(): ListModsRequest page: integer preferedPageSize: integer searchString: string sortType: SortType sortAscending: boolean tags: {integer} fetchLongDescription: boolean endrecord ModDetailsData
new: function(): ModDetailsData modInfo: ModInfo author: string userId: UserId userPortal: UserPortal numGalleryImages: integer logoImage: string galleryImages: {string} dependencies: {{ModId, string}} found: boolean endrecord GetModMediaRequest
new: function(ModId, ModMediaType, integer): GetModMediaRequest modId: ModId type: ModMediaType galleryIndex: integer endrecord ModMediaData
new: function(): ModMediaData width: integer height: integer channels: integer data: {integer} data_native: Vector<integer> endrecord SubscribeModRequest
new: function(ModId): SubscribeModRequest modId: ModId includeDependencies: boolean endrecord SubscriptionData
endrecord RefreshData
numRefreshed: integer endrecord ForceUninstallModData
endrecord SpecialRefreshModRequest
new: function(ModId, boolean): SpecialRefreshModRequest modId: ModId unsubscribe: boolean endrecord SpecialRefreshModData
endrecord RestartModBackendData
endrecord SubmitModRatingRequest
new: function(ModId, RatingType): SubmitModRatingRequest modId: ModId rating: RatingType endrecord SubmitModReportRequest
new: function(ModId, ReportType, string, string, string): SubmitModReportRequest modId: ModId type: ReportType reportDescription: string reporterName: string reporterContact: string endtype BackendId = integerrecord AsyncResult<T>
isSuccess: function(AsyncResult<T>): boolean getData: function(AsyncResult<T>): T getError: function(AsyncResult<T>): ModHubErrorCode endrecord ModBrowserDisplayData
entries: {Entry} error: Modhub.ModHubErrorCode currentPage: integer numPages: integer displayPerPage: integer totalResults: integer appendResults: boolean searchString: string sortType: Modhub.SortType hasNoSortTag: boolean filterTags: {string} excludeTags: {string} endrecord ModBrowserDataProvider
new: function(BackendId, integer): ModBrowserDataProvider newForSelector: function(integer, function(Mod.ModId, Mod.ModId), {Mod.GameModDesc}): ModBrowserDataProvider suspend: function(ModBrowserDataProvider) resume: function(ModBrowserDataProvider) getDisplayData: function(ModBrowserDataProvider): ModBrowserDisplayData setLoadPage: function(ModBrowserDataProvider, integer) setNextContinuousPage: function(ModBrowserDataProvider) setCurrentPage: function(ModBrowserDataProvider, integer) setSearchString: function(ModBrowserDataProvider, string) setSearchUserId: function(ModBrowserDataProvider, UserId) setNextPage: function(ModBrowserDataProvider) setPreviousPage: function(ModBrowserDataProvider) refreshCurrentPage: function(ModBrowserDataProvider, boolean) getSortType: function(ModBrowserDataProvider): Modhub.SortType getTagToggled: function(ModBrowserDataProvider, string): boolean setSortType: function(ModBrowserDataProvider, SortType) setNextSortType: function(ModBrowserDataProvider) toggleTag: function(ModBrowserDataProvider, string) resetFilters: function(ModBrowserDataProvider) getSortAndFilterOptions: function(ModBrowserDataProvider): Modhub.SortAndFilterOptions endrecord StagingModData
equals: function(StagingModData, StagingModData): boolean localModhubDetails: Modhub.ModDetailsData state: State modhubId: Modhub.ModId modhubDetails: Modhub.ModDetailsData publishResult: AsyncResult<UploadModData> endrecord PublishSettings
new: function(): PublishSettings changeLog: string updateMetadata: boolean setPublic: boolean endendrecord ModPublishHelper
new: function(BackendId): ModPublishHelper hasAnyStagingMods: function(publishHelper : ModPublishHelper): boolean canRefresh: function(publishHelper : ModPublishHelper): boolean refresh: function(publishHelper : ModPublishHelper): AsyncResult<RefreshData> hasStagingMod: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): boolean getStagingModData: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): StagingModData setModDetails: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, modDetailsData : Modhub.ModDetailsData) setRemoteModId: function(publishHelper : ModPublishHelper, localModId : Modhub.ModId, remoteModId : Modhub.ModId) publish: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishSettings : PublishSettings, validationResult : Modhub.ModValidatorResult): AsyncResult<UploadModData> abortPublish: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): UniquePendingRequestId addLogoImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, image : string) removeLogoImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId) addGalleryImages: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, images : {string}) removeGalleryImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, index : integer) moveGalleryImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, fromIndex : integer, toIndex : integer) setPostPublishFn: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishFn : function(Modhub.ModId)) openFolder: function(publishHelper : ModPublishHelper, modId : Modhub.ModId) getSortAndFilterOptions: function(publishHelper : ModPublishHelper): Modhub.SortAndFilterOptions end
modhub types
Modhub.ModValidatorMessageπ
record Modhub.ModValidatorMessage
context: string file: string level: LogLevel message: string consoleOnly: boolean end
Message from mod validator
Modhub.ModValidatorMessage.contextπ
Modhub.ModValidatorMessage.context: string
The context of the message, e.g. which check produced it
Modhub.ModValidatorMessage.fileπ
Modhub.ModValidatorMessage.file: string
The file path where the issue was found
Modhub.ModValidatorMessage.levelπ
Modhub.ModValidatorMessage.level: LogLevel
The severity level of the message
Modhub.ModValidatorMessage.messageπ
Modhub.ModValidatorMessage.message: string
The validation message
Modhub.ModValidatorMessage.consoleOnlyπ
Modhub.ModValidatorMessage.consoleOnly: boolean
Whether this issue only affects console platforms
Modhub.ModValidatorResultπ
record Modhub.ModValidatorResult
messages: {ModValidatorMessage} criticalPc: boolean criticalConsole: boolean cookedPcPath: string cookedConsolePath: string levelPc: LogLevel levelConsole: LogLevel end
Result from mod validation
Modhub.ModValidatorResult.messagesπ
Modhub.ModValidatorResult.messages: {ModValidatorMessage}
List of validation messages
Modhub.ModValidatorResult.criticalPcπ
Modhub.ModValidatorResult.criticalPc: boolean
Whether the validation found critical issues on PC
Modhub.ModValidatorResult.criticalConsoleπ
Modhub.ModValidatorResult.criticalConsole: boolean
Whether the validation found critical issues on console
Modhub.ModValidatorResult.cookedPcPathπ
Modhub.ModValidatorResult.cookedPcPath: string
Cooked PC Path
Modhub.ModValidatorResult.cookedConsolePathπ
Modhub.ModValidatorResult.cookedConsolePath: string
Cooked Console Path
Modhub.ModValidatorResult.levelPcπ
Modhub.ModValidatorResult.levelPc: LogLevel
Minimum log level found on PC
Modhub.ModValidatorResult.levelConsoleπ
Modhub.ModValidatorResult.levelConsole: LogLevel
Minimum log level found on console
Modhub.ModHubErrorCodeπ
Modhub.ModHubErrorCode.codeπ
Modhub.ModHubErrorCode.code: integer
Error Code Number
Modhub.ModHubErrorCode.messageπ
Modhub.ModHubErrorCode.message: string
Error Message (not localized, for debug purposes only)
Modhub.ModHubErrorCode.fieldsπ
Modhub.ModHubErrorCode.fields: {string : string}
Additional fields with more information about the error
Modhub.SortTypeπ
Modhub.SortType.Trendingπ
Modhub.SortType.Trending: SortType
Modhub.SortType.Ratingπ
Modhub.SortType.Rating: SortType
Modhub.SortType.SubscriberCountπ
Modhub.SortType.SubscriberCount: SortType
Modhub.SortType.DateAddedπ
Modhub.SortType.DateAdded: SortType
Modhub.SortType.DateUpdatedπ
Modhub.SortType.DateUpdated: SortType
Modhub.SortType.Nameπ
Modhub.SortType.Name: SortType
Modhub.SortType.Sourceπ
Modhub.SortType.Source: SortType
Modhub.SortType.Customπ
Modhub.SortType.Custom: SortType
Modhub.SortOrderπ
Modhub.SortOrder.sortTypeπ
Modhub.SortOrder.sortType: SortType
Modhub.SortOrder.allowAscDescπ
Modhub.SortOrder.allowAscDesc: boolean
Modhub.TagGroupπ
record Modhub.TagGroup
name: string values: {string} allowMultipleSelection: boolean noSortTag: boolean visible: boolean end
Modhub.TagGroup.nameπ
Modhub.TagGroup.name: string
Modhub.TagGroup.valuesπ
Modhub.TagGroup.values: {string}
Modhub.TagGroup.allowMultipleSelectionπ
Modhub.TagGroup.allowMultipleSelection: boolean
Modhub.TagGroup.noSortTagπ
Modhub.TagGroup.noSortTag: boolean
Modhub.TagGroup.visibleπ
Modhub.TagGroup.visible: boolean
Modhub.SortAndFilterOptionsπ
record Modhub.SortAndFilterOptions
tagGroups: {TagGroup} sortOrders: {SortOrder} statusTagGroupIndex: integer end
Modhub.SortAndFilterOptions.tagGroupsπ
Modhub.SortAndFilterOptions.tagGroups: {TagGroup}
Modhub.SortAndFilterOptions.sortOrdersπ
Modhub.SortAndFilterOptions.sortOrders: {SortOrder}
Modhub.SortAndFilterOptions.statusTagGroupIndexπ
Modhub.SortAndFilterOptions.statusTagGroupIndex: integer
Modhub.UserInfoπ
Modhub.UserInfo.userNameπ
Modhub.UserInfo.userName: string
Modhub.UserInfo.profileUrlπ
Modhub.UserInfo.profileUrl: string
Modhub.UserInfo.displayNameπ
Modhub.UserInfo.displayName: string
Modhub.ModIdπ
Modhub.ModId.newπ
function Modhub.ModId.new(): ModIdReturns
ModId
Modhub.ModId.isValidπ
function Modhub.ModId.isValid(ModId): booleanParameters
ModId
boolean
Modhub.ModId.valueπ
Modhub.ModId.value: string
Modhub.UserIdπ
Modhub.UserId.newπ
function Modhub.UserId.new(integer): UserIdParameters
integer
UserId
Modhub.UserId.equalsπ
function Modhub.UserId.equals(UserId, UserId): booleanParameters
UserIdUserId
boolean
Modhub.UserId.isValidπ
function Modhub.UserId.isValid(UserId): booleanParameters
UserId
boolean
Modhub.UserId.valueπ
Modhub.UserId.value: integer
Modhub.ModManagementModeπ
Modhub.ModManagementMode.Disabledπ
Modhub.ModManagementMode.Disabled: ModManagementMode
Modhub.ModManagementMode.Restrictedπ
Modhub.ModManagementMode.Restricted: ModManagementMode
Modhub.ModManagementMode.Fullπ
Modhub.ModManagementMode.Full: ModManagementMode
Modhub.InstallStateπ
record Modhub.InstallState
None: InstallState Downloading: InstallState UpdatePending: InstallState Installed: InstallState DownloadPending: InstallState InstallationPending: InstallState UninstallPending: InstallState Extracting: InstallState InsufficientSpace: InstallState MiscError: InstallState end
Modhub.InstallState.Noneπ
Modhub.InstallState.None: InstallState
Modhub.InstallState.Downloadingπ
Modhub.InstallState.Downloading: InstallState
Modhub.InstallState.UpdatePendingπ
Modhub.InstallState.UpdatePending: InstallState
Modhub.InstallState.Installedπ
Modhub.InstallState.Installed: InstallState
Modhub.InstallState.DownloadPendingπ
Modhub.InstallState.DownloadPending: InstallState
Modhub.InstallState.InstallationPendingπ
Modhub.InstallState.InstallationPending: InstallState
Modhub.InstallState.UninstallPendingπ
Modhub.InstallState.UninstallPending: InstallState
Modhub.InstallState.Extractingπ
Modhub.InstallState.Extracting: InstallState
Modhub.InstallState.InsufficientSpaceπ
Modhub.InstallState.InsufficientSpace: InstallState
Modhub.InstallState.MiscErrorπ
Modhub.InstallState.MiscError: InstallState
Modhub.ModInstallInfoπ
Modhub.ModInstallInfo.installPathπ
Modhub.ModInstallInfo.installPath: string
Modhub.ModInstallInfo.runtimeRevisionπ
Modhub.ModInstallInfo.runtimeRevision: integer
Modhub.ModReleaseInfoπ
Modhub.ModReleaseInfo.versionπ
Modhub.ModReleaseInfo.version: string
Modhub.ModReleaseInfo.releaseNotesπ
Modhub.ModReleaseInfo.releaseNotes: string
Modhub.ModReleaseInfo.releaseUnixTimestampπ
Modhub.ModReleaseInfo.releaseUnixTimestamp: integer
Modhub.ModInfoπ
record Modhub.ModInfo
modId: ModId modSource: string visible: boolean numDownloads: integer numSubscribers: integer title: string url: string summary: string description: string descriptionHtml: string logoImage: string installSize: integer likes: integer dislikes: integer rating: number tags: {string} publishedUnixTimestamp: integer updatedUnixTimestamp: integer releaseInfo: ModReleaseInfo memoryUsage: integer end
Modhub.ModInfo.modIdπ
Modhub.ModInfo.modId: ModId
Modhub.ModInfo.modSourceπ
Modhub.ModInfo.modSource: string
Modhub.ModInfo.visibleπ
Modhub.ModInfo.visible: boolean
Modhub.ModInfo.numDownloadsπ
Modhub.ModInfo.numDownloads: integer
Modhub.ModInfo.numSubscribersπ
Modhub.ModInfo.numSubscribers: integer
Modhub.ModInfo.titleπ
Modhub.ModInfo.title: string
Modhub.ModInfo.urlπ
Modhub.ModInfo.url: string
Modhub.ModInfo.summaryπ
Modhub.ModInfo.summary: string
Modhub.ModInfo.descriptionπ
Modhub.ModInfo.description: string
Modhub.ModInfo.descriptionHtmlπ
Modhub.ModInfo.descriptionHtml: string
Modhub.ModInfo.logoImageπ
Modhub.ModInfo.logoImage: string
Modhub.ModInfo.installSizeπ
Modhub.ModInfo.installSize: integer
Modhub.ModInfo.likesπ
Modhub.ModInfo.likes: integer
Modhub.ModInfo.dislikesπ
Modhub.ModInfo.dislikes: integer
Modhub.ModInfo.ratingπ
Modhub.ModInfo.rating: number
Modhub.ModInfo.tagsπ
Modhub.ModInfo.tags: {string}
Modhub.ModInfo.publishedUnixTimestampπ
Modhub.ModInfo.publishedUnixTimestamp: integer
Modhub.ModInfo.updatedUnixTimestampπ
Modhub.ModInfo.updatedUnixTimestamp: integer
Modhub.ModInfo.releaseInfoπ
Modhub.ModInfo.releaseInfo: ModReleaseInfo
Modhub.ModInfo.memoryUsageπ
Modhub.ModInfo.memoryUsage: integer
Modhub.ModMediaTypeπ
Modhub.ModMediaType.Logoπ
Modhub.ModMediaType.Logo: ModMediaType
Modhub.ModMediaType.GalleryThumb180pπ
Modhub.ModMediaType.GalleryThumb180p: ModMediaType
Modhub.ModMediaType.GalleryThumb720pπ
Modhub.ModMediaType.GalleryThumb720p: ModMediaType
Modhub.ModMediaType.GalleryOriginalπ
Modhub.ModMediaType.GalleryOriginal: ModMediaType
Modhub.ModMediaType.AuthorAvatarπ
Modhub.ModMediaType.AuthorAvatar: ModMediaType
Modhub.AuthenticationTypeπ
Modhub.AuthenticationType.Emailπ
Modhub.AuthenticationType.Email: AuthenticationType
Modhub.AuthenticationType.Steamπ
Modhub.AuthenticationType.Steam: AuthenticationType
Modhub.AuthenticationType.SteamOfflineπ
Modhub.AuthenticationType.SteamOffline: AuthenticationType
Modhub.AuthenticationType.Gogπ
Modhub.AuthenticationType.Gog: AuthenticationType
Modhub.AuthenticationType.Epicπ
Modhub.AuthenticationType.Epic: AuthenticationType
Modhub.AuthenticationType.XboxLiveπ
Modhub.AuthenticationType.XboxLive: AuthenticationType
Modhub.AuthenticationType.PSNπ
Modhub.AuthenticationType.PSN: AuthenticationType
Modhub.AuthenticationType.Paradoxπ
Modhub.AuthenticationType.Paradox: AuthenticationType
Modhub.RatingTypeπ
Modhub.RatingType.Neutralπ
Modhub.RatingType.Neutral: RatingType
Modhub.RatingType.Positiveπ
Modhub.RatingType.Positive: RatingType
Modhub.RatingType.Negativeπ
Modhub.RatingType.Negative: RatingType
Modhub.ReportTypeπ
Modhub.ReportType.Genericπ
Modhub.ReportType.Generic: ReportType
Modhub.ReportType.DMCAπ
Modhub.ReportType.DMCA: ReportType
Modhub.ReportType.NotWorkingπ
Modhub.ReportType.NotWorking: ReportType
Modhub.ReportType.RudeContentπ
Modhub.ReportType.RudeContent: ReportType
Modhub.ReportType.IllegalContentπ
Modhub.ReportType.IllegalContent: ReportType
Modhub.ReportType.StolenContentπ
Modhub.ReportType.StolenContent: ReportType
Modhub.ReportType.FalseInformationπ
Modhub.ReportType.FalseInformation: ReportType
Modhub.ReportType.Otherπ
Modhub.ReportType.Other: ReportType
Modhub.StorageInfoπ
Modhub.StorageInfo.usedSpaceπ
Modhub.StorageInfo.usedSpace: integer
Modhub.StorageInfo.totalSpaceπ
Modhub.StorageInfo.totalSpace: integer
Modhub.ModManagementStateπ
record Modhub.ModManagementState
uploading: boolean busy: boolean totalPending: integer pending: {ModId} finished: {ModId} progress: number currentModId: ModId end
Modhub.ModManagementState.uploadingπ
Modhub.ModManagementState.uploading: boolean
Modhub.ModManagementState.busyπ
Modhub.ModManagementState.busy: boolean
Modhub.ModManagementState.totalPendingπ
Modhub.ModManagementState.totalPending: integer
Modhub.ModManagementState.pendingπ
Modhub.ModManagementState.pending: {ModId}
Modhub.ModManagementState.finishedπ
Modhub.ModManagementState.finished: {ModId}
Modhub.ModManagementState.progressπ
Modhub.ModManagementState.progress: number
Modhub.ModManagementState.currentModIdπ
Modhub.ModManagementState.currentModId: ModId
Modhub.Capabilitiesπ
record Modhub.Capabilities
allowForceUninstall: boolean authenticationTypes: {AuthenticationType} manualRefresh: boolean specialModRefresh: boolean allowReport: boolean isInfoOnly: boolean allowUnsubscribeInstalledMods: boolean allowRestrictedMode: boolean allowModUpload: boolean visibleInModHub: boolean end
Modhub.Capabilities.allowForceUninstallπ
Modhub.Capabilities.allowForceUninstall: boolean
Modhub.Capabilities.authenticationTypesπ
Modhub.Capabilities.authenticationTypes: {AuthenticationType}
Modhub.Capabilities.manualRefreshπ
Modhub.Capabilities.manualRefresh: boolean
Modhub.Capabilities.specialModRefreshπ
Modhub.Capabilities.specialModRefresh: boolean
Modhub.Capabilities.allowReportπ
Modhub.Capabilities.allowReport: boolean
Modhub.Capabilities.isInfoOnlyπ
Modhub.Capabilities.isInfoOnly: boolean
Modhub.Capabilities.allowUnsubscribeInstalledModsπ
Modhub.Capabilities.allowUnsubscribeInstalledMods: boolean
Modhub.Capabilities.allowRestrictedModeπ
Modhub.Capabilities.allowRestrictedMode: boolean
Modhub.Capabilities.allowModUploadπ
Modhub.Capabilities.allowModUpload: boolean
Modhub.Capabilities.visibleInModHubπ
Modhub.Capabilities.visibleInModHub: boolean
Modhub.Descriptionπ
Modhub.Description.nameπ
Modhub.Description.name: string
Modhub.Description.nameLocalizedπ
Modhub.Description.nameLocalized: string
Modhub.Description.urlπ
Modhub.Description.url: string
Modhub.Description.iconπ
Modhub.Description.icon: string
Modhub.EmailAuthCodeRequestπ
Modhub.EmailAuthCodeRequest.newπ
function Modhub.EmailAuthCodeRequest.new(string): EmailAuthCodeRequestParameters
string
EmailAuthCodeRequest
Modhub.EmailAuthCodeRequest.emailπ
Modhub.EmailAuthCodeRequest.email: string
Modhub.EmailAuthCodeDataπ
Modhub.EmailAuthCodeData.Responseπ
Modhub.EmailAuthCodeData.Response.ValidationErrorπ
Modhub.EmailAuthCodeData.Response.ValidationError: Response
Modhub.EmailAuthCodeData.Response.NeedAuthCodeπ
Modhub.EmailAuthCodeData.Response.NeedAuthCode: Response
Modhub.EmailAuthCodeData.Response.Authenticatedπ
Modhub.EmailAuthCodeData.Response.Authenticated: Response
Modhub.EmailAuthCodeData.responseπ
Modhub.EmailAuthCodeData.response: Response
Modhub.AuthenticateUserEmailRequestπ
record Modhub.AuthenticateUserEmailRequest
new: function(string): AuthenticateUserEmailRequest authCode: string end
Modhub.AuthenticateUserEmailRequest.newπ
function Modhub.AuthenticateUserEmailRequest.new(string): AuthenticateUserEmailRequestParameters
string
AuthenticateUserEmailRequest
Modhub.AuthenticateUserEmailRequest.authCodeπ
Modhub.AuthenticateUserEmailRequest.authCode: string
Modhub.AuthenticateUserEmailDataπ
Modhub.AuthenticateUserEmailData.Responseπ
Modhub.AuthenticateUserEmailData.Response.ValidationErrorπ
Modhub.AuthenticateUserEmailData.Response.ValidationError: Response
Modhub.AuthenticateUserEmailData.Response.ExpiredAuthCodeπ
Modhub.AuthenticateUserEmailData.Response.ExpiredAuthCode: Response
Modhub.AuthenticateUserEmailData.Response.Authenticatedπ
Modhub.AuthenticateUserEmailData.Response.Authenticated: Response
Modhub.AuthenticateUserEmailData.responseπ
Modhub.AuthenticateUserEmailData.response: Response
Modhub.TermsOfUseRequestπ
record Modhub.TermsOfUseRequest
new: function(AuthenticationType): TermsOfUseRequest type: AuthenticationType end
Modhub.TermsOfUseRequest.newπ
function Modhub.TermsOfUseRequest.new(AuthenticationType): TermsOfUseRequestParameters
AuthenticationType
TermsOfUseRequest
Modhub.TermsOfUseRequest.typeπ
Modhub.TermsOfUseRequest.type: AuthenticationType
Modhub.TermsOfUseDataπ
Modhub.TermsOfUseData.termsπ
Modhub.TermsOfUseData.terms: string
Modhub.TermsOfUseData.agreeLabelπ
Modhub.TermsOfUseData.agreeLabel: string
Modhub.TermsOfUseData.disagreeLabelπ
Modhub.TermsOfUseData.disagreeLabel: string
Modhub.AuthenticateUserExternalRequestπ
record Modhub.AuthenticateUserExternalRequest
new: function(AuthenticationType): AuthenticateUserExternalRequest type: AuthenticationType email: string end
Modhub.AuthenticateUserExternalRequest.newπ
function Modhub.AuthenticateUserExternalRequest.new(AuthenticationType): AuthenticateUserExternalRequestParameters
AuthenticationType
AuthenticateUserExternalRequest
Modhub.AuthenticateUserExternalRequest.typeπ
Modhub.AuthenticateUserExternalRequest.type: AuthenticationType
Modhub.AuthenticateUserExternalRequest.emailπ
Modhub.AuthenticateUserExternalRequest.email: string
Modhub.AuthenticateUserExternalDataπ
record Modhub.AuthenticateUserExternalData
response: Response endrecord Response
UnkownError: Response PortalSignInError: Response ValidationError: Response Authenticated: Response end
Modhub.AuthenticateUserExternalData.Responseπ
Modhub.AuthenticateUserExternalData.Response.UnkownErrorπ
Modhub.AuthenticateUserExternalData.Response.UnkownError: Response
Modhub.AuthenticateUserExternalData.Response.PortalSignInErrorπ
Modhub.AuthenticateUserExternalData.Response.PortalSignInError: Response
Modhub.AuthenticateUserExternalData.Response.ValidationErrorπ
Modhub.AuthenticateUserExternalData.Response.ValidationError: Response
Modhub.AuthenticateUserExternalData.Response.Authenticatedπ
Modhub.AuthenticateUserExternalData.Response.Authenticated: Response
Modhub.AuthenticateUserExternalData.responseπ
Modhub.AuthenticateUserExternalData.response: Response
Modhub.LogoutDataπ
record Modhub.LogoutData
end
Modhub.ListModsRequestπ
record Modhub.ListModsRequest
new: function(): ListModsRequest page: integer preferedPageSize: integer searchString: string sortType: SortType sortAscending: boolean tags: {integer} fetchLongDescription: boolean end
Modhub.ListModsRequest.newπ
function Modhub.ListModsRequest.new(): ListModsRequestReturns
ListModsRequest
Modhub.ListModsRequest.pageπ
Modhub.ListModsRequest.page: integer
Modhub.ListModsRequest.preferedPageSizeπ
Modhub.ListModsRequest.preferedPageSize: integer
Modhub.ListModsRequest.searchStringπ
Modhub.ListModsRequest.searchString: string
Modhub.ListModsRequest.sortTypeπ
Modhub.ListModsRequest.sortType: SortType
Modhub.ListModsRequest.sortAscendingπ
Modhub.ListModsRequest.sortAscending: boolean
Modhub.ListModsRequest.tagsπ
Modhub.ListModsRequest.tags: {integer}
Modhub.ListModsRequest.fetchLongDescriptionπ
Modhub.ListModsRequest.fetchLongDescription: boolean
Modhub.ListModsDataπ
Modhub.ListModsData.modInfosπ
Modhub.ListModsData.modInfos: {ModInfo}
Modhub.ListModsData.modsPerPageπ
Modhub.ListModsData.modsPerPage: integer
Modhub.ListModsData.totalResultCountπ
Modhub.ListModsData.totalResultCount: integer
Modhub.GetModDetailsRequestπ
Modhub.GetModDetailsRequest.newπ
function Modhub.GetModDetailsRequest.new(ModId): GetModDetailsRequestParameters
ModId
GetModDetailsRequest
Modhub.GetModDetailsRequest.modIdπ
Modhub.GetModDetailsRequest.modId: ModId
Modhub.UserPortalπ
Modhub.UserPortal.XboxLiveπ
Modhub.UserPortal.XboxLive: UserPortal
Modhub.UserPortal.PlaystationNetworkπ
Modhub.UserPortal.PlaystationNetwork: UserPortal
Modhub.UserPortal.Miscπ
Modhub.UserPortal.Misc: UserPortal
Modhub.ModDetailsDataπ
record Modhub.ModDetailsData
new: function(): ModDetailsData modInfo: ModInfo author: string userId: UserId userPortal: UserPortal numGalleryImages: integer logoImage: string galleryImages: {string} dependencies: {{ModId, string}} found: boolean end
Modhub.ModDetailsData.newπ
function Modhub.ModDetailsData.new(): ModDetailsDataReturns
ModDetailsData
Modhub.ModDetailsData.modInfoπ
Modhub.ModDetailsData.modInfo: ModInfo
Modhub.ModDetailsData.authorπ
Modhub.ModDetailsData.author: string
Modhub.ModDetailsData.userIdπ
Modhub.ModDetailsData.userId: UserId
Modhub.ModDetailsData.userPortalπ
Modhub.ModDetailsData.userPortal: UserPortal
Modhub.ModDetailsData.numGalleryImagesπ
Modhub.ModDetailsData.numGalleryImages: integer
Modhub.ModDetailsData.logoImageπ
Modhub.ModDetailsData.logoImage: string
Modhub.ModDetailsData.galleryImagesπ
Modhub.ModDetailsData.galleryImages: {string}
Modhub.ModDetailsData.dependenciesπ
Modhub.ModDetailsData.dependencies: {{ModId, string}}
Modhub.ModDetailsData.foundπ
Modhub.ModDetailsData.found: boolean
Modhub.GetModMediaRequestπ
record Modhub.GetModMediaRequest
new: function(ModId, ModMediaType, integer): GetModMediaRequest modId: ModId type: ModMediaType galleryIndex: integer end
Modhub.GetModMediaRequest.newπ
function Modhub.GetModMediaRequest.new(ModId, ModMediaType, integer): GetModMediaRequestParameters
ModIdModMediaTypeinteger
GetModMediaRequest
Modhub.GetModMediaRequest.modIdπ
Modhub.GetModMediaRequest.modId: ModId
Modhub.GetModMediaRequest.typeπ
Modhub.GetModMediaRequest.type: ModMediaType
Modhub.GetModMediaRequest.galleryIndexπ
Modhub.GetModMediaRequest.galleryIndex: integer
Modhub.ModMediaDataπ
record Modhub.ModMediaData
new: function(): ModMediaData width: integer height: integer channels: integer data: {integer} data_native: Vector<integer> end
Modhub.ModMediaData.newπ
function Modhub.ModMediaData.new(): ModMediaDataReturns
ModMediaData
Modhub.ModMediaData.widthπ
Modhub.ModMediaData.width: integer
Modhub.ModMediaData.heightπ
Modhub.ModMediaData.height: integer
Modhub.ModMediaData.channelsπ
Modhub.ModMediaData.channels: integer
Modhub.ModMediaData.dataπ
Modhub.ModMediaData.data: {integer}
Modhub.ModMediaData.data_nativeπ
Modhub.ModMediaData.data_native: Vector<integer>
Modhub.GetModRatingRequestπ
Modhub.GetModRatingRequest.newπ
function Modhub.GetModRatingRequest.new(ModId): GetModRatingRequestParameters
ModId
GetModRatingRequest
Modhub.GetModRatingRequest.modIdπ
Modhub.GetModRatingRequest.modId: ModId
Modhub.ModRatingDataπ
Modhub.ModRatingData.newπ
function Modhub.ModRatingData.new(): ModRatingDataReturns
ModRatingData
Modhub.ModRatingData.ratingπ
Modhub.ModRatingData.rating: RatingType
Modhub.SubscribeModRequestπ
record Modhub.SubscribeModRequest
new: function(ModId): SubscribeModRequest modId: ModId includeDependencies: boolean end
Modhub.SubscribeModRequest.newπ
function Modhub.SubscribeModRequest.new(ModId): SubscribeModRequestParameters
ModId
SubscribeModRequest
Modhub.SubscribeModRequest.modIdπ
Modhub.SubscribeModRequest.modId: ModId
Modhub.SubscribeModRequest.includeDependenciesπ
Modhub.SubscribeModRequest.includeDependencies: boolean
Modhub.UnsubscribeModRequestπ
Modhub.UnsubscribeModRequest.newπ
function Modhub.UnsubscribeModRequest.new(ModId): UnsubscribeModRequestParameters
ModId
UnsubscribeModRequest
Modhub.UnsubscribeModRequest.modIdπ
Modhub.UnsubscribeModRequest.modId: ModId
Modhub.SubscriptionDataπ
record Modhub.SubscriptionData
end
Modhub.RefreshDataπ
record Modhub.RefreshData
numRefreshed: integer end
Modhub.RefreshData.numRefreshedπ
Modhub.RefreshData.numRefreshed: integer
Modhub.ForceUninstallModRequestπ
record Modhub.ForceUninstallModRequest
new: function(ModId): ForceUninstallModRequest modId: ModId end
Modhub.ForceUninstallModRequest.newπ
function Modhub.ForceUninstallModRequest.new(ModId): ForceUninstallModRequestParameters
ModId
ForceUninstallModRequest
Modhub.ForceUninstallModRequest.modIdπ
Modhub.ForceUninstallModRequest.modId: ModId
Modhub.ForceUninstallModDataπ
record Modhub.ForceUninstallModData
end
Modhub.SpecialRefreshModRequestπ
record Modhub.SpecialRefreshModRequest
new: function(ModId, boolean): SpecialRefreshModRequest modId: ModId unsubscribe: boolean end
Modhub.SpecialRefreshModRequest.newπ
function Modhub.SpecialRefreshModRequest.new(ModId, boolean): SpecialRefreshModRequestParameters
ModIdboolean
SpecialRefreshModRequest
Modhub.SpecialRefreshModRequest.modIdπ
Modhub.SpecialRefreshModRequest.modId: ModId
Modhub.SpecialRefreshModRequest.unsubscribeπ
Modhub.SpecialRefreshModRequest.unsubscribe: boolean
Modhub.SpecialRefreshModDataπ
record Modhub.SpecialRefreshModData
end
Modhub.RestartModBackendDataπ
record Modhub.RestartModBackendData
end
Modhub.SubmitModRatingRequestπ
record Modhub.SubmitModRatingRequest
new: function(ModId, RatingType): SubmitModRatingRequest modId: ModId rating: RatingType end
Modhub.SubmitModRatingRequest.newπ
function Modhub.SubmitModRatingRequest.new(ModId, RatingType): SubmitModRatingRequestParameters
ModIdRatingType
SubmitModRatingRequest
Modhub.SubmitModRatingRequest.modIdπ
Modhub.SubmitModRatingRequest.modId: ModId
Modhub.SubmitModRatingRequest.ratingπ
Modhub.SubmitModRatingRequest.rating: RatingType
Modhub.SubmitModRatingDataπ
Modhub.SubmitModRatingData.ratingπ
Modhub.SubmitModRatingData.rating: RatingType
Modhub.SubmitModReportRequestπ
record Modhub.SubmitModReportRequest
new: function(ModId, ReportType, string, string, string): SubmitModReportRequest modId: ModId type: ReportType reportDescription: string reporterName: string reporterContact: string end
Modhub.SubmitModReportRequest.newπ
function Modhub.SubmitModReportRequest.new(ModId, ReportType, string, string, string): SubmitModReportRequestParameters
ModIdReportTypestringstringstring
SubmitModReportRequest
Modhub.SubmitModReportRequest.modIdπ
Modhub.SubmitModReportRequest.modId: ModId
Modhub.SubmitModReportRequest.typeπ
Modhub.SubmitModReportRequest.type: ReportType
Modhub.SubmitModReportRequest.reportDescriptionπ
Modhub.SubmitModReportRequest.reportDescription: string
Modhub.SubmitModReportRequest.reporterNameπ
Modhub.SubmitModReportRequest.reporterName: string
Modhub.SubmitModReportRequest.reporterContactπ
Modhub.SubmitModReportRequest.reporterContact: string
Modhub.SubmitModReportDataπ
Modhub.SubmitModReportData.Responseπ
Modhub.SubmitModReportData.Response.ValidationErrorπ
Modhub.SubmitModReportData.Response.ValidationError: Response
Modhub.SubmitModReportData.Response.Submittedπ
Modhub.SubmitModReportData.Response.Submitted: Response
Modhub.SubmitModReportData.responseπ
Modhub.SubmitModReportData.response: Response
Modhub.UploadModDataπ
Modhub.UploadModData.modIdπ
Modhub.UploadModData.modId: ModId
Modhub.UploadModData.partialErrorsπ
Modhub.UploadModData.partialErrors: {ModHubErrorCode}
Modhub.UniquePendingRequestIdπ
Modhub.UniquePendingRequestId.abortπ
function Modhub.UniquePendingRequestId.abort(UniquePendingRequestId)Parameters
UniquePendingRequestId
Modhub.AsyncResultπ
record Modhub.AsyncResult<T>
isSuccess: function(AsyncResult<T>): boolean getData: function(AsyncResult<T>): T getError: function(AsyncResult<T>): ModHubErrorCode end
Type Parameters
T
Modhub.AsyncResult.isSuccessπ
function Modhub.AsyncResult.isSuccess(AsyncResult<T>): booleanParameters
AsyncResult<T>
boolean
Modhub.AsyncResult.getDataπ
function Modhub.AsyncResult.getData(AsyncResult<T>): TParameters
AsyncResult<T>
T
Modhub.AsyncResult.getErrorπ
function Modhub.AsyncResult.getError(AsyncResult<T>): ModHubErrorCodeParameters
AsyncResult<T>
ModHubErrorCode
Modhub.BackendIdπ
type Modhub.BackendId = integer
Modhub.ModBrowserDisplayDataπ
record Modhub.ModBrowserDisplayData
entries: {Entry} error: Modhub.ModHubErrorCode currentPage: integer numPages: integer displayPerPage: integer totalResults: integer appendResults: boolean searchString: string sortType: Modhub.SortType hasNoSortTag: boolean filterTags: {string} excludeTags: {string} end
Modhub.ModBrowserDisplayData.Entryπ
Modhub.ModBrowserDisplayData.Entry.backendIdπ
Modhub.ModBrowserDisplayData.Entry.backendId: BackendId
Modhub.ModBrowserDisplayData.Entry.modInfoπ
Modhub.ModBrowserDisplayData.Entry.modInfo: ModInfo
Modhub.ModBrowserDisplayData.Entry.modIdπ
Modhub.ModBrowserDisplayData.Entry.modId: Mod.ModId
Modhub.ModBrowserDisplayData.entriesπ
Modhub.ModBrowserDisplayData.entries: {Entry}
Modhub.ModBrowserDisplayData.errorπ
Modhub.ModBrowserDisplayData.error: Modhub.ModHubErrorCode
Modhub.ModBrowserDisplayData.currentPageπ
Modhub.ModBrowserDisplayData.currentPage: integer
Modhub.ModBrowserDisplayData.numPagesπ
Modhub.ModBrowserDisplayData.numPages: integer
Modhub.ModBrowserDisplayData.displayPerPageπ
Modhub.ModBrowserDisplayData.displayPerPage: integer
Modhub.ModBrowserDisplayData.totalResultsπ
Modhub.ModBrowserDisplayData.totalResults: integer
Modhub.ModBrowserDisplayData.appendResultsπ
Modhub.ModBrowserDisplayData.appendResults: boolean
Modhub.ModBrowserDisplayData.searchStringπ
Modhub.ModBrowserDisplayData.searchString: string
Modhub.ModBrowserDisplayData.sortTypeπ
Modhub.ModBrowserDisplayData.sortType: Modhub.SortType
Modhub.ModBrowserDisplayData.hasNoSortTagπ
Modhub.ModBrowserDisplayData.hasNoSortTag: boolean
Modhub.ModBrowserDisplayData.filterTagsπ
Modhub.ModBrowserDisplayData.filterTags: {string}
Modhub.ModBrowserDisplayData.excludeTagsπ
Modhub.ModBrowserDisplayData.excludeTags: {string}
Modhub.ModBrowserDataProviderπ
record Modhub.ModBrowserDataProvider
new: function(BackendId, integer): ModBrowserDataProvider newForSelector: function(integer, function(Mod.ModId, Mod.ModId), {Mod.GameModDesc}): ModBrowserDataProvider suspend: function(ModBrowserDataProvider) resume: function(ModBrowserDataProvider) getDisplayData: function(ModBrowserDataProvider): ModBrowserDisplayData setLoadPage: function(ModBrowserDataProvider, integer) setNextContinuousPage: function(ModBrowserDataProvider) setCurrentPage: function(ModBrowserDataProvider, integer) setSearchString: function(ModBrowserDataProvider, string) setSearchUserId: function(ModBrowserDataProvider, UserId) setNextPage: function(ModBrowserDataProvider) setPreviousPage: function(ModBrowserDataProvider) refreshCurrentPage: function(ModBrowserDataProvider, boolean) getSortType: function(ModBrowserDataProvider): Modhub.SortType getTagToggled: function(ModBrowserDataProvider, string): boolean setSortType: function(ModBrowserDataProvider, SortType) setNextSortType: function(ModBrowserDataProvider) toggleTag: function(ModBrowserDataProvider, string) resetFilters: function(ModBrowserDataProvider) getSortAndFilterOptions: function(ModBrowserDataProvider): Modhub.SortAndFilterOptions end
Modhub.ModBrowserDataProvider.newπ
function Modhub.ModBrowserDataProvider.new(BackendId, integer): ModBrowserDataProviderParameters
BackendIdinteger
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.newForSelectorπ
function Modhub.ModBrowserDataProvider.newForSelector(integer, function(Mod.ModId, Mod.ModId), {Mod.GameModDesc}): ModBrowserDataProviderParameters
integerfunction(Mod.ModId, Mod.ModId){Mod.GameModDesc}
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.suspendπ
function Modhub.ModBrowserDataProvider.suspend(ModBrowserDataProvider)Parameters
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.resumeπ
function Modhub.ModBrowserDataProvider.resume(ModBrowserDataProvider)Parameters
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.getDisplayDataπ
function Modhub.ModBrowserDataProvider.getDisplayData(ModBrowserDataProvider): ModBrowserDisplayDataParameters
ModBrowserDataProvider
ModBrowserDisplayData
Modhub.ModBrowserDataProvider.setLoadPageπ
function Modhub.ModBrowserDataProvider.setLoadPage(ModBrowserDataProvider, integer)Parameters
ModBrowserDataProviderinteger
Modhub.ModBrowserDataProvider.setNextContinuousPageπ
function Modhub.ModBrowserDataProvider.setNextContinuousPage(ModBrowserDataProvider)Parameters
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.setCurrentPageπ
function Modhub.ModBrowserDataProvider.setCurrentPage(ModBrowserDataProvider, integer)Parameters
ModBrowserDataProviderinteger
Modhub.ModBrowserDataProvider.setSearchStringπ
function Modhub.ModBrowserDataProvider.setSearchString(ModBrowserDataProvider, string)Parameters
ModBrowserDataProviderstring
Modhub.ModBrowserDataProvider.setSearchUserIdπ
function Modhub.ModBrowserDataProvider.setSearchUserId(ModBrowserDataProvider, UserId)Parameters
ModBrowserDataProviderUserId
Modhub.ModBrowserDataProvider.setNextPageπ
function Modhub.ModBrowserDataProvider.setNextPage(ModBrowserDataProvider)Parameters
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.setPreviousPageπ
function Modhub.ModBrowserDataProvider.setPreviousPage(ModBrowserDataProvider)Parameters
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.refreshCurrentPageπ
function Modhub.ModBrowserDataProvider.refreshCurrentPage(ModBrowserDataProvider, boolean)Parameters
ModBrowserDataProviderboolean
Modhub.ModBrowserDataProvider.getSortTypeπ
function Modhub.ModBrowserDataProvider.getSortType(ModBrowserDataProvider): Modhub.SortTypeParameters
ModBrowserDataProvider
Modhub.SortType
Modhub.ModBrowserDataProvider.getTagToggledπ
function Modhub.ModBrowserDataProvider.getTagToggled(ModBrowserDataProvider, string): booleanParameters
ModBrowserDataProviderstring
boolean
Modhub.ModBrowserDataProvider.setSortTypeπ
function Modhub.ModBrowserDataProvider.setSortType(ModBrowserDataProvider, SortType)Parameters
ModBrowserDataProviderSortType
Modhub.ModBrowserDataProvider.setNextSortTypeπ
function Modhub.ModBrowserDataProvider.setNextSortType(ModBrowserDataProvider)Parameters
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.toggleTagπ
function Modhub.ModBrowserDataProvider.toggleTag(ModBrowserDataProvider, string)Parameters
ModBrowserDataProviderstring
Modhub.ModBrowserDataProvider.resetFiltersπ
function Modhub.ModBrowserDataProvider.resetFilters(ModBrowserDataProvider)Parameters
ModBrowserDataProvider
Modhub.ModBrowserDataProvider.getSortAndFilterOptionsπ
function Modhub.ModBrowserDataProvider.getSortAndFilterOptions(ModBrowserDataProvider): Modhub.SortAndFilterOptionsParameters
ModBrowserDataProvider
Modhub.SortAndFilterOptions
Modhub.StagingModDataπ
record Modhub.StagingModData
equals: function(StagingModData, StagingModData): boolean localModhubDetails: Modhub.ModDetailsData state: State modhubId: Modhub.ModId modhubDetails: Modhub.ModDetailsData publishResult: AsyncResult<UploadModData> end
Modhub.StagingModData.Stateπ
Modhub.StagingModData.State.Syncπ
Modhub.StagingModData.State.Sync: State
Modhub.StagingModData.State.Readyπ
Modhub.StagingModData.State.Ready: State
Modhub.StagingModData.State.Publishingπ
Modhub.StagingModData.State.Publishing: State
Modhub.StagingModData.State.HasResultπ
Modhub.StagingModData.State.HasResult: State
Modhub.StagingModData.equalsπ
function Modhub.StagingModData.equals(StagingModData, StagingModData): booleanParameters
StagingModDataStagingModData
boolean
Modhub.StagingModData.localModhubDetailsπ
Modhub.StagingModData.localModhubDetails: Modhub.ModDetailsData
Modhub.StagingModData.stateπ
Modhub.StagingModData.state: State
Modhub.StagingModData.modhubIdπ
Modhub.StagingModData.modhubId: Modhub.ModId
Modhub.StagingModData.modhubDetailsπ
Modhub.StagingModData.modhubDetails: Modhub.ModDetailsData
Modhub.StagingModData.publishResultπ
Modhub.StagingModData.publishResult: AsyncResult<UploadModData>
Modhub.PublishSettingsπ
record Modhub.PublishSettings
new: function(): PublishSettings changeLog: string updateMetadata: boolean setPublic: boolean end
Modhub.PublishSettings.new()π
function Modhub.PublishSettings.new()(): PublishSettingsReturns
PublishSettings
Modhub.PublishSettings.new(PublishSettings)π
function Modhub.PublishSettings.new(PublishSettings)(PublishSettings): PublishSettingsParameters
PublishSettings
PublishSettings
Modhub.PublishSettings.changeLogπ
Modhub.PublishSettings.changeLog: string
Modhub.PublishSettings.updateMetadataπ
Modhub.PublishSettings.updateMetadata: boolean
Modhub.PublishSettings.setPublicπ
Modhub.PublishSettings.setPublic: boolean
Modhub.ModPublishHelperπ
record Modhub.ModPublishHelper
new: function(BackendId): ModPublishHelper hasAnyStagingMods: function(publishHelper : ModPublishHelper): boolean canRefresh: function(publishHelper : ModPublishHelper): boolean refresh: function(publishHelper : ModPublishHelper): AsyncResult<RefreshData> hasStagingMod: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): boolean getStagingModData: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): StagingModData setModDetails: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, modDetailsData : Modhub.ModDetailsData) setRemoteModId: function(publishHelper : ModPublishHelper, localModId : Modhub.ModId, remoteModId : Modhub.ModId) publish: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishSettings : PublishSettings, validationResult : Modhub.ModValidatorResult): AsyncResult<UploadModData> abortPublish: function(publishHelper : ModPublishHelper, modId : Modhub.ModId): UniquePendingRequestId addLogoImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, image : string) removeLogoImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId) addGalleryImages: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, images : {string}) removeGalleryImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, index : integer) moveGalleryImage: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, fromIndex : integer, toIndex : integer) setPostPublishFn: function(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishFn : function(Modhub.ModId)) openFolder: function(publishHelper : ModPublishHelper, modId : Modhub.ModId) getSortAndFilterOptions: function(publishHelper : ModPublishHelper): Modhub.SortAndFilterOptions end
Modhub.ModPublishHelper.newπ
function Modhub.ModPublishHelper.new(BackendId): ModPublishHelperParameters
BackendId
ModPublishHelper
Modhub.ModPublishHelper.hasAnyStagingModsπ
function Modhub.ModPublishHelper.hasAnyStagingMods(publishHelper : ModPublishHelper): boolean
Checks if there are any mods in the staging area
ParameterspublishHelper:ModPublishHelperβ the publish helper
boolean
Modhub.ModPublishHelper.canRefreshπ
function Modhub.ModPublishHelper.canRefresh(publishHelper : ModPublishHelper): boolean
Checks if the publish helper can be refreshed
ParameterspublishHelper:ModPublishHelperβ the publish helper
boolean
Modhub.ModPublishHelper.refreshπ
function Modhub.ModPublishHelper.refresh(publishHelper : ModPublishHelper): AsyncResult<RefreshData>
Refreshes the mod helper, this is an async operation
ParameterspublishHelper:ModPublishHelperβ the publish helper
AsyncResult<RefreshData>β the result of the async operation, including the number of mods that were refreshed
Modhub.ModPublishHelper.hasStagingModπ
function Modhub.ModPublishHelper.hasStagingMod(publishHelper : ModPublishHelper, modId : Modhub.ModId): boolean
Checks if a specific mod is in the staging area
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod id
boolean
Modhub.ModPublishHelper.getStagingModDataπ
function Modhub.ModPublishHelper.getStagingModData(publishHelper : ModPublishHelper, modId : Modhub.ModId): StagingModData
Returns the staging mod data for a specific mod
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod id
StagingModData
Modhub.ModPublishHelper.setModDetailsπ
function Modhub.ModPublishHelper.setModDetails(publishHelper : ModPublishHelper, modId : Modhub.ModId, modDetailsData : Modhub.ModDetailsData)
Sets the mod details data
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the local mod id of the mod to updatemodDetailsData:Modhub.ModDetailsDataβ the mod details data
Modhub.ModPublishHelper.setRemoteModIdπ
function Modhub.ModPublishHelper.setRemoteModId(publishHelper : ModPublishHelper, localModId : Modhub.ModId, remoteModId : Modhub.ModId)
Update the local modId of a mod to the remote (eg. mod.io) mod.io of the mod when publishing
ParameterspublishHelper:ModPublishHelperβ the publish helperlocalModId:Modhub.ModIdβ the local mod id of the mod to updateremoteModId:Modhub.ModIdβ the remote mod id to set
Modhub.ModPublishHelper.publishπ
function Modhub.ModPublishHelper.publish(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishSettings : PublishSettings, validationResult : Modhub.ModValidatorResult): AsyncResult<UploadModData>
Publishes a mod (eg. on mod.io), this is an async call
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod idpublishSettings:PublishSettingsβ the publish settingsvalidationResult:Modhub.ModValidatorResultβ the validation result
AsyncResult<UploadModData>β the result of the async call, also contains the remote mod id
Modhub.ModPublishHelper.abortPublishπ
function Modhub.ModPublishHelper.abortPublish(publishHelper : ModPublishHelper, modId : Modhub.ModId): UniquePendingRequestId
Aborts the publication of a mod
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod id
UniquePendingRequestId
Modhub.ModPublishHelper.addLogoImageπ
function Modhub.ModPublishHelper.addLogoImage(publishHelper : ModPublishHelper, modId : Modhub.ModId, image : string)
Adds a list of image to the mod gallery
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod idimage:stringβ image file to add to the gallery
Modhub.ModPublishHelper.removeLogoImageπ
function Modhub.ModPublishHelper.removeLogoImage(publishHelper : ModPublishHelper, modId : Modhub.ModId)
Removes the logo image
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod id
Modhub.ModPublishHelper.addGalleryImagesπ
function Modhub.ModPublishHelper.addGalleryImages(publishHelper : ModPublishHelper, modId : Modhub.ModId, images : {string})
Adds a list of image to the mod gallery
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod idimages:{string}β the list of image file to add to the gallery
Modhub.ModPublishHelper.removeGalleryImageπ
function Modhub.ModPublishHelper.removeGalleryImage(publishHelper : ModPublishHelper, modId : Modhub.ModId, index : integer)
Removes an image from the mod gallery
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod idindex:integerβ the index of the image in the gallery to remove
Modhub.ModPublishHelper.moveGalleryImageπ
function Modhub.ModPublishHelper.moveGalleryImage(publishHelper : ModPublishHelper, modId : Modhub.ModId, fromIndex : integer, toIndex : integer)
Moves an image position in the mod gallery
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod idfromIndex:integerβ the index in the mod gallery of the image to movetoIndex:integerβ the new position of the image in the mod gallery
Modhub.ModPublishHelper.setPostPublishFnπ
function Modhub.ModPublishHelper.setPostPublishFn(publishHelper : ModPublishHelper, modId : Modhub.ModId, publishFn : function(Modhub.ModId))
Set a function called after a mod has been successfuly published
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the mod idpublishFn:function(Modhub.ModId)β a function called after the mod has been published, the function gives the remote mod id as parameter
Modhub.ModPublishHelper.openFolderπ
function Modhub.ModPublishHelper.openFolder(publishHelper : ModPublishHelper, modId : Modhub.ModId)
Opens the mod folder
ParameterspublishHelper:ModPublishHelperβ the publish helpermodId:Modhub.ModIdβ the modId
Modhub.ModPublishHelper.getSortAndFilterOptionsπ
function Modhub.ModPublishHelper.getSortAndFilterOptions(publishHelper : ModPublishHelper): Modhub.SortAndFilterOptions
Gets the list of sorting and filtering options (eg. tags)
ParameterspublishHelper:ModPublishHelperβ the publish helper
Modhub.SortAndFilterOptionsβ an object containing the list of sort and filter options