Noir
  • πŸšΆβ€β™‚οΈIntro
  • πŸ“Tutorials
    • πŸŽ“Starting Noir
    • πŸ“–Libraries
    • πŸ–₯️Services
    • ❔Libraries VS Services
    • πŸ’¬Callbacks
    • πŸ’₯Classes
    • πŸ”ŽDebugging
  • πŸ“šExamples
  • β˜„οΈAPI Reference
    • Bootstrapper
    • Built-Ins
      • Classes
        • AITarget
        • Body
        • Command
        • Connection
        • Event
        • HTTPRequest
        • HTTPResponse
        • Library
        • Message
        • Object
        • Player
        • Service
        • Task
        • TickIterationProcess
        • Tracker
        • Vehicle
        • Widgets
          • MapLabelWidget
          • MapLineWidget
          • MapObjectWidget
          • PopupWidget
          • ScreenPopupWidget
          • Widget
      • Libraries
        • Base64
        • Dataclasses
        • Deprecation
        • Events
        • HTTP
        • JSON
        • Logging
        • Matrix
        • Number
        • String
        • Table
      • Services
        • CommandService
        • GameSettingsService
        • HTTPService
        • MessageService
        • NotificationService
        • ObjectService
        • PlayerService
        • TaskService
        • TPSService
        • UIService
        • VehicleService
    • Callbacks
    • Class
    • Classes
    • Debugging
    • Definition
    • Libraries
    • Noir
    • Services
    • TypeChecking
Powered by GitBook
On this page
  • Parameters
  • Parameters
  • Returns
  • Parameters
  • Parameters
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Returns
Edit on GitHub
  1. API Reference
  2. Built-Ins
  3. Services

MessageService

Noir.Services.MessageService: NoirService

A service for storing, accessing and sending messages.


Noir.Services.MessageService:_LoadSavedMessages()

Load all saved messages.

Used internally.


Noir.Services.MessageService:_InsertIntoTable(tbl, value, limit)

Insert a value into a table, removing the first value if the table is full.

Used internally.

Parameters

  • tbl: table

  • value: any

  • limit: integer


Noir.Services.MessageService:_RegisterMessage(title, content, author, isAddon, sentAt, recipient, fireEvent)

Register a message.

Used internally.

Parameters

  • title: string

  • content: string

  • author: NoirPlayer|nil

  • isAddon: boolean

  • sentAt: number|nil

  • recipient: NoirPlayer|nil

  • fireEvent: boolean|nil

Returns

  • NoirMessage


Noir.Services.MessageService:_SaveMessage(message)

Save a message.

Used internally.

Parameters

  • message: NoirMessage


Noir.Services.MessageService:SendMessage(player, title, content, ...)

Send a message to a player or all players.

Parameters

  • player: NoirPlayer|nil - nil = everyone

  • title: string

  • content: string

  • ...: any

Returns

  • NoirMessage


Noir.Services.MessageService:GetMessagesByPlayer(player)

Returns all messages sent by a player.

Parameters

  • player: NoirPlayer

Returns

  • table<integer, NoirMessage>


Noir.Services.MessageService:GetAllMessages(copy)

Returns all messages.

Earliest entries in table = Oldest messages

Parameters

  • copy: boolean|nil - Whether or not to copy the table (recommended), but may be slow

Returns

  • table<integer, NoirMessage>

PreviousHTTPServiceNextNotificationService

Last updated 9 months ago

β˜„οΈ