blob: f4fc6ac53583e9a12b56b19c40ee822be3a427ab [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SYNOPSIS
Zesstra715ec202025-07-09 22:18:31 +02002 object environment(void)
Zesstrab6ac9f62020-01-21 11:11:16 +01003 object environment(object obj)
4 object environment(string obj)
MG Mud User88f12472016-06-24 23:31:02 +02005
Zesstra715ec202025-07-09 22:18:31 +02006DESCRIPTION
7 Returns the surrounding object of obj, which may be given by name.
8 If no argument is given, it returns the surrounding of the current
9 object.
MG Mud User88f12472016-06-24 23:31:02 +020010
Zesstra715ec202025-07-09 22:18:31 +020011 Destructed objects do not have an environment.
MG Mud User88f12472016-06-24 23:31:02 +020012
Zesstra715ec202025-07-09 22:18:31 +020013EXAMPLES
Zesstrab6ac9f62020-01-21 11:11:16 +010014 object room;
15 room = environment(this_player());
MG Mud User88f12472016-06-24 23:31:02 +020016
Zesstra715ec202025-07-09 22:18:31 +020017 This will return the current room you are in.
MG Mud User88f12472016-06-24 23:31:02 +020018
Zesstra715ec202025-07-09 22:18:31 +020019SEE ALSO
Zesstrab6ac9f62020-01-21 11:11:16 +010020 first_inventory(E), next_inventory(E), all_inventory(E),
MG Mud User88f12472016-06-24 23:31:02 +020021 all_environment(E)