This project is read-only.

Room

equals

Type: function
Return: bool
Description: compare two rooms
Argument 1: Room

injectHTML

Type: function
Return: void
Description: send HTML to the bottom of the chat screen flow
Argument 1: string

var str = "<div>hello world</div>";
roomobj.injectHTML(str);

injectJS

Type: function
Return: void
Description: send JavaScript to the chat screen
Argument 1: string

var str = "alert('hello world')";
roomobj.injectJS(str);

popup

Type: function
Return: void
Description: send a popup to the desktop
Argument 1: string
Argument 2: string
Argument 3: function (optional)

// signature 1
roomobj.popup("title", "text");

// signature 2
roomobj.popup("title", "text", function (roomobj)
{
    roomobj.sendText("popup clicked");
});

print

Type: function
Return: void
Description: send a local announcement to the chat screen
Argument 1: string

roomobj.print("hello world");

scribble

Type: function
Return: void
Description: send a scribble to a room
Argument 1: ScribbleImage

roomobj.scribble(img);

sendCommand

Type: function
Return: void
Description: send command text to a room
Argument 1: string

sendCustomData

Type: function
Return: void
Description: send custom data to a room
Argument 1: string
Argument 2: string

roomobj.sendCustomData("my ident", "my data");

sendEmote

Type: function
Return: void
Description: send emote text to a room
Argument 1: string

sendPersonalMessage

Type: function
Return: void
Description: send personal message to a room
Argument 1: string

sendText

Type: function
Return: void
Description: send regular text to a room

user

Type: function
Return: User
Description: get a user object

var userobj = roomobj.user("anon");
alert(userobj.name);

users

Type: function
Return: void
Description: perform an action on each user in a room

roomobj.users(function (u)
{
    alert(u.name);
});

hashlink

Type: Property (read only)
Return: string
Description: get the hashlink for a room

name

Type: Property (read only)
Return: string
Description: get a room's name

selected

Type: Property (read only)
Return: bool
Description: returns true if the room is currently visible

server

Type: Property (read only)
Return: string
Description: get a room's server version

topic

Type: Property (read only)
Return: string
Description: get a room's topic

userName

Type: Property (read only)
Return: string
Description: get your user name for this room

userLevel

Type: Property (read only)
Return: int
Description: get your user level for this room

Last edited May 31, 2014 at 6:31 PM by oobenoob, version 4