Dictionary¶
Category: Built-In Types
Brief Description¶
Dictionary type.
Methods¶
void | clear ( ) |
Dictionary | duplicate ( bool deep=False ) |
bool | empty ( ) |
bool | erase ( Variant key ) |
Variant | get ( Variant key, Variant default=Null ) |
bool | has ( Variant 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.
Method Descriptions¶
- void clear ( )
Clear the dictionary, removing all key/value pairs.
- Dictionary duplicate ( bool deep=False )
Creates a copy of the dictionary, and returns it.
- bool empty ( )
Return true if the dictionary is empty.
Erase a dictionary key/value pair by key.
Returns the current value for the specified key in the Dictionary
. If the key does not exist, the method returns the value of the optional default argument, or Null if it is omitted.
Return true if the dictionary has a given key.
Return true if the dictionary has all of the keys in the given array.
- int hash ( )
Return a hashed integer value representing the dictionary contents.
- Array keys ( )
Return the list of keys in the Dictionary
.
- int size ( )
Return the size of the dictionary (in pairs).
- Array values ( )
Return the list of values in the Dictionary
.