MUDL:is locked

From WikiName
Jump to: navigation, search


Summary

Function Name is_locked
Settable No
Returns Boolean


Parameter Options
Direction (string)
Room, Direction (string)
Item


In the first two cases, this function returns whether the exit in the given direction from the given room is locked. This means that it must first be a passable sort of exit and it must be set up as a door and locked. The second argument is the direction, as one of the strings 'north', 'south', 'east', 'west', 'up', or 'down'. While this function is not settable, the locked status of a door can be set with the flag function.

In the third case, this function returns True if the specified item is a container and the container is currently locked.


Example

TBD