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

Player

Noir.Classes.Player: NoirClass

Represents a player.


Noir.Classes.Player:Init(name, ID, steam, admin, auth, permissions)

Initializes player class objects.

Parameters

  • name: string

  • ID: integer

  • steam: string

  • admin: boolean

  • auth: boolean

  • permissions: table<string, boolean>


Noir.Classes.Player:SetPermission(permission)

Give this player a permission.

Parameters

  • permission: string


Noir.Classes.Player:HasPermission(permission)

Returns whether or not this player has a permission.

Parameters

  • permission: string

Returns

  • boolean


Noir.Classes.Player:RemovePermission(permission)

Remove a permission from this player.

Parameters

  • permission: string


Noir.Classes.Player:GetPermissions()

Returns a table containing the player's permissions.

Returns

  • table<integer, string>


Noir.Classes.Player:SetAuth(auth)

Sets whether or not this player is authed.

Parameters

  • auth: boolean


Noir.Classes.Player:SetAdmin(admin)

Sets whether or not this player is an admin.

Parameters

  • admin: boolean


Noir.Classes.Player:Kick()

Kicks this player.


Noir.Classes.Player:Ban()

Bans this player.


Noir.Classes.Player:Teleport(pos)

Teleports this player.

Parameters

  • pos: SWMatrix


Noir.Classes.Player:GetPosition()

Returns this player's position.

Returns

  • SWMatrix


Noir.Classes.Player:SetAudioMood(mood)

Set the player's audio mood.

Parameters

  • mood: SWAudioMoodEnum


Noir.Classes.Player:GetCharacter()

Returns this player's character as a NoirObject.

Returns

  • NoirObject


Noir.Classes.Player:GetLook()

Returns this player's look direction.

Returns

  • number: LookX

  • number: LookY

  • number: LookZ


Noir.Classes.Player:Notify(title, message, notificationType)

Send this player a notification.

Parameters

  • title: string

  • message: string

  • notificationType: SWNotificationTypeEnum

PreviousObjectNextService

Last updated 2 months ago

β˜„οΈ