PhoneBook

Type Declaration

• addNumber: function

  • addNumber(
        number: number,
        name: string,
        textId?: number,
        cost?: number,
        type?: number,
    ): void

    Adds or replaces a replicated telephone-directory entry.

    Parameters

    • number: number

      Telephone number to register.

    • name: string

      Display name shown to players.

    • OptionaltextId: number

      Optional game localization text identifier.

    • Optionalcost: number

      Optional call cost.

    • Optionaltype: number

      Optional game-specific entry type.

    Returns void

• clear: function

  • clear(): void

    Removes all replicated telephone-directory entries.

    Returns void

• getNumbers: function

  • getNumbers(): PhoneBookEntry[]

    Returns a snapshot of all registered telephone numbers.

    Returns PhoneBookEntry[]

    The configured directory entries.

• has: function

  • has(number: number): boolean

    Checks whether a telephone number is registered.

    Parameters

    • number: number

      Telephone number to look up.

    Returns boolean

    True when the number exists.

• removeNumber: function

  • removeNumber(number: number): boolean

    Removes a telephone-directory entry.

    Parameters

    • number: number

      Telephone number to remove.

    Returns boolean

    True when an entry was removed.