room_caption

Holds the room caption as a string.

Syntax:

room_caption;


Returns: String


Description

This variable permits you to create a "caption" string for your room. If no caption is defined, or you wish to set no caption, use an empty string "".

NOTE: this variable is deprecated and may be removed in future versions of the product.




Example:

if room_caption=""
   {
   room_caption = room_get_name(room);
   }

The above code will check to see if the room has a caption and if it does not it sets the caption to be the same as the name of the room.


Back: Rooms
Next: room_get_name
© Copyright YoYo Games Ltd. 2018 All Rights Reserved