Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Players

Hierarchy

  • Players

Index

Properties

Methods

Properties

utils

utils: { getIdentifiers: (playerServerId: number) => Identifiers } = ...

Type declaration

  • getIdentifiers: (playerServerId: number) => Identifiers
      • description

        Get all set of player ID and return it on JSON format

        example
        const license = getIdentifiers(1).license;

        Parameters

        • playerServerId: number

        Returns Identifiers

Methods

get

  • get(query: Query): { $index: number; last_position?: { heading: number; x: number; y: number; z: number }; license?: string; server_id?: number; updated_at?: number; user_id?: number }
  • description

    Received current data of a player

    example
    get({
         where: {
             license: "abc12345"
         }
    });

    Parameters

    • query: Query

      Data object to input

    Returns { $index: number; last_position?: { heading: number; x: number; y: number; z: number }; license?: string; server_id?: number; updated_at?: number; user_id?: number }

    • $index: number
    • Optional last_position?: { heading: number; x: number; y: number; z: number }
      • heading: number
      • x: number
      • y: number
      • z: number
    • Optional license?: string
    • Optional server_id?: number
    • Optional updated_at?: number
    • Optional user_id?: number

listAll

update

  • description

    Update current data of a player

    example
    update({
         data: {
             someNestedThings: true
         },
         where: {
             license: "76asdasd56119829asdads0395137"
         }
    });

    Parameters

    • data: Data

      Data object to input

    Returns Promise<boolean>

Generated using TypeDoc