Class: token_list
Name-to-id token list for editor dropdown values.
Source
C++ class token_list
Custom Constructor
token_list
Remarks
The native list keeps a trailing sentinel entry for editor APIs; script code only works with named entries.
Constructors
Constructor
ts
new token_list(): token_list;Create an empty token list.
Returns
token_list
Methods
add()
ts
add(token: string, id: number): void;Add a token/id pair.
Parameters
| Parameter | Type | Description |
|---|---|---|
token | string | Token text. |
id | number | Numeric token id. |
Returns
void
Remarks
Both token text and id must be unique in the list.
clear()
ts
clear(): void;Remove all tokens.
Returns
void
id()
ts
id(token: string): number;Find numeric id for a token.
Parameters
| Parameter | Type | Description |
|---|---|---|
token | string | Token text. |
Returns
number
Token id.
Remarks
The token must exist. Native code verifies the lookup result.
name()
ts
name(id: number): string;Find token text by numeric id.
Parameters
| Parameter | Type | Description |
|---|---|---|
id | number | Token id. |
Returns
string
Token text.
Remarks
The id must exist. Native code verifies the lookup result.
remove()
ts
remove(token: string): void;Remove token by text.
Parameters
| Parameter | Type | Description |
|---|---|---|
token | string | Token text. |
Returns
void
Remarks
Missing tokens are logged and otherwise ignored.