is_room

This function determines whether the provided value is a room or not.

This function does not generate a change.

Function

is_room(value)

Arguments

Argument Type Description
value any (required) The value to be tested.

Return value

Returns true if the given value is a room, else it returns false.

Example

This code shows some return values for is_room():

[
    is_room( thing() ),
    is_room( room() ),
];

Return value in JSON format

[
    false,
    true
]