Module content.game_mechanics.notifications.notifications🔗
global record DismissNotification
id: integer endglobal record Notification
type: string params: {<any type> : <any type>} notificationId: integer autoDismissDuration: integer simParams: any endglobal record NotificationGuiData
title: string description: string icon: string hudIcon: string hudIcon3DTooltip: string previewImage: string soundOnMount: {FilePath} onClick: function(boolean) status: Status progress: Progress progresses: {Progress} endglobal record NotificationLogToolParam
onClose: function() storeFilterState: function(FilterState) initialFilterState: FilterState endglobal record NotificationSimType<T>
updateData: function(T, any): any endglobal record NotificationsState
notifications: {integer : Entry} history: {integer} version: integer noRoadConnectionUpdateTimestamp: integer maxId: integer ignoredTypes: {string : boolean} onlyPopupIgnored: boolean pause: boolean autoUnpauseNextStep: booleanrecord Entry
timestamp: integer notification: Notification persisting: {EntityUtil.EntityAndRevision} compareState: any dismissed: boolean hideInLogAndPopups: boolean hidden: boolean playedInitialSound: boolean endvehicle2problem: {Engine.Entity : VehicleProblem} line2problemTimestamp: {Engine.Entity : integer} endrecord VehicleProblem
problemSince: integer endglobal record PersistentNotifications
entitiesAndParam: {EntitiesAndParam} type: string keepInLog: boolean passOnlyParam: boolean addOnly: boolean endglobal record RemovePersistentNotifications
entities: {EntityUtil.EntityAndRevision} type: string keepInLog: boolean end
Category: globals🔗
DismissNotification🔗
global record DismissNotification
id: integer end
DismissNotification.id🔗
DismissNotification.id: integer
Notification🔗
global record Notification
type: string params: {<any type> : <any type>} notificationId: integer autoDismissDuration: integer simParams: any end
Notification.type🔗
Notification.type: string
Notification.params🔗
Notification.params: {<any type> : <any type>}
Notification.notificationId🔗
Notification.notificationId: integer
Notification.autoDismissDuration🔗
Notification.autoDismissDuration: integer
Notification.simParams🔗
Notification.simParams: any
NotificationButtonParam🔗
NotificationButtonParam.gameCtx🔗
NotificationButtonParam.gameCtx: GameContext
NotificationGuiData🔗
global record NotificationGuiData
title: string description: string icon: string hudIcon: string hudIcon3DTooltip: string previewImage: string soundOnMount: {FilePath} onClick: function(boolean) status: Status progress: Progress progresses: {Progress} end
NotificationGuiData.Type🔗
NotificationGuiData.Type."Achievement"🔗
NotificationGuiData.Type."Caution"🔗
NotificationGuiData.Type."Info"🔗
NotificationGuiData.Type."Opportunity"🔗
NotificationGuiData.Type."Problem"🔗
NotificationGuiData.Type."Unknown"🔗
NotificationGuiData.Status🔗
NotificationGuiData.Status."Failed"🔗
NotificationGuiData.Status."Pending"🔗
NotificationGuiData.title🔗
NotificationGuiData.title: string
NotificationGuiData.description🔗
NotificationGuiData.description: string
NotificationGuiData.icon🔗
NotificationGuiData.icon: string
NotificationGuiData.hudIcon🔗
NotificationGuiData.hudIcon: string
NotificationGuiData.hudIcon3DTooltip🔗
NotificationGuiData.hudIcon3DTooltip: string
NotificationGuiData.previewImage🔗
NotificationGuiData.previewImage: string
NotificationGuiData.soundOnMount🔗
NotificationGuiData.soundOnMount: {FilePath}
NotificationGuiData.onClick🔗
function NotificationGuiData.onClick(boolean)Parameters
boolean
NotificationGuiData.status🔗
NotificationGuiData.status: Status
NotificationGuiData.Progress🔗
NotificationGuiData.Progress.percentage🔗
NotificationGuiData.Progress.percentage: number
NotificationGuiData.Progress.text🔗
NotificationGuiData.Progress.text: string
NotificationGuiData.Progress.remainingDurationMs🔗
NotificationGuiData.Progress.remainingDurationMs: number
NotificationGuiData.progress🔗
NotificationGuiData.progress: Progress
NotificationGuiData.progresses🔗
NotificationGuiData.progresses: {Progress}
NotificationLogToolParam🔗
global record NotificationLogToolParam
onClose: function() storeFilterState: function(FilterState) initialFilterState: FilterState end
NotificationLogToolParam.FilterState🔗
record NotificationLogToolParam.FilterState
category: NotificationGuiData.Type displayIndex: integer end
NotificationLogToolParam.FilterState.category🔗
NotificationLogToolParam.FilterState.category: NotificationGuiData.Type
NotificationLogToolParam.FilterState.displayIndex🔗
NotificationLogToolParam.FilterState.displayIndex: integer
NotificationLogToolParam.onClose🔗
function NotificationLogToolParam.onClose()
NotificationLogToolParam.storeFilterState🔗
function NotificationLogToolParam.storeFilterState(FilterState)Parameters
FilterState
NotificationLogToolParam.initialFilterState🔗
NotificationLogToolParam.initialFilterState: FilterState
NotificationSimType🔗
global record NotificationSimType<T>
updateData: function(T, any): any end
Type Parameters
T
NotificationSimType.updateData🔗
function NotificationSimType.updateData(T, any): anyParameters
Tany
any
NotificationType🔗
Type Parameters
T
NotificationType.useDataState🔗
function NotificationType.useDataState(T, any): NotificationGuiDataParameters
Tany
NotificationGuiData
NotificationsState🔗
global record NotificationsState
notifications: {integer : Entry} history: {integer} version: integer noRoadConnectionUpdateTimestamp: integer maxId: integer ignoredTypes: {string : boolean} onlyPopupIgnored: boolean pause: boolean autoUnpauseNextStep: booleanrecord Entry
timestamp: integer notification: Notification persisting: {EntityUtil.EntityAndRevision} compareState: any dismissed: boolean hideInLogAndPopups: boolean hidden: boolean playedInitialSound: boolean endvehicle2problem: {Engine.Entity : VehicleProblem} line2problemTimestamp: {Engine.Entity : integer} endrecord VehicleProblem
problemSince: integer end
NotificationsState.Entry🔗
record NotificationsState.Entry
timestamp: integer notification: Notification persisting: {EntityUtil.EntityAndRevision} compareState: any dismissed: boolean hideInLogAndPopups: boolean hidden: boolean playedInitialSound: boolean end
NotificationsState.Entry.timestamp🔗
NotificationsState.Entry.timestamp: integer
NotificationsState.Entry.notification🔗
NotificationsState.Entry.notification: Notification
NotificationsState.Entry.persisting🔗
NotificationsState.Entry.persisting: {EntityUtil.EntityAndRevision}
NotificationsState.Entry.compareState🔗
NotificationsState.Entry.compareState: any
NotificationsState.Entry.dismissed🔗
NotificationsState.Entry.dismissed: boolean
NotificationsState.Entry.hideInLogAndPopups🔗
NotificationsState.Entry.hideInLogAndPopups: boolean
NotificationsState.Entry.hidden🔗
NotificationsState.Entry.hidden: boolean
NotificationsState.Entry.playedInitialSound🔗
NotificationsState.Entry.playedInitialSound: boolean
NotificationsState.notifications🔗
NotificationsState.notifications: {integer : Entry}
NotificationsState.history🔗
NotificationsState.history: {integer}
NotificationsState.version🔗
NotificationsState.version: integer
NotificationsState.noRoadConnectionUpdateTimestamp🔗
NotificationsState.noRoadConnectionUpdateTimestamp: integer
NotificationsState.maxId🔗
NotificationsState.maxId: integer
NotificationsState.ignoredTypes🔗
NotificationsState.ignoredTypes: {string : boolean}
NotificationsState.onlyPopupIgnored🔗
NotificationsState.onlyPopupIgnored: boolean
NotificationsState.pause🔗
NotificationsState.pause: boolean
NotificationsState.autoUnpauseNextStep🔗
NotificationsState.autoUnpauseNextStep: boolean
NotificationsState.VehicleProblem🔗
record NotificationsState.VehicleProblem
problemSince: integer end
NotificationsState.VehicleProblem.problemSince🔗
NotificationsState.VehicleProblem.problemSince: integer
NotificationsState.vehicle2problem🔗
NotificationsState.vehicle2problem: {Engine.Entity : VehicleProblem}
NotificationsState.line2problemTimestamp🔗
NotificationsState.line2problemTimestamp: {Engine.Entity : integer}
PersistentNotifications🔗
global record PersistentNotifications
entitiesAndParam: {EntitiesAndParam} type: string keepInLog: boolean passOnlyParam: boolean addOnly: boolean end
PersistentNotifications.EntitiesAndParam🔗
record PersistentNotifications.EntitiesAndParam
entities: {EntityUtil.EntityAndRevision} param: any compareState: any end
PersistentNotifications.EntitiesAndParam.entities🔗
PersistentNotifications.EntitiesAndParam.entities: {EntityUtil.EntityAndRevision}
PersistentNotifications.EntitiesAndParam.param🔗
PersistentNotifications.EntitiesAndParam.param: any
PersistentNotifications.EntitiesAndParam.compareState🔗
PersistentNotifications.EntitiesAndParam.compareState: any
PersistentNotifications.entitiesAndParam🔗
PersistentNotifications.entitiesAndParam: {EntitiesAndParam}
PersistentNotifications.type🔗
PersistentNotifications.type: string
PersistentNotifications.keepInLog🔗
PersistentNotifications.keepInLog: boolean
PersistentNotifications.passOnlyParam🔗
PersistentNotifications.passOnlyParam: boolean
PersistentNotifications.addOnly🔗
PersistentNotifications.addOnly: boolean
RemovePersistentNotifications🔗
global record RemovePersistentNotifications
entities: {EntityUtil.EntityAndRevision} type: string keepInLog: boolean end
RemovePersistentNotifications.entities🔗
RemovePersistentNotifications.entities: {EntityUtil.EntityAndRevision}
RemovePersistentNotifications.type🔗
RemovePersistentNotifications.type: string
RemovePersistentNotifications.keepInLog🔗
RemovePersistentNotifications.keepInLog: boolean