dict

Collection

A key/value collection that keeps insertion order and can be read or updated during script execution.

Syntax

dict(mapping_or_pairs=(), /, **items)

Returns

dict

Example

settings = dict(mode="farm", retries=3)
mode = settings.get("mode")   # returns farm
keys = settings.keys()

for key in settings:
    text(str(settings[key]))   # returns None

Methods

17 methods

dict.constructor

Creation Method

Create an empty dictionary, copy a mapping or iterable of pairs, or build entries from keyword arguments.

Syntax

dict()
dict(mapping_or_pairs, /)
dict(key=value, ...)

Parameters

Name	Description
`mapping_or_pairsdict \| Iterable`	Mapping or iterable of two-item pairs to copy. Depends on overload · Positional only Default: `None`
`key=valueAny?`	Keyword entries to add after the source mapping. Optional · Variadic No default

Returns

dict — A new mutable dictionary.

Example

settings = dict(mode="farm", retries=3)
copied = dict(settings)
from_pairs = dict([("mode", "pvp")])

dict.literal

Creation Method

Create a dictionary with string, number, boolean, or object values.

Syntax

{"mode": "farm", "retries": 3}

Parameters

Name	Description
`keyString`	dict key. Required · Positional or named No default
`valueAny?`	Value stored for that key. Required · Positional or named No default

Returns

dict — A new dictionary that preserves the literal entry order.

Example

settings = {
    "mode": "farm",
    "retries": 3,
    "enabled": True
}

dict.comprehension

Creation Method

Build a dictionary from an iterable while preserving insertion order. Multiple for/if clauses are supported.

Syntax

{key: value for target in iterable if condition}

Parameters

Name	Description
`keyAny`	dict key calculated for each accepted item. Required · Positional or named No default
`valueAny?`	Value stored for that key. Required · Positional or named No default
`targetName \| destructuring target`	Loop target for the current item. Starred targets are not supported. Required · Positional or named No default
`iterableIterable`	Source values to loop through. Required · Positional or named No default
`conditionBoolean`	Optional filter checked before storing an entry. Optional · Positional only Default: `True`

Returns

dict — A new mutable dictionary.

Example

pairs = [("mode", "farm"), ("retries", 3)]
settings = {key: value for key, value in pairs}

dict.key_access

Method

Read one value by key. Missing keys return None.

Syntax

dictionary["key"]

Parameters

Name	Description
`dictionarydict`	The source dictionary. Required · Positional or named No default
`keyAny`	Key to look up. Required · Positional or named No default

Returns

Any? — The stored value for that key, or None when the key is absent.

Example

settings = {"mode": "farm", "retries": 3}
mode = settings["mode"]        # returns farm
missing = settings["unknown"]  # returns None

dict.key_assignment

Method

Write or replace one key/value entry with bracket assignment syntax.

Syntax

dictionary[key] = value

Parameters

Name	Description
`dictionarydict`	The mutable dictionary to update. Required · Positional or named No default
`keyAny`	Key to write or replace. Required · Positional only No default
`valueAny?`	Value to store for that key. Required · Positional only No default

Returns

None — No direct return value. The dictionary is updated in place.

Example

settings = {"mode": "farm"}
settings["mode"] = "pvp

dict.length

Method

Count how many key/value pairs are in the dictionary.

Syntax

len(dictionary, /)

Parameters

Name	Description
`dictionarydict`	The dictionary to count. Required · Positional only No default

Returns

Int — Number of entries in the dictionary.

Example

settings = {"mode": "farm", "retries": 3}
count = len(settings)          # returns 2

dict.get_method

Method

Read a value by key and optionally fall back to a default.

Syntax

dictionary.get(key, default=None, /)

Parameters

Name	Description
`keyAny`	Key to look up. Required · Positional only No default
`defaultAny?`	Fallback value returned when the key is missing. Optional · Positional only Default: `None`

Returns

Any? — The stored value for that key, or the provided default.

Example

settings = {"mode": "farm"}
mode = settings.get("mode")           # returns farm
retry = settings.get("retries", 0)    # returns 0

dict.items_method

Method

Get key/value pairs as a list of two-item tuples in insertion order.

Syntax

dictionary.items()

Returns

list — A list of (key, value) tuples.

Example

settings = {"mode": "farm"}
pairs = settings.items()

dict.pop_method

Method

Remove one key and return its value, or return the default when missing.

Syntax

dictionary.pop(key, default=None, /)

Parameters

Name	Description
`keyAny`	Key to remove. Required · Positional only No default
`defaultAny?`	Fallback returned when the key is missing. Optional · Positional only Default: `None`

Returns

Any? — Removed value or fallback default.

Example

settings = {"mode": "farm", "retries": 3}
removed = settings.pop("retries")

dict.copy_method

Method

Copy the dictionary into a new mutable dictionary.

Syntax

dictionary.copy()

Returns

dict — A new dictionary with the same entries.

Example

settings = {"mode": "farm"}
copied = settings.copy()

dict.update_method

Method

Update this dictionary from another mapping, pairs iterable, and keyword entries.

Syntax

dictionary.update(other=(), /, **items)

Parameters

Name	Description
`otherdict \| Iterable`	Mapping or pairs to merge. Optional · Positional only Default: `None`
`itemsAny?`	Keyword entries to write. Optional · Variadic No default

Returns

None — No direct return value. The dictionary is updated in place.

Example

settings = {"mode": "farm"}
settings.update([("retries", 3)], mode="pvp")

dict.setdefault_method

Method

Return an existing value, or store and return the default when the key is missing.

Syntax

dictionary.setdefault(key, default=None, /)

Parameters

Name	Description
`keyAny`	Key to read or create. Required · Positional only No default
`defaultAny?`	Value stored when the key is absent. Optional · Positional only Default: `None`

Returns

Any? — Existing value or inserted default.

Example

settings = dict()
mode = settings.setdefault("mode", "farm")

dict.keys_method

Method

Get the dictionary keys as a list in insertion order.

Syntax

dictionary.keys()

Returns

list — A list of keys.

Example

settings = {"mode": "farm", "retries": 3}
keys = settings.keys()
first_key = keys[0]                 # returns mode

dict.values_method

Method

Get the dictionary values as a list in insertion order.

Syntax

dictionary.values()

Returns

list — A list of values.

Example

settings = {"mode": "farm", "retries": 3}
values = settings.values()
last_value = values[-1]             # returns 3

dict.clear_method

Method

Remove every key/value pair from the dictionary.

Syntax

dictionary.clear()

Returns

None — No direct return value. The dictionary becomes empty.

Example

settings = {"mode": "farm", "retries": 3}
settings.clear()
text(str(len(settings)))   # returns 0

dict.for_loop

Method

Loop through dictionary keys in the same order they were written in the literal.

Syntax

for key in dictionary:

Parameters

Name	Description
`keyAny`	Current key inside the loop. Required · Positional or named No default
`dictionarydict`	The dictionary to iterate. Required · Positional or named No default

Returns

None — No direct return value. The loop runs once per key.

Example

settings = {"mode": "farm", "retries": 3}
for key in settings:
    text(str(settings[key]))   # returns None

dict.truthy_check

Method

Check whether the dictionary has at least one entry. An empty dictionary is treated as false.

Syntax

if dictionary | if not dictionary

Parameters

Name	Description
`dictionarydict`	The dictionary used in the condition. Required · Positional or named No default

Returns

Boolean condition — true when the dictionary is not empty, false when it is empty.

Example

settings = {}
if not settings:
    text("No settings")       # returns None