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

Command

Noir.Classes.Command: NoirClass

Represents a command.


Noir.Classes.Command:Init(name, aliases, requiredPermissions, requiresAuth, requiresAdmin, capsSensitive, description)

Initializes command class objects.

Parameters

  • name: string

  • aliases: table<integer, string>

  • requiredPermissions: table<integer, string>

  • requiresAuth: boolean

  • requiresAdmin: boolean

  • capsSensitive: boolean

  • description: string


Noir.Classes.Command:_Use(player, message, args)

Trigger this command.

Used internally. Do not use in your code.

Parameters

  • player: NoirPlayer

  • message: string

  • args: table


Noir.Classes.Command:_Matches(query)

Returns whether or not the string matches this command.

Used internally. Do not use in your code.

Parameters

  • query: string

Returns

  • boolean


Noir.Classes.Command:CanUse(player)

Returns whether or not the player can use this command.

Parameters

  • player: NoirPlayer

Returns

  • boolean

PreviousBodyNextConnection

Last updated 2 months ago

β˜„οΈ