index / api / type / modhub

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 end
record ModValidatorResult messages: {ModValidatorMessage} criticalPc: boolean criticalConsole: boolean cookedPcPath: string cookedConsolePath: string levelPc: LogLevel levelConsole: LogLevel end
record ModHubErrorCode code: integer message: string fields: {string : string} end
record SortType Trending: SortType Rating: SortType SubscriberCount: SortType DateAdded: SortType DateUpdated: SortType Name: SortType Source: SortType Custom: SortType end
record SortOrder sortType: SortType allowAscDesc: boolean end
record TagGroup name: string values: {string} allowMultipleSelection: boolean noSortTag: boolean visible: boolean end
record SortAndFilterOptions tagGroups: {TagGroup} sortOrders: {SortOrder} statusTagGroupIndex: integer end
record UserInfo userName: string profileUrl: string displayName: string end
record ModId new: function(): ModId isValid: function(ModId): boolean value: string end
record UserId new: function(integer): UserId equals: function(UserId, UserId): boolean isValid: function(UserId): boolean value: integer end
record ModManagementMode Disabled: ModManagementMode Restricted: ModManagementMode Full: ModManagementMode end
record InstallState None: InstallState Downloading: InstallState UpdatePending: InstallState Installed: InstallState DownloadPending: InstallState InstallationPending: InstallState UninstallPending: InstallState Extracting: InstallState InsufficientSpace: InstallState MiscError: InstallState end
record ModInstallInfo installPath: string runtimeRevision: integer end
record ModReleaseInfo version: string releaseNotes: string releaseUnixTimestamp: integer end
record 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
record ModMediaType Logo: ModMediaType GalleryThumb180p: ModMediaType GalleryThumb720p: ModMediaType GalleryOriginal: ModMediaType AuthorAvatar: ModMediaType end
record AuthenticationType Email: AuthenticationType Steam: AuthenticationType SteamOffline: AuthenticationType Gog: AuthenticationType Epic: AuthenticationType XboxLive: AuthenticationType PSN: AuthenticationType Paradox: AuthenticationType end
record RatingType Neutral: RatingType Positive: RatingType Negative: RatingType end
record ReportType Generic: ReportType DMCA: ReportType NotWorking: ReportType RudeContent: ReportType IllegalContent: ReportType StolenContent: ReportType FalseInformation: ReportType Other: ReportType end
record StorageInfo usedSpace: integer totalSpace: integer end
record ModManagementState uploading: boolean busy: boolean totalPending: integer pending: {ModId} finished: {ModId} progress: number currentModId: ModId end
record Capabilities allowForceUninstall: boolean authenticationTypes: {AuthenticationType} manualRefresh: boolean specialModRefresh: boolean allowReport: boolean isInfoOnly: boolean allowUnsubscribeInstalledMods: boolean allowRestrictedMode: boolean allowModUpload: boolean visibleInModHub: boolean end
record Description name: string nameLocalized: string url: string icon: string end
record EmailAuthCodeRequest new: function(string): EmailAuthCodeRequest email: string end
record EmailAuthCodeData
record Response ValidationError: Response NeedAuthCode: Response Authenticated: Response end
response: Response end
record AuthenticateUserEmailRequest new: function(string): AuthenticateUserEmailRequest authCode: string end
record AuthenticateUserEmailData
record Response ValidationError: Response ExpiredAuthCode: Response Authenticated: Response end
response: Response end
record TermsOfUseRequest new: function(AuthenticationType): TermsOfUseRequest type: AuthenticationType end
record TermsOfUseData terms: string agreeLabel: string disagreeLabel: string end
record AuthenticateUserExternalRequest new: function(AuthenticationType): AuthenticateUserExternalRequest type: AuthenticationType email: string end
record AuthenticateUserExternalData
record Response UnkownError: Response PortalSignInError: Response ValidationError: Response Authenticated: Response end
response: Response end
record LogoutDataend
record ListModsRequest new: function(): ListModsRequest page: integer preferedPageSize: integer searchString: string sortType: SortType sortAscending: boolean tags: {integer} fetchLongDescription: boolean end
record ListModsData modInfos: {ModInfo} modsPerPage: integer totalResultCount: integer end
record GetModDetailsRequest new: function(ModId): GetModDetailsRequest modId: ModId end
record UserPortal XboxLive: UserPortal PlaystationNetwork: UserPortal Misc: UserPortal end
record ModDetailsData new: function(): ModDetailsData modInfo: ModInfo author: string userId: UserId userPortal: UserPortal numGalleryImages: integer logoImage: string galleryImages: {string} dependencies: {{ModId, string}} found: boolean end
record GetModMediaRequest new: function(ModId, ModMediaType, integer): GetModMediaRequest modId: ModId type: ModMediaType galleryIndex: integer end
record ModMediaData new: function(): ModMediaData width: integer height: integer channels: integer data: {integer} data_native: Vector<integer> end
record GetModRatingRequest new: function(ModId): GetModRatingRequest modId: ModId end
record ModRatingData new: function(): ModRatingData rating: RatingType end
record SubscribeModRequest new: function(ModId): SubscribeModRequest modId: ModId includeDependencies: boolean end
record UnsubscribeModRequest new: function(ModId): UnsubscribeModRequest modId: ModId end
record SubscriptionDataend
record RefreshData numRefreshed: integer end
record ForceUninstallModRequest new: function(ModId): ForceUninstallModRequest modId: ModId end
record ForceUninstallModDataend
record SpecialRefreshModRequest new: function(ModId, boolean): SpecialRefreshModRequest modId: ModId unsubscribe: boolean end
record SpecialRefreshModDataend
record RestartModBackendDataend
record SubmitModRatingRequest new: function(ModId, RatingType): SubmitModRatingRequest modId: ModId rating: RatingType end
record SubmitModRatingData rating: RatingType end
record SubmitModReportRequest new: function(ModId, ReportType, string, string, string): SubmitModReportRequest modId: ModId type: ReportType reportDescription: string reporterName: string reporterContact: string end
record SubmitModReportData
record Response ValidationError: Response Submitted: Response end
response: Response end
record UploadModData modId: ModId partialErrors: {ModHubErrorCode} end
record UniquePendingRequestId abort: function(UniquePendingRequestId) end
record AsyncResult<T> isSuccess: function(AsyncResult<T>): boolean getData: function(AsyncResult<T>): T getError: function(AsyncResult<T>): ModHubErrorCode end
type BackendId = integer
record ModBrowserDisplayData
record Entry backendId: BackendId modInfo: ModInfo modId: Mod.ModId end
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
record 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
record StagingModData
record State Sync: State Ready: State Publishing: State HasResult: State end
equals: function(StagingModData, StagingModData): boolean localModhubDetails: Modhub.ModDetailsData state: State modhubId: Modhub.ModId modhubDetails: Modhub.ModDetailsData publishResult: AsyncResult<UploadModData> end
record PublishSettings new: function(): PublishSettings changeLog: string updateMetadata: boolean setPublic: boolean end
record 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
end

Category: mainπŸ”—

ModhubπŸ”—

global record Modhub
record ModValidatorMessage context: string file: string level: LogLevel message: string consoleOnly: boolean end
record ModValidatorResult messages: {ModValidatorMessage} criticalPc: boolean criticalConsole: boolean cookedPcPath: string cookedConsolePath: string levelPc: LogLevel levelConsole: LogLevel end
record ModHubErrorCode code: integer message: string fields: {string : string} end
record SortType Trending: SortType Rating: SortType SubscriberCount: SortType DateAdded: SortType DateUpdated: SortType Name: SortType Source: SortType Custom: SortType end
record SortOrder sortType: SortType allowAscDesc: boolean end
record TagGroup name: string values: {string} allowMultipleSelection: boolean noSortTag: boolean visible: boolean end
record SortAndFilterOptions tagGroups: {TagGroup} sortOrders: {SortOrder} statusTagGroupIndex: integer end
record UserInfo userName: string profileUrl: string displayName: string end
record ModId new: function(): ModId isValid: function(ModId): boolean value: string end
record UserId new: function(integer): UserId equals: function(UserId, UserId): boolean isValid: function(UserId): boolean value: integer end
record ModManagementMode Disabled: ModManagementMode Restricted: ModManagementMode Full: ModManagementMode end
record InstallState None: InstallState Downloading: InstallState UpdatePending: InstallState Installed: InstallState DownloadPending: InstallState InstallationPending: InstallState UninstallPending: InstallState Extracting: InstallState InsufficientSpace: InstallState MiscError: InstallState end
record ModInstallInfo installPath: string runtimeRevision: integer end
record ModReleaseInfo version: string releaseNotes: string releaseUnixTimestamp: integer end
record 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
record ModMediaType Logo: ModMediaType GalleryThumb180p: ModMediaType GalleryThumb720p: ModMediaType GalleryOriginal: ModMediaType AuthorAvatar: ModMediaType end
record AuthenticationType Email: AuthenticationType Steam: AuthenticationType SteamOffline: AuthenticationType Gog: AuthenticationType Epic: AuthenticationType XboxLive: AuthenticationType PSN: AuthenticationType Paradox: AuthenticationType end
record RatingType Neutral: RatingType Positive: RatingType Negative: RatingType end
record ReportType Generic: ReportType DMCA: ReportType NotWorking: ReportType RudeContent: ReportType IllegalContent: ReportType StolenContent: ReportType FalseInformation: ReportType Other: ReportType end
record StorageInfo usedSpace: integer totalSpace: integer end
record ModManagementState uploading: boolean busy: boolean totalPending: integer pending: {ModId} finished: {ModId} progress: number currentModId: ModId end
record Capabilities allowForceUninstall: boolean authenticationTypes: {AuthenticationType} manualRefresh: boolean specialModRefresh: boolean allowReport: boolean isInfoOnly: boolean allowUnsubscribeInstalledMods: boolean allowRestrictedMode: boolean allowModUpload: boolean visibleInModHub: boolean end
record Description name: string nameLocalized: string url: string icon: string end
record EmailAuthCodeRequest new: function(string): EmailAuthCodeRequest email: string end
record EmailAuthCodeData
record Response ValidationError: Response NeedAuthCode: Response Authenticated: Response end
response: Response end
record AuthenticateUserEmailRequest new: function(string): AuthenticateUserEmailRequest authCode: string end
record AuthenticateUserEmailData
record Response ValidationError: Response ExpiredAuthCode: Response Authenticated: Response end
response: Response end
record TermsOfUseRequest new: function(AuthenticationType): TermsOfUseRequest type: AuthenticationType end
record TermsOfUseData terms: string agreeLabel: string disagreeLabel: string end
record AuthenticateUserExternalRequest new: function(AuthenticationType): AuthenticateUserExternalRequest type: AuthenticationType email: string end
record AuthenticateUserExternalData
record Response UnkownError: Response PortalSignInError: Response ValidationError: Response Authenticated: Response end
response: Response end
record LogoutDataend
record ListModsRequest new: function(): ListModsRequest page: integer preferedPageSize: integer searchString: string sortType: SortType sortAscending: boolean tags: {integer} fetchLongDescription: boolean end
record ListModsData modInfos: {ModInfo} modsPerPage: integer totalResultCount: integer end
record GetModDetailsRequest new: function(ModId): GetModDetailsRequest modId: ModId end
record UserPortal XboxLive: UserPortal PlaystationNetwork: UserPortal Misc: UserPortal end
record ModDetailsData new: function(): ModDetailsData modInfo: ModInfo author: string userId: UserId userPortal: UserPortal numGalleryImages: integer logoImage: string galleryImages: {string} dependencies: {{ModId, string}} found: boolean end
record GetModMediaRequest new: function(ModId, ModMediaType, integer): GetModMediaRequest modId: ModId type: ModMediaType galleryIndex: integer end
record ModMediaData new: function(): ModMediaData width: integer height: integer channels: integer data: {integer} data_native: Vector<integer> end
record GetModRatingRequest new: function(ModId): GetModRatingRequest modId: ModId end
record ModRatingData new: function(): ModRatingData rating: RatingType end
record SubscribeModRequest new: function(ModId): SubscribeModRequest modId: ModId includeDependencies: boolean end
record UnsubscribeModRequest new: function(ModId): UnsubscribeModRequest modId: ModId end
record SubscriptionDataend
record RefreshData numRefreshed: integer end
record ForceUninstallModRequest new: function(ModId): ForceUninstallModRequest modId: ModId end
record ForceUninstallModDataend
record SpecialRefreshModRequest new: function(ModId, boolean): SpecialRefreshModRequest modId: ModId unsubscribe: boolean end
record SpecialRefreshModDataend
record RestartModBackendDataend
record SubmitModRatingRequest new: function(ModId, RatingType): SubmitModRatingRequest modId: ModId rating: RatingType end
record SubmitModRatingData rating: RatingType end
record SubmitModReportRequest new: function(ModId, ReportType, string, string, string): SubmitModReportRequest modId: ModId type: ReportType reportDescription: string reporterName: string reporterContact: string end
record SubmitModReportData
record Response ValidationError: Response Submitted: Response end
response: Response end
record UploadModData modId: ModId partialErrors: {ModHubErrorCode} end
record UniquePendingRequestId abort: function(UniquePendingRequestId) end
record AsyncResult<T> isSuccess: function(AsyncResult<T>): boolean getData: function(AsyncResult<T>): T getError: function(AsyncResult<T>): ModHubErrorCode end
type BackendId = integer
record ModBrowserDisplayData
record Entry backendId: BackendId modInfo: ModInfo modId: Mod.ModId end
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
record 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
record StagingModData
record State Sync: State Ready: State Publishing: State HasResult: State end
equals: function(StagingModData, StagingModData): boolean localModhubDetails: Modhub.ModDetailsData state: State modhubId: Modhub.ModId modhubDetails: Modhub.ModDetailsData publishResult: AsyncResult<UploadModData> end
record PublishSettings new: function(): PublishSettings changeLog: string updateMetadata: boolean setPublic: boolean end
record 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
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πŸ”—

record Modhub.ModHubErrorCode code: integer message: string fields: {string : string} end

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πŸ”—

record Modhub.SortType Trending: SortType Rating: SortType SubscriberCount: SortType DateAdded: SortType DateUpdated: SortType Name: SortType Source: SortType Custom: SortType end

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πŸ”—

record Modhub.SortOrder sortType: SortType allowAscDesc: boolean end

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πŸ”—

record Modhub.UserInfo userName: string profileUrl: string displayName: string end

Modhub.UserInfo.userNameπŸ”—

Modhub.UserInfo.userName: string

Modhub.UserInfo.profileUrlπŸ”—

Modhub.UserInfo.profileUrl: string

Modhub.UserInfo.displayNameπŸ”—

Modhub.UserInfo.displayName: string

Modhub.ModIdπŸ”—

record Modhub.ModId new: function(): ModId isValid: function(ModId): boolean value: string end

Modhub.ModId.newπŸ”—

function Modhub.ModId.new(): ModId
Returns
  1. ModId

Modhub.ModId.isValidπŸ”—

function Modhub.ModId.isValid(ModId): boolean
Parameters
  • ModId
Returns
  1. boolean

Modhub.ModId.valueπŸ”—

Modhub.ModId.value: string

Modhub.UserIdπŸ”—

record Modhub.UserId new: function(integer): UserId equals: function(UserId, UserId): boolean isValid: function(UserId): boolean value: integer end

Modhub.UserId.newπŸ”—

function Modhub.UserId.new(integer): UserId
Parameters
  • integer
Returns
  1. UserId

Modhub.UserId.equalsπŸ”—

function Modhub.UserId.equals(UserId, UserId): boolean
Parameters
  • UserId
  • UserId
Returns
  1. boolean

Modhub.UserId.isValidπŸ”—

function Modhub.UserId.isValid(UserId): boolean
Parameters
  • UserId
Returns
  1. boolean

Modhub.UserId.valueπŸ”—

Modhub.UserId.value: integer

Modhub.ModManagementModeπŸ”—

record Modhub.ModManagementMode Disabled: ModManagementMode Restricted: ModManagementMode Full: ModManagementMode end

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πŸ”—

record Modhub.ModInstallInfo installPath: string runtimeRevision: integer end

Modhub.ModInstallInfo.installPathπŸ”—

Modhub.ModInstallInfo.installPath: string

Modhub.ModInstallInfo.runtimeRevisionπŸ”—

Modhub.ModInstallInfo.runtimeRevision: integer

Modhub.ModReleaseInfoπŸ”—

record Modhub.ModReleaseInfo version: string releaseNotes: string releaseUnixTimestamp: integer end

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πŸ”—

record Modhub.ModMediaType Logo: ModMediaType GalleryThumb180p: ModMediaType GalleryThumb720p: ModMediaType GalleryOriginal: ModMediaType AuthorAvatar: ModMediaType end

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πŸ”—

record Modhub.AuthenticationType Email: AuthenticationType Steam: AuthenticationType SteamOffline: AuthenticationType Gog: AuthenticationType Epic: AuthenticationType XboxLive: AuthenticationType PSN: AuthenticationType Paradox: AuthenticationType end

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πŸ”—

record Modhub.RatingType Neutral: RatingType Positive: RatingType Negative: RatingType end

Modhub.RatingType.NeutralπŸ”—

Modhub.RatingType.Neutral: RatingType

Modhub.RatingType.PositiveπŸ”—

Modhub.RatingType.Positive: RatingType

Modhub.RatingType.NegativeπŸ”—

Modhub.RatingType.Negative: RatingType

Modhub.ReportTypeπŸ”—

record Modhub.ReportType Generic: ReportType DMCA: ReportType NotWorking: ReportType RudeContent: ReportType IllegalContent: ReportType StolenContent: ReportType FalseInformation: ReportType Other: ReportType end

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πŸ”—

record Modhub.StorageInfo usedSpace: integer totalSpace: integer end

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πŸ”—

record Modhub.Description name: string nameLocalized: string url: string icon: string end

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πŸ”—

record Modhub.EmailAuthCodeRequest new: function(string): EmailAuthCodeRequest email: string end

Modhub.EmailAuthCodeRequest.newπŸ”—

function Modhub.EmailAuthCodeRequest.new(string): EmailAuthCodeRequest
Parameters
  • string
Returns
  1. EmailAuthCodeRequest

Modhub.EmailAuthCodeRequest.emailπŸ”—

Modhub.EmailAuthCodeRequest.email: string

Modhub.EmailAuthCodeDataπŸ”—

record Modhub.EmailAuthCodeData
record Response ValidationError: Response NeedAuthCode: Response Authenticated: Response end
response: Response end

Modhub.EmailAuthCodeData.ResponseπŸ”—

record Modhub.EmailAuthCodeData.Response ValidationError: Response NeedAuthCode: Response Authenticated: Response end

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): AuthenticateUserEmailRequest
Parameters
  • string
Returns
  1. AuthenticateUserEmailRequest

Modhub.AuthenticateUserEmailRequest.authCodeπŸ”—

Modhub.AuthenticateUserEmailRequest.authCode: string

Modhub.AuthenticateUserEmailDataπŸ”—

record Modhub.AuthenticateUserEmailData
record Response ValidationError: Response ExpiredAuthCode: Response Authenticated: Response end
response: Response end

Modhub.AuthenticateUserEmailData.ResponseπŸ”—

record Modhub.AuthenticateUserEmailData.Response ValidationError: Response ExpiredAuthCode: Response Authenticated: Response end

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): TermsOfUseRequest
Parameters
  • AuthenticationType
Returns
  1. TermsOfUseRequest

Modhub.TermsOfUseRequest.typeπŸ”—

Modhub.TermsOfUseRequest.type: AuthenticationType

Modhub.TermsOfUseDataπŸ”—

record Modhub.TermsOfUseData terms: string agreeLabel: string disagreeLabel: string end

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): AuthenticateUserExternalRequest
Parameters
  • AuthenticationType
Returns
  1. AuthenticateUserExternalRequest

Modhub.AuthenticateUserExternalRequest.typeπŸ”—

Modhub.AuthenticateUserExternalRequest.type: AuthenticationType

Modhub.AuthenticateUserExternalRequest.emailπŸ”—

Modhub.AuthenticateUserExternalRequest.email: string

Modhub.AuthenticateUserExternalDataπŸ”—

record Modhub.AuthenticateUserExternalData
record Response UnkownError: Response PortalSignInError: Response ValidationError: Response Authenticated: Response end
response: Response end

Modhub.AuthenticateUserExternalData.ResponseπŸ”—

record Modhub.AuthenticateUserExternalData.Response UnkownError: Response PortalSignInError: Response ValidationError: Response Authenticated: Response end

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.LogoutDataend

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(): ListModsRequest
Returns
  1. 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πŸ”—

record Modhub.ListModsData modInfos: {ModInfo} modsPerPage: integer totalResultCount: integer end

Modhub.ListModsData.modInfosπŸ”—

Modhub.ListModsData.modInfos: {ModInfo}

Modhub.ListModsData.modsPerPageπŸ”—

Modhub.ListModsData.modsPerPage: integer

Modhub.ListModsData.totalResultCountπŸ”—

Modhub.ListModsData.totalResultCount: integer

Modhub.GetModDetailsRequestπŸ”—

record Modhub.GetModDetailsRequest new: function(ModId): GetModDetailsRequest modId: ModId end

Modhub.GetModDetailsRequest.newπŸ”—

function Modhub.GetModDetailsRequest.new(ModId): GetModDetailsRequest
Parameters
  • ModId
Returns
  1. GetModDetailsRequest

Modhub.GetModDetailsRequest.modIdπŸ”—

Modhub.GetModDetailsRequest.modId: ModId

Modhub.UserPortalπŸ”—

record Modhub.UserPortal XboxLive: UserPortal PlaystationNetwork: UserPortal Misc: UserPortal end

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(): ModDetailsData
Returns
  1. 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): GetModMediaRequest
Parameters
  • ModId
  • ModMediaType
  • integer
Returns
  1. 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(): ModMediaData
Returns
  1. 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πŸ”—

record Modhub.GetModRatingRequest new: function(ModId): GetModRatingRequest modId: ModId end

Modhub.GetModRatingRequest.newπŸ”—

function Modhub.GetModRatingRequest.new(ModId): GetModRatingRequest
Parameters
  • ModId
Returns
  1. GetModRatingRequest

Modhub.GetModRatingRequest.modIdπŸ”—

Modhub.GetModRatingRequest.modId: ModId

Modhub.ModRatingDataπŸ”—

record Modhub.ModRatingData new: function(): ModRatingData rating: RatingType end

Modhub.ModRatingData.newπŸ”—

function Modhub.ModRatingData.new(): ModRatingData
Returns
  1. 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): SubscribeModRequest
Parameters
  • ModId
Returns
  1. SubscribeModRequest

Modhub.SubscribeModRequest.modIdπŸ”—

Modhub.SubscribeModRequest.modId: ModId

Modhub.SubscribeModRequest.includeDependenciesπŸ”—

Modhub.SubscribeModRequest.includeDependencies: boolean

Modhub.UnsubscribeModRequestπŸ”—

record Modhub.UnsubscribeModRequest new: function(ModId): UnsubscribeModRequest modId: ModId end

Modhub.UnsubscribeModRequest.newπŸ”—

function Modhub.UnsubscribeModRequest.new(ModId): UnsubscribeModRequest
Parameters
  • ModId
Returns
  1. UnsubscribeModRequest

Modhub.UnsubscribeModRequest.modIdπŸ”—

Modhub.UnsubscribeModRequest.modId: ModId

Modhub.SubscriptionDataπŸ”—

record Modhub.SubscriptionDataend

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): ForceUninstallModRequest
Parameters
  • ModId
Returns
  1. ForceUninstallModRequest

Modhub.ForceUninstallModRequest.modIdπŸ”—

Modhub.ForceUninstallModRequest.modId: ModId

Modhub.ForceUninstallModDataπŸ”—

record Modhub.ForceUninstallModDataend

Modhub.SpecialRefreshModRequestπŸ”—

record Modhub.SpecialRefreshModRequest new: function(ModId, boolean): SpecialRefreshModRequest modId: ModId unsubscribe: boolean end

Modhub.SpecialRefreshModRequest.newπŸ”—

function Modhub.SpecialRefreshModRequest.new(ModId, boolean): SpecialRefreshModRequest
Parameters
  • ModId
  • boolean
Returns
  1. SpecialRefreshModRequest

Modhub.SpecialRefreshModRequest.modIdπŸ”—

Modhub.SpecialRefreshModRequest.modId: ModId

Modhub.SpecialRefreshModRequest.unsubscribeπŸ”—

Modhub.SpecialRefreshModRequest.unsubscribe: boolean

Modhub.SpecialRefreshModDataπŸ”—

record Modhub.SpecialRefreshModDataend

Modhub.RestartModBackendDataπŸ”—

record Modhub.RestartModBackendDataend

Modhub.SubmitModRatingRequestπŸ”—

record Modhub.SubmitModRatingRequest new: function(ModId, RatingType): SubmitModRatingRequest modId: ModId rating: RatingType end

Modhub.SubmitModRatingRequest.newπŸ”—

function Modhub.SubmitModRatingRequest.new(ModId, RatingType): SubmitModRatingRequest
Parameters
  • ModId
  • RatingType
Returns
  1. SubmitModRatingRequest

Modhub.SubmitModRatingRequest.modIdπŸ”—

Modhub.SubmitModRatingRequest.modId: ModId

Modhub.SubmitModRatingRequest.ratingπŸ”—

Modhub.SubmitModRatingRequest.rating: RatingType

Modhub.SubmitModRatingDataπŸ”—

record Modhub.SubmitModRatingData rating: RatingType end

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): SubmitModReportRequest
Parameters
  • ModId
  • ReportType
  • string
  • string
  • string
Returns
  1. 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πŸ”—

record Modhub.SubmitModReportData
record Response ValidationError: Response Submitted: Response end
response: Response end

Modhub.SubmitModReportData.ResponseπŸ”—

record Modhub.SubmitModReportData.Response ValidationError: Response Submitted: Response end

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πŸ”—

record Modhub.UploadModData modId: ModId partialErrors: {ModHubErrorCode} end

Modhub.UploadModData.modIdπŸ”—

Modhub.UploadModData.modId: ModId

Modhub.UploadModData.partialErrorsπŸ”—

Modhub.UploadModData.partialErrors: {ModHubErrorCode}

Modhub.UniquePendingRequestIdπŸ”—

record Modhub.UniquePendingRequestId abort: function(UniquePendingRequestId) end

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>): boolean
Parameters
  • AsyncResult<T>
Returns
  1. boolean

Modhub.AsyncResult.getDataπŸ”—

function Modhub.AsyncResult.getData(AsyncResult<T>): T
Parameters
  • AsyncResult<T>
Returns
  1. T

Modhub.AsyncResult.getErrorπŸ”—

function Modhub.AsyncResult.getError(AsyncResult<T>): ModHubErrorCode
Parameters
  • AsyncResult<T>
Returns
  1. ModHubErrorCode

Modhub.BackendIdπŸ”—

type Modhub.BackendId = integer

Modhub.ModBrowserDisplayDataπŸ”—

record Modhub.ModBrowserDisplayData
record Entry backendId: BackendId modInfo: ModInfo modId: Mod.ModId end
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πŸ”—

record Modhub.ModBrowserDisplayData.Entry backendId: BackendId modInfo: ModInfo modId: Mod.ModId end

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): ModBrowserDataProvider
Parameters
  • BackendId
  • integer
Returns
  1. ModBrowserDataProvider

Modhub.ModBrowserDataProvider.newForSelectorπŸ”—

function Modhub.ModBrowserDataProvider.newForSelector(integer, function(Mod.ModId, Mod.ModId), {Mod.GameModDesc}): ModBrowserDataProvider
Parameters
  • integer
  • function(Mod.ModId, Mod.ModId)
  • {Mod.GameModDesc}
Returns
  1. 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): ModBrowserDisplayData
Parameters
  • ModBrowserDataProvider
Returns
  1. ModBrowserDisplayData

Modhub.ModBrowserDataProvider.setLoadPageπŸ”—

function Modhub.ModBrowserDataProvider.setLoadPage(ModBrowserDataProvider, integer)
Parameters
  • ModBrowserDataProvider
  • integer

Modhub.ModBrowserDataProvider.setNextContinuousPageπŸ”—

function Modhub.ModBrowserDataProvider.setNextContinuousPage(ModBrowserDataProvider)
Parameters
  • ModBrowserDataProvider

Modhub.ModBrowserDataProvider.setCurrentPageπŸ”—

function Modhub.ModBrowserDataProvider.setCurrentPage(ModBrowserDataProvider, integer)
Parameters
  • ModBrowserDataProvider
  • integer

Modhub.ModBrowserDataProvider.setSearchStringπŸ”—

function Modhub.ModBrowserDataProvider.setSearchString(ModBrowserDataProvider, string)
Parameters
  • ModBrowserDataProvider
  • string

Modhub.ModBrowserDataProvider.setSearchUserIdπŸ”—

function Modhub.ModBrowserDataProvider.setSearchUserId(ModBrowserDataProvider, UserId)
Parameters
  • ModBrowserDataProvider
  • UserId

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
  • ModBrowserDataProvider
  • boolean

Modhub.ModBrowserDataProvider.getSortTypeπŸ”—

function Modhub.ModBrowserDataProvider.getSortType(ModBrowserDataProvider): Modhub.SortType
Parameters
  • ModBrowserDataProvider
Returns
  1. Modhub.SortType

Modhub.ModBrowserDataProvider.getTagToggledπŸ”—

function Modhub.ModBrowserDataProvider.getTagToggled(ModBrowserDataProvider, string): boolean
Parameters
  • ModBrowserDataProvider
  • string
Returns
  1. boolean

Modhub.ModBrowserDataProvider.setSortTypeπŸ”—

function Modhub.ModBrowserDataProvider.setSortType(ModBrowserDataProvider, SortType)
Parameters
  • ModBrowserDataProvider
  • SortType

Modhub.ModBrowserDataProvider.setNextSortTypeπŸ”—

function Modhub.ModBrowserDataProvider.setNextSortType(ModBrowserDataProvider)
Parameters
  • ModBrowserDataProvider

Modhub.ModBrowserDataProvider.toggleTagπŸ”—

function Modhub.ModBrowserDataProvider.toggleTag(ModBrowserDataProvider, string)
Parameters
  • ModBrowserDataProvider
  • string

Modhub.ModBrowserDataProvider.resetFiltersπŸ”—

function Modhub.ModBrowserDataProvider.resetFilters(ModBrowserDataProvider)
Parameters
  • ModBrowserDataProvider

Modhub.ModBrowserDataProvider.getSortAndFilterOptionsπŸ”—

function Modhub.ModBrowserDataProvider.getSortAndFilterOptions(ModBrowserDataProvider): Modhub.SortAndFilterOptions
Parameters
  • ModBrowserDataProvider
Returns
  1. Modhub.SortAndFilterOptions

Modhub.StagingModDataπŸ”—

record Modhub.StagingModData
record State Sync: State Ready: State Publishing: State HasResult: State end
equals: function(StagingModData, StagingModData): boolean localModhubDetails: Modhub.ModDetailsData state: State modhubId: Modhub.ModId modhubDetails: Modhub.ModDetailsData publishResult: AsyncResult<UploadModData> end

Modhub.StagingModData.StateπŸ”—

record Modhub.StagingModData.State Sync: State Ready: State Publishing: State HasResult: State end

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): boolean
Parameters
  • StagingModData
  • StagingModData
Returns
  1. 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()(): PublishSettings
Returns
  1. PublishSettings

Modhub.PublishSettings.new(PublishSettings)πŸ”—

function Modhub.PublishSettings.new(PublishSettings)(PublishSettings): PublishSettings
Parameters
  • PublishSettings
Returns
  1. 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): ModPublishHelper
Parameters
  • BackendId
Returns
  1. ModPublishHelper

Modhub.ModPublishHelper.hasAnyStagingModsπŸ”—

function Modhub.ModPublishHelper.hasAnyStagingMods(publishHelper : ModPublishHelper): boolean

Checks if there are any mods in the staging area

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
Returns
  1. boolean

Modhub.ModPublishHelper.canRefreshπŸ”—

function Modhub.ModPublishHelper.canRefresh(publishHelper : ModPublishHelper): boolean

Checks if the publish helper can be refreshed

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
Returns
  1. boolean

Modhub.ModPublishHelper.refreshπŸ”—

function Modhub.ModPublishHelper.refresh(publishHelper : ModPublishHelper): AsyncResult<RefreshData>

Refreshes the mod helper, this is an async operation

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
Returns
  1. 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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
Returns
  1. boolean

Modhub.ModPublishHelper.getStagingModDataπŸ”—

function Modhub.ModPublishHelper.getStagingModData(publishHelper : ModPublishHelper, modId : Modhub.ModId): StagingModData

Returns the staging mod data for a specific mod

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
Returns
  1. StagingModData

Modhub.ModPublishHelper.setModDetailsπŸ”—

function Modhub.ModPublishHelper.setModDetails(publishHelper : ModPublishHelper, modId : Modhub.ModId, modDetailsData : Modhub.ModDetailsData)

Sets the mod details data

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the local mod id of the mod to update
  • modDetailsData :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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • localModId :Modhub.ModId β€” the local mod id of the mod to update
  • remoteModId :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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
  • publishSettings :PublishSettings β€” the publish settings
  • validationResult :Modhub.ModValidatorResult β€” the validation result
Returns
  1. 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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
Returns
  1. UniquePendingRequestId

Modhub.ModPublishHelper.addLogoImageπŸ”—

function Modhub.ModPublishHelper.addLogoImage(publishHelper : ModPublishHelper, modId : Modhub.ModId, image : string)

Adds a list of image to the mod gallery

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
  • image :string β€” image file to add to the gallery

Modhub.ModPublishHelper.removeLogoImageπŸ”—

function Modhub.ModPublishHelper.removeLogoImage(publishHelper : ModPublishHelper, modId : Modhub.ModId)

Removes the logo image

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
  • images :{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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
  • index :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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
  • fromIndex :integer β€” the index in the mod gallery of the image to move
  • toIndex :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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :Modhub.ModId β€” the mod id
  • publishFn :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

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
  • modId :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)

Parameters
  • publishHelper :ModPublishHelper β€” the publish helper
Returns
  1. Modhub.SortAndFilterOptions β€” an object containing the list of sort and filter options
Transport Fever 3 Wiki
Gameplay ReferenceComing soon
●
Modding Manual
  • api
  • api.cmd
  • api.engine
  • api.engine.system
  • api.engine.util
  • api.gui
  • api.res
  • api.type
  • api.type.mod
  • api.type.modhub
  • api.type.transformator
  • app
  • main
  • content
    • base
      • difficulty_util
      • model_metadata_util
      • post_run_util
    • climates
      • gen
        • map_gen_util_serialized
    • game_mechanics
      • achievements
        • sound
          • achievement_sfx
      • celebrations
        • celebration_react_util
        • gui
          • sound
            • celebration_sfx
      • company
        • company
        • company_metadata
        • company_progression_util
        • company_react_util
        • company_static_util
        • company_util
        • explorations
          • exploration_plane
        • prospection_metadata
        • sound
          • company_sfx
      • emission
        • emission_config_metadata
        • emission_metadata
        • emissions
      • finance
        • account
        • finances_react_util
        • finances_util
        • loan
        • loan_util
        • sound
          • finance_sfx
      • fun_elements
        • blimp_util
        • custom_entity_util
        • fun_elements
        • rocket_util
        • ufo_util
      • game_time
        • game_time
      • industries
        • industries
      • notifications
        • gui
          • notification_colors
          • sound
            • notification_sfx
        • notification_legacy_util
        • notification_util
        • notifications
        • types
          • notification_react_util
          • notification_types
      • subventions
        • specific_subvention
        • subvention
        • subvention_legacy_util
        • subvention_util
        • subventions_gui
      • towns
        • district_colors
        • sound
          • town_sfx
        • town_cargo
        • town_growth_metadata
        • town_marketing_metadata
        • town_react_util
        • town_util
        • town_util_parallel
        • towns
    • gui
      • construction
        • construction_colors
        • construction_desc_react_util
        • construction_menu
        • construction_react_util
        • sound
          • construction_sfx
        • track_description_metadata
        • track_modifier_metadata
      • context_helper
        • context_helper
      • entity_window
        • animal
          • animal_eow
        • empty_construction
          • empty_construction_eow
        • entity_window_hud
        • entity_window_util
        • eow_extension_util
        • fun_elements
          • fun_elements_eow
        • gameplay_colors
        • industry
          • industry_eow
        • industry_react_util
        • line
          • line_eow
        • maintenance_station
          • maintenance_station_eow
        • perk
          • perk_eow
        • sim_person
          • sim_person_eow
        • station_group
          • station_group_eow
        • town
          • town_eow
        • town_building
          • town_building_eow
        • vehicle
          • vehicle_eow
        • view_manager
        • view_manager_util
        • warehouse
          • warehouse_eow
      • game_bar
        • game_bar
        • game_bar_widgets
      • guidesystem
        • sound
          • guidesystem_sfx
      • hud
        • hud_gui_config
        • hud_react_util
      • layers
        • layer_cargo
        • layer_cargo_flow
        • layer_colors
        • layer_noise
        • layer_pollution
        • layer_public_transport
        • layer_react_util
        • layer_traffic
        • layers_button_ridge
      • line_vehicle_mgmt
        • cargofilter_window
        • feedback_list_util
        • line
        • line_react_util
        • line_util
        • manager_hud_util
        • manager_tooltips_util
        • manager_window
        • sound
          • lvm_sfx
        • vehicle_list_react_util
        • vehicle_react_util
        • vehicle_store
        • vehicle_store_table
        • vehicle_store_util
        • vehicle_store_window
        • vehicle_util
      • main
        • button_react_util
        • callout_react_util
        • cargo_react_util
        • cargo_util
        • collapsible_checkbox_list
        • content_card
        • credits_react_util
        • default_colors
        • disable_features
        • engine_react_util
        • free_cam_options
        • game_context
        • game_react_globals
        • game_tooltips
        • game_windows
        • gui_react_util
        • gui_res_modding
        • hud_icon_toolbox
        • industry_util
        • input_action_colors
        • main_mod_button_area
        • menu_category_util
        • mod_entry_point
        • particle_colors
        • particle_react_util
        • popover_react_util
        • radial_menu_extension
        • script_param_util
        • selection_colors
        • selector
        • selector_react_util
        • styleutil
        • tile_list_react_util
        • tool_react_util
        • town_hud_react_util
      • map_editor
        • map_editor
      • menu
        • dialog_react_util
        • difficulty_react_util
        • graphics_presets_util
        • main_menu
        • map_preview_colors
        • menu_icon_react_util
        • menu_util
        • mod_colors
        • mod_manager_react_util
        • mod_util
        • new_game_react_util
        • paradox_react_util
        • releasenotes_util
        • savegame_react_util
        • sound
          • main_menu_sfx
      • sound
        • gui_comp_sfx
      • statistics
        • statistics
        • statistics_react_util
    • industries
      • industry_productivity_util
      • industry_workers
    • infrastructure
      • traffic_light
        • traffic_light
    • landmarks
      • hq
        • headquarter_util_serialized
      • landmark
      • landmark_util
      • landmark_util_serialized
    • mission
      • arrival_tracker
      • builder_util
      • calendar
      • guide_system
        • guide_system_react
        • guides
          • guide_event
          • guide_generic
          • guide_state
          • guide_timer
          • guide_ui_event
      • mission_boot_util
      • mission_colors
      • mission_framework
        • mission_end_window_util
        • mission_framework_react
        • mission_framework_react_util
        • mission_framework_util
        • mission_framework_util_entity
        • mission_framework_util_line
        • mission_interface
      • mission_pathfinding_util
      • mission_react_util
      • mission_task_util
      • mission_types
      • modifier
      • name_util
      • tasks
        • assign_vehicle
          • mission_task_assign_vehicle
          • mission_task_visit_stations_ordered
        • auto_builder
          • mission_task_electrify
          • mission_task_track_builder
          • prepare_track_building_util
        • build_construction
          • mission_task_build_construction
          • mission_task_build_construction_util
          • mission_task_build_construction_variant
        • build_path
          • mission_task_build_path
        • bulldoze
          • mission_task_auto_bulldoze
          • mission_task_bulldoze
        • buy_vehicle
          • mission_task_buy_vehicle
          • mission_task_clone_vehicle
        • click_and_collect_custom_entity
          • mission_task_collect_entity
          • mission_task_spawn_entity
        • click_entity
          • mission_task_click_entity
        • connect_nodes
          • mission_task_connect_nodes
        • create_line
          • mission_task_create_line
          • mission_task_create_line_for_towns
          • mission_task_stop_config
        • cutscene
          • mission_task_cutscene
        • dialogue
          • mission_task_dialogue
        • finish
          • mission_task_finish
        • guide
          • mission_task_guide
          • mission_task_guide_collect_entity
        • join
          • mission_task_join
        • mission_dialogue_data
        • non_bulldozable
          • mission_task_non_bulldozable
        • observe_entity
          • mission_task_observe_entity
        • page
          • mission_task_page
        • spawn_sims
          • mission_task_spawn_sims
          • sampling_util
        • subsidies
          • mission_task_guide_subsidies
          • mission_task_subsidies
        • task_decorator
        • town_rating
          • mission_task_town_rating
          • mission_task_town_rating_observer
        • town_size
          • mission_task_town_size
        • transfer_ownership
          • mission_task_transfer_ownership
          • transfer_ownership_util
        • transport_cargo
          • mission_task_empty_stocks
          • mission_task_industry_boosted
          • mission_task_transport_cargo
          • mission_task_transport_cargo_faster
          • mission_task_transport_cargo_observer
          • mission_task_transport_passengers
        • utility
          • mission_task_cargo_needs
          • mission_task_check_entities
          • mission_task_check_landmark_level
          • mission_task_clouds
          • mission_task_highlight
          • mission_task_industry_activity
          • mission_task_landmark_requirements
          • mission_task_play_sound
          • mission_task_protected_entities
          • mission_task_relay_update
          • mission_task_send_command
          • mission_task_send_event
          • mission_task_store_any
          • mission_task_substitute_constructions
          • mission_task_time_of_day
          • mission_task_town_development
          • mission_town_util
        • vehicle_util
          • mission_task_replace_vehicles
          • mission_task_sell_vehicles
          • mission_task_start_vehicles
          • mission_task_vehicle_modifier
          • mission_task_vehicle_position
          • mission_vehicle_util
        • wait
          • mission_task_wait
          • mission_task_wait_event
          • mission_task_wait_for
          • mission_task_wait_ui_event
        • waypoints
          • mission_task_waypoints
      • tutorial
        • tasks
          • mission_task_tutorial_init
        • tutorial_story_util
    • scripts
      • app_util
      • audio_util
      • builtin
      • construction
        • asset_util
        • collider_util_serialized
        • construction_config_metadata
        • construction_specialization_metadata
        • construction_util_serialized
        • lane_util_serialized
        • modules_util_serialized
        • param_util
        • street_util_serialized
      • entity_util
      • gamescript
      • journal
      • lang_util
      • log
      • mat4
      • math_util
      • metadata_util
      • polygon_util
      • random_util
      • react
      • soundset
      • string_util
      • table_util
      • tex_util
      • transformator_util
      • util
        • config_util
        • listutil
        • romberg_util
        • town_growth_function
      • vec2
      • vec3
      • vec4
    • stations
      • station_metadata
    • vehicle
      • vehicle_modifier

Generated 19-08-2026

Transport Fever 3 ● Urban Games Β© 2026