Module content.game_mechanics.notifications.notification_util🔗

global record NotificationUtil  defaultAutoDismissDurationMs: integer
  getGuiTypeFromNotificationType: function(string): NotificationGuiData.Type
  getNotificationType2Label: function(): {string : string}
  getAllNotificationGuiTypes: function(): {NotificationGuiData.Type}
  getAllNotificationTypesForGuiType: function(NotificationGuiData.Type): {string}
  getNotificationSimUpdateScript: function(string): string
  removeNotification: function(NotificationsState, integer)
  addNotification: function(NotificationsState, Notification): integer
  enlistNotification: function(NotificationsState, integer)
  dismissNotification: function(NotificationsState, integer)
  updatePersistentNotifications: function(NotificationsState, {string : {integer}}, PersistentNotifications)
  removePersistentNotifications: function(NotificationsState, {string : {integer}}, RemovePersistentNotifications)
  externalGetNotificationsState: function(): NotificationsState
  getPersistentHistoryByType: function(NotificationsState): {string : {integer}}
  removeUnavailableAvailabilityNotifications: function(NotificationsState)
  externalGetNotificationsStateNative: function(): NativeLuaTable
  getPersistingEntity2NotificationFromNative: function(NativeLuaTable): {Engine.Entity : {integer}}
  getHistoryFromNative: function(NativeLuaTable): {integer}
  getNotificationFromNative: function(NativeLuaTable, integer): Notification
  getNotificationEntryFromNative: function(NativeLuaTable, integer): NotificationsState.Entry
  preFilterOutExcessiveVehicleNotification: function(NotificationsState.Entry): boolean
  filterOutExcessiveVehicleNotification: function(NotificationsState.Entry, {Engine.Entity : integer}): boolean
end

Category: globals🔗

NotificationUtil🔗

global record NotificationUtil  defaultAutoDismissDurationMs: integer
  getGuiTypeFromNotificationType: function(string): NotificationGuiData.Type
  getNotificationType2Label: function(): {string : string}
  getAllNotificationGuiTypes: function(): {NotificationGuiData.Type}
  getAllNotificationTypesForGuiType: function(NotificationGuiData.Type): {string}
  getNotificationSimUpdateScript: function(string): string
  removeNotification: function(NotificationsState, integer)
  addNotification: function(NotificationsState, Notification): integer
  enlistNotification: function(NotificationsState, integer)
  dismissNotification: function(NotificationsState, integer)
  updatePersistentNotifications: function(NotificationsState, {string : {integer}}, PersistentNotifications)
  removePersistentNotifications: function(NotificationsState, {string : {integer}}, RemovePersistentNotifications)
  externalGetNotificationsState: function(): NotificationsState
  getPersistentHistoryByType: function(NotificationsState): {string : {integer}}
  removeUnavailableAvailabilityNotifications: function(NotificationsState)
  externalGetNotificationsStateNative: function(): NativeLuaTable
  getPersistingEntity2NotificationFromNative: function(NativeLuaTable): {Engine.Entity : {integer}}
  getHistoryFromNative: function(NativeLuaTable): {integer}
  getNotificationFromNative: function(NativeLuaTable, integer): Notification
  getNotificationEntryFromNative: function(NativeLuaTable, integer): NotificationsState.Entry
  preFilterOutExcessiveVehicleNotification: function(NotificationsState.Entry): boolean
  filterOutExcessiveVehicleNotification: function(NotificationsState.Entry, {Engine.Entity : integer}): boolean
end

NotificationUtil.defaultAutoDismissDurationMs🔗

NotificationUtil.defaultAutoDismissDurationMs: integer

NotificationUtil.getGuiTypeFromNotificationType🔗

function NotificationUtil.getGuiTypeFromNotificationType(string): NotificationGuiData.Type
Parameters
  • string
Returns
  1. NotificationGuiData.Type

NotificationUtil.getNotificationType2Label🔗

function NotificationUtil.getNotificationType2Label(): {string : string}
Returns
  1. {string : string}

NotificationUtil.getAllNotificationGuiTypes🔗

function NotificationUtil.getAllNotificationGuiTypes(): {NotificationGuiData.Type}
Returns
  1. {NotificationGuiData.Type}

NotificationUtil.getAllNotificationTypesForGuiType🔗

function NotificationUtil.getAllNotificationTypesForGuiType(NotificationGuiData.Type): {string}
Parameters
  • NotificationGuiData.Type
Returns
  1. {string}

NotificationUtil.getNotificationSimUpdateScript🔗

function NotificationUtil.getNotificationSimUpdateScript(string): string
Parameters
  • string
Returns
  1. string

NotificationUtil.removeNotification🔗

function NotificationUtil.removeNotification(NotificationsState, integer)
Parameters
  • NotificationsState
  • integer

NotificationUtil.addNotification🔗

function NotificationUtil.addNotification(NotificationsState, Notification): integer
Parameters
  • NotificationsState
  • Notification
Returns
  1. integer

NotificationUtil.enlistNotification🔗

function NotificationUtil.enlistNotification(NotificationsState, integer)
Parameters
  • NotificationsState
  • integer

NotificationUtil.dismissNotification🔗

function NotificationUtil.dismissNotification(NotificationsState, integer)
Parameters
  • NotificationsState
  • integer

NotificationUtil.updatePersistentNotifications🔗

function NotificationUtil.updatePersistentNotifications(NotificationsState, {string : {integer}}, PersistentNotifications)
Parameters
  • NotificationsState
  • {string : {integer}}
  • PersistentNotifications

NotificationUtil.removePersistentNotifications🔗

function NotificationUtil.removePersistentNotifications(NotificationsState, {string : {integer}}, RemovePersistentNotifications)
Parameters
  • NotificationsState
  • {string : {integer}}
  • RemovePersistentNotifications

NotificationUtil.externalGetNotificationsState🔗

function NotificationUtil.externalGetNotificationsState(): NotificationsState
Returns
  1. NotificationsState

NotificationUtil.getPersistentHistoryByType🔗

function NotificationUtil.getPersistentHistoryByType(NotificationsState): {string : {integer}}
Parameters
  • NotificationsState
Returns
  1. {string : {integer}}

NotificationUtil.removeUnavailableAvailabilityNotifications🔗

function NotificationUtil.removeUnavailableAvailabilityNotifications(NotificationsState)
Parameters
  • NotificationsState

NotificationUtil.externalGetNotificationsStateNative🔗

function NotificationUtil.externalGetNotificationsStateNative(): NativeLuaTable
Returns
  1. NativeLuaTable

NotificationUtil.getPersistingEntity2NotificationFromNative🔗

function NotificationUtil.getPersistingEntity2NotificationFromNative(NativeLuaTable): {Engine.Entity : {integer}}
Parameters
  • NativeLuaTable
Returns
  1. {Engine.Entity : {integer}}

NotificationUtil.getHistoryFromNative🔗

function NotificationUtil.getHistoryFromNative(NativeLuaTable): {integer}
Parameters
  • NativeLuaTable
Returns
  1. {integer}

NotificationUtil.getNotificationFromNative🔗

function NotificationUtil.getNotificationFromNative(NativeLuaTable, integer): Notification
Parameters
  • NativeLuaTable
  • integer
Returns
  1. Notification

NotificationUtil.getNotificationEntryFromNative🔗

function NotificationUtil.getNotificationEntryFromNative(NativeLuaTable, integer): NotificationsState.Entry
Parameters
  • NativeLuaTable
  • integer
Returns
  1. NotificationsState.Entry

NotificationUtil.preFilterOutExcessiveVehicleNotification🔗

function NotificationUtil.preFilterOutExcessiveVehicleNotification(NotificationsState.Entry): boolean
Parameters
  • NotificationsState.Entry
Returns
  1. boolean

NotificationUtil.filterOutExcessiveVehicleNotification🔗

function NotificationUtil.filterOutExcessiveVehicleNotification(NotificationsState.Entry, {Engine.Entity : integer}): boolean
Parameters
  • NotificationsState.Entry
  • {Engine.Entity : integer}
Returns
  1. boolean