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
  • Returns
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Parameters
  • Returns
Edit on GitHub
  1. API Reference
  2. Built-Ins
  3. Classes
  4. Widgets

Widget

Noir.Classes.Widget: NoirClass

Represents a UI widget for the UI service.


Noir.Classes.Widget:Init(ID, visible, widgetType, player)

Initializes class objects from this class.

Parameters

  • ID: integer

  • visible: boolean

  • widgetType: NoirWidgetType

  • player: NoirPlayer|nil


Noir.Classes.Widget:Serialize()

Serializes this widget.

Returns

  • NoirSerializedWidget


Noir.Classes.Widget:_Serialize() ---@diagnostic disable-next-line missing-return

Serializes this widget.

abstract method

Returns

  • NoirSerializedWidget


Noir.Classes.Widget:Deserialize(serializedWidget)

Deserializes a serialized widget.

abstract method

static method

Parameters

  • serializedWidget: NoirSerializedWidget

Returns

  • NoirWidget|nil


Noir.Classes.Widget:Update()

Updates this widget.


Noir.Classes.Widget:_Update(player)

Updates this widget.

abstract method

Parameters

  • player: NoirPlayer


Noir.Classes.Widget:Destroy()

Destroys this widget.


Noir.Classes.Widget:_Destroy(player)

Destroys this widget.

abstract method

Parameters

  • player: NoirPlayer


Noir.Classes.Widget:Exists()

Returns if this widget still exists within the UIService.

Returns

  • boolean


Noir.Classes.Widget:Remove()

Removes this widget from the UIService and from the game.

PreviousScreenPopupWidgetNextLibraries

Last updated 2 months ago

β˜„οΈ