Help: $building_utils

Showing help on '$building_utils'

building utilities ($building_utils #21)

Verbs useful for building. For a complete description of a given verb, do `help $building_utils:verbname'.

make_exit(spec,source,dest[,don't-really-create]) => a new exit
spec is an exit-spec as described in `help @dig'

set_names(object, spec) - sets name and aliases for an object
parse_names(spec) => list of {name, aliases}
in both of these, spec is of the form
<name>[[,:]<alias>,<alias>,...]
(as described in `help @rename')

recreate(object, newparent) - effectively recycle and recreate object
as a child of newparent
refit_plan(ship) -> missing {master room, built room, master fitting} rows; read-only.
refit_correspondence(ship) -> pairs, unmatched master rooms and unmatched built rooms.
refit(ship) -> new fittings; wizard only, additive and idempotent; carries no nonclonable stock.
Rooms match by area-tree position, ancestor and room names, and exit aliases/destination positions.

:make_exit - make_exit(spec, source, dest[, use-$recycler-pool [, kind]])
:set_names - $building_utils:set_names(object, spec)
:recreate(object,newparent) -- effectively recycle and recreate the specified object as a child of parent. Returns true if successful.
:parse_names - $building_utils:parse_names(spec)
:object_audit_string(object [,prospectus-style])
:do_audit(who, start, end, match)
:do_audit_item(object, match-name-string, prospectus-flag)
:open_sockets - open_sockets(rooms) -> {{room, exit}, ...} for every exit in the set whose dest is $nothing (an open socket / unfinished exit).
:mate - mate(exit_a, exit_b) -> wire two open-socket exits to point at each other's source rooms (bidirectional), updating entrances.
:copy_state - copy_state(original, copy, ?skip={}) - for :cloned callbacks: copy every property value from original to copy (except names in skip), then its in-room position.
:copy_fixture_configuration(source, target) preserves messages and declared configuration before :cloned resets runtime state.

Also from $generic_utils: 1 documented verb. help $generic_utils