Help: locations()

Showing help on 'locations()'

Syntax: locations(OBJ object [, OBJ stop [, INT is-parent]]) => LIST

Recursively build a list of an object's location, its location's location, and so forth until finally hitting $nothing. Raises E_INVIND if object is not valid.

Example:

locations(me) => {#20381, #443, #104735}

$string_utils:title_list(locations(me)) => "\"Butterknife Ballet\" Control Room FelElk, the one-person celestial birther \"Butterknife Ballet\", and Uncharted Space: Empty Space"

If stop is in the locations found, it will stop before there and return the list (exclusive of the stop object).

If the third argument is true, stop is assumed to be a PARENT. And if any of your locations are children of that parent, it stops there.