Class Players

Implements

Constructors

constructor

Accessors

map

Methods

all get nearby online townless

Constructors

constructor

Accessors

map

Methods

Readonlyall

  • all(): Promise<{
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    }[]>

  • Returns Promise<{
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    }[]>

Readonlyget

  • get(...names): Promise<NotFoundError | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    } | (NotFoundError | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    })[]>

  • Parameters

    • Rest...names: string[]

    Returns Promise<NotFoundError | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    } | (NotFoundError | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    })[]>

Readonlynearby

  • nearby(location, radius, players?): Promise<Partial<{
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    }>[]>

  • Parameters

    • location: StrictPoint2D
    • radius: StrictPoint2D
    • Optionalplayers: {
          name: string;
          nickname?: string;
          underground?: boolean;
          world?: string;
          x: string | number;
          yaw?: string | number;
          z: string | number;
      }[]

    Returns Promise<Partial<{
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    }>[]>

Readonlyonline

  • online(includeResidentInfo?): Promise<{
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    }[] | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    }[]>

  • Parameters

    • includeResidentInfo: boolean = false

    Returns Promise<{
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    }[] | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    }[]>

Readonlytownless

  • townless(): Promise<({
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    } | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    })[]>

  • Returns Promise<({
        name: string;
        nickname?: string;
        underground?: boolean;
        world?: string;
        x: string | number;
        yaw?: string | number;
        z: string | number;
    } | {
        name: string;
        nation?: string;
        nickname?: string;
        online: boolean;
        rank: string;
        town: string;
        underground?: boolean;
        world?: string;
        x?: string | number;
        yaw?: string | number;
        z?: string | number;
    })[]>

Settings

Member Visibility

On This Page

constructormapallgetnearbyonlinetownless