Room - AresChat/sb0t GitHub Wiki

+Room+

+botName+

Type: Property (read only) Return: string Description: Get the username of the bot

print("bot is called " + Room.botName);

+clearUrl+

Type: Function Return: void Description: Clear the url tag

Room.clearUrl();

+customNames+

Type: Property (read/write) Return: bool Description: Get or set whether or not users can have custom names

if (!Room.customNames)
{
    Room.customNames = true;
    print("custom names are now available");
}

+externalIp+

Type: Property (read only) Return: string Description: Get the room's ip address

print("room ip: " + Room.externalIp);

+hashlink+

Type: Property (read only) Return: string Description: Get the room's hashlink

print("room hashlink: " + Room.hashlink);

+name+

Type: Property (read only) Return: string Description: Get the room's name

print("room name: " + Room.name);

+port+

Type: Property (read only) Return: int Description: Get the room's port

print("room port: " + Room.port);

+setUrl+

Type: Function Return: void Description: Set the url tag

var address = "http://codeplex.com";
var text = "codeplex";
Room.setUrl(address, text);

+startTime+

Type: Property (read only) Return: double Description: Get the room's start time

print("room started at " + new Date(Room.startTime * 1000));

+topic+

Type: Property (read/write) Return: string Description: Get or set the main room topic

Room.topic = "hello world";
print("room topic: " + Room.topic);

+version+

Type: Property (read only) Return: int Description: Get the script model version for this server

print("Object model: " + Room.version);