Functions for objects and exits

AllKeysAvailable

AllKeysAvailable (object)

Returns a boolean - true if the player is carrying every key object listed in the locked object’s key/key1, key2, … attributes. Used by the built-in unlock handling when the object’s requireallkeys attribute is true; see KeysAvailable.

AnyKeyAvailable

AnyKeyAvailable (object)

Returns a boolean - true if the player is carrying at least one of the key objects listed in the locked object’s key/key1, key2, … attributes (or if no keys are set at all). Used by the built-in unlock handling when the object’s requireallkeys attribute is false; see KeysAvailable.

Clone

Clone (object object to clone)

hard-coded

Clones the object and returns the created clone. It is generally better to use CloneObject, which will automatically give the clone an alias so it will appear identical to the player (as names must be unique).

See also CloneObjectAndMove.

CloneObject

CloneObject (object)

Returns an object. Helper function for cloning objects. Clones the object using the clone function. If the existing object did not have an alias, the new object gets an alias of the old object’s name - this means that this function returns an object that looks the same to the player as the original object.

Objects inside the target object are also cloned, so if you clone a basket with a sandwich inside it, the clone of the basket will have a clone of the sandwich inside it (and if there is ham in the sandwich, that will be cloned, and so on).

As of 5.7.2, also sets the “prototype” attribute of the clone to point to the original (unless the attribute is already set). This allows you to quickly find all copies of a specific original, or to determine whether an object is the original or a copy. Note that if you make a clone of a clone, the “prototype” attribute will point to the original still.

See also CloneObjectAndMove and CloneObjectAndMoveHere

CloneObjectAndMove

CloneObjectAndMove (object, object new parent)

Returns an object. Helper function for cloning objects. Clones the object using the CloneObject function and also moves it to the specified parent. For more details, see that function.

CloneObjectAndMoveHere

CloneObjectAndMoveHere (object)

Returns an object. Helper function for cloning objects. Clones the object using the CloneObject function and also moves it to current room. For more details, see that function.

CreateBiExits

CreateBiExits (string direction, object from, object to)

Creates a new exit in the given direction, from and to the given rooms. Also creates a second exit in the opposite direction.

DoesInherit

DoesInherit (object object, string type name)

hard-coded

Returns a boolean indicating whether the object inherits the specified type.

if (DoesInherit(o, "male")) {
  msg("'Hi,' he grunts.")
}
else if (DoesInherit(o, "female")) {
  msg("'Hi,' she smiles.")
}
else {
  msg("It says nothing.")
}

Note that the types “editor_player”, “editor_room” and “editor_object” are removed when you publish your game, so it is a bad idea to test for them.

GetExitByLink

GetExitByLink (object from room, object to room)

hard-coded

Returns a string containing the name of the exit joining the specified rooms, if it exists. If it does not exist, null is returned instead.

GetExitByName

GetExitByName (object from room, string direction name)

hard-coded

Returns a string containing the name of the exit going from the specified room whose alias matches the given name - for a compass exit that is its direction, but a named exit is matched on its alias too. If there is no such exit, null is returned instead.

GetObject

GetObject (string object name)

hard-coded

Returns the object of the specified name (or exit, or command, or turn script; but not timer). Returns null if the object doesn’t exist.

See also HasObject

KeysAvailable

KeysAvailable (object)

Returns a boolean indicating whether the player has the key(s) needed to unlock the object. Delegates to AllKeysAvailable if the object’s requireallkeys attribute is true, otherwise to AnyKeyAvailable.

LockExit

LockExit (exit)

Locks the specified exit, simply by setting the locked property to true.

MakeExitInvisible

MakeExitInvisible (object)

Makes exit invisible.

see also MakeExitVisible

MakeExitVisible

MakeExitVisible (object)

Makes exit visible.

see also MakeExitInvisible

MakeObjectInvisible

MakeObjectInvisible (object)

Makes object invisible.

see also MakeObjectVisible

MakeObjectVisible

MakeObjectVisible (object)

Makes object visible.

see also MakeObjectInvisible

MoveObject

MoveObject(object object1, object object2)

Moves object1 to object2.

Example to move the player into a room named lounge:

MoveObject (player, lounge)

This is just the same as setting the parent attribute:

player.parent = lounge

RemoveObject

RemoveObject(object object1)

Removes an object from its parent, by setting its parent attribute to null - the object still exists, it just isn’t contained anywhere, so it won’t appear in room contents, inventory, etc. This is different from destroy, which deletes the object completely.

UnlockExit

UnlockExit (exit)

Unlocks the specified exit, simply by setting the locked property to false.