Skip to content

Dictionary actions

9 actions in the Dictionary category. Each block mirrors how the action appears in the editor's sidebar.

Dictionary Clear

Every Frame
Dictionary Clear Dictionary
not set

Removes every key and value from a dictionary, leaving it empty.

Input Type Default Description
Dictionary Dictionary - The dictionary to empty. Must be bound to a variable or property.

Phases StartEvery FramePhysicsEnd

Dictionary Erase

Every Frame
Dictionary Erase Dictionary
Dictionary not set | Key ''

Removes a key and its value from a dictionary. Does nothing if the key is missing.

Input Type Default Description
Dictionary Dictionary - The dictionary to remove from. Must be bound to a variable or property.
Key String '' The key to remove.

Phases StartEvery FramePhysicsEnd

Dictionary Get

Every Frame
Dictionary Get Dictionary
Dictionary not set | Key '' | Default not set | → Found | → Missing

Reads the value stored under a given key in a dictionary. A missing key returns the default value.

Input Type Default Description
Dictionary Dictionary - The dictionary to read from.
Key String '' The key to look up.
Default Variant - The value returned when the key is not in the dictionary.
Output Type Description
Result Variant Where to store the value found at the key, or the default when missing.
Branch Goes to
Found Where to go when the key is in the dictionary.
Missing Where to go when the key is absent, which is when the default is stored.

Phases StartEvery FramePhysicsEnd

Dictionary Has

Every Frame
Dictionary Has Dictionary
Dictionary not set | Key '' | → True | → False

Answers whether a dictionary holds a given key. It can branch on the answer or hand it to a field that takes a yes or no.

Input Type Default Description
Dictionary Dictionary - The dictionary to search.
Key String '' The key to look for.
Output Type Description
Yes bool Where to store whether the key is in the dictionary.
Branch Goes to
True Where to go when the key is found.
False Where to go when the key is missing.

Phases StartEvery FramePhysics

Dictionary Keys

Every Frame
Dictionary Keys Dictionary
not set

Reads every key of a dictionary into an array, in insertion order.

Input Type Default Description
Dictionary Dictionary - The dictionary to read from.
Output Type Description
Result Array Where to store the array of keys.

Phases StartEvery FramePhysicsEnd

Dictionary Merge

Every Frame
Dictionary Merge Dictionary
Dictionary not set | Other not set | Overwrite true

Copies all pairs from another dictionary into this one. Overwrite decides whether a shared key keeps the old value or takes the new one.

Input Type Default Description
Dictionary Dictionary - The dictionary that receives the pairs. Must be bound to a variable or property.
Other Dictionary - The dictionary to copy pairs from.
Overwrite bool true True to let shared keys take the new value, false to keep the old one.

Phases StartEvery FramePhysicsEnd

Dictionary Set

Every Frame
Dictionary Set Dictionary
Dictionary not set | Key '' | Value 0

Writes a value under a given key in a dictionary. Overwrites the key if it already exists.

Input Type Default Description
Dictionary Dictionary - The dictionary to write into. Must be bound to a variable or property.
Key String '' The key to write the value under.
Value Variant 0 The value stored at the key.

Phases StartEvery FramePhysicsEnd

Dictionary Size

Every Frame
Dictionary Size Dictionary
not set

Counts how many key and value pairs a dictionary holds and stores the number.

Input Type Default Description
Dictionary Dictionary - The dictionary to measure.
Output Type Description
Size int Where to store the number of pairs.

Phases StartEvery FramePhysicsEnd

Dictionary Values

Every Frame
Dictionary Values Dictionary
not set

Reads every value of a dictionary into an array, in insertion order.

Input Type Default Description
Dictionary Dictionary - The dictionary to read from.
Output Type Description
Result Array Where to store the array of values.

Phases StartEvery FramePhysicsEnd