Dictionary

Category: Built-In Types

Brief Description

Dictionary type.

Member Functions

void clear ( )
bool empty ( )
void erase ( var key )
bool has ( var key )
bool has_all ( Array keys )
int hash ( )
Array keys ( )
int size ( )
Array values ( )

Description

Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.

Member Function Description

  • void clear ( )

Clear the dictionary, removing all key/value pairs.

Return true if the dictionary is empty.

  • void erase ( var key )

Erase a dictionary key/value pair by key.

  • bool has ( var key )

Return true if the dictionary has a given key.

Return true if the dictionary has all of the keys in the given array.

Return a hashed integer value representing the dictionary contents.

Return the list of keys in the Dictionary.

Return the size of the dictionary (in pairs).

Return the list of values in the Dictionary.