blob: fe964193ce6d78f5ee439c7e0676316dee9ef229 [file] [log] [blame]
Zesstra5481d492021-04-08 20:07:06 +02001SYNOPSIS
Zesstra715ec202025-07-09 22:18:31 +02002 mapping map_indices(mapping m, string func, string|object ob, ...)
3 mapping map_indices(mapping m, closure cl, ...)
Zesstra5481d492021-04-08 20:07:06 +02004
Zesstra715ec202025-07-09 22:18:31 +02005DESCRIPTION
6 ob->func() is called resp. cl applied to every element in the mapping,
7 with the key of the element as first argument, and then the extra args
8 that were given to map_indices (these args must not be protected
9 references like &(i[0])). The data item in the mapping is replaced by
10 the return value of the function. ob can also be a file_name of an
11 object.
Zesstra5481d492021-04-08 20:07:06 +020012
Zesstra715ec202025-07-09 22:18:31 +020013 If <ob> is omitted, or neither a string nor an object, it
14 defaults to this_object().
Zesstra5481d492021-04-08 20:07:06 +020015
Zesstra715ec202025-07-09 22:18:31 +020016 Note that if mapping m has more than one value per key, these
17 are ignored: the resulting mapping always has one value per key.
Zesstra5481d492021-04-08 20:07:06 +020018
Zesstra715ec202025-07-09 22:18:31 +020019 Also note that the behaviour of this function is different from
20 map(<array>).
21
22EXAMPLES
Zesstra5481d492021-04-08 20:07:06 +020023 m = mkmapping(users());
Zesstra715ec202025-07-09 22:18:31 +020024 m = map_indices(m, #'environment);
Zesstra5481d492021-04-08 20:07:06 +020025
Zesstra715ec202025-07-09 22:18:31 +020026HISTORY
27 In LDMud 3.2.6 renamed from map_mapping() and complemented by map().
Zesstra5481d492021-04-08 20:07:06 +020028
Zesstra715ec202025-07-09 22:18:31 +020029SEE ALSO
Zesstra5481d492021-04-08 20:07:06 +020030 map(E), filter(E), filter_indices(E), walk_mapping(E), member(E),
31 m_contains(E)