PhoneBook
constPhoneBook:object
Defined in: server/api.d.ts:1247
Configures telephone-directory entries replicated to connected players.
Type Declaration
Section titled “Type Declaration”addNumber()
Section titled “addNumber()”addNumber(
number,name,textId?,cost?,type?):void
Adds or replaces a replicated telephone-directory entry.
Parameters
Section titled “Parameters”number
Section titled “number”number
Telephone number to register.
string
Display name shown to players.
textId?
Section titled “textId?”number
Optional game localization text identifier.
number
Optional call cost.
number
Optional game-specific entry type.
Returns
Section titled “Returns”void
clear()
Section titled “clear()”clear():
void
Removes all replicated telephone-directory entries.
Returns
Section titled “Returns”void
getNumbers()
Section titled “getNumbers()”getNumbers():
PhoneBookEntry[]
Returns a snapshot of all registered telephone numbers.
Returns
Section titled “Returns”The configured directory entries.
has(
number):boolean
Checks whether a telephone number is registered.
Parameters
Section titled “Parameters”number
Section titled “number”number
Telephone number to look up.
Returns
Section titled “Returns”boolean
True when the number exists.
removeNumber()
Section titled “removeNumber()”removeNumber(
number):boolean
Removes a telephone-directory entry.
Parameters
Section titled “Parameters”number
Section titled “number”number
Telephone number to remove.
Returns
Section titled “Returns”boolean
True when an entry was removed.