User

age

Type: property (read only)
Return: int
Description: user's age

away

Type: property (read only)
Return: bool
Description: whether the user is marked as away

browsable

Type: property (read only)
Return: bool
Description: whether the user is sharing any files

country

Type: property (read only)
Return: string
Description: user's country

deleteAvatar

Type: function
Return: bool
Description: delete and reset the user's avatar

deleteFont

Type: function
Return: bool
Description: delete and reset the user's custom font

equals

Type: function
Return: bool
Description: compare two user objects to see if they are the same
Argument 1: User

externalIp

Type: property (read only)
Return: string
Description: user's external ip address (if supported)

friend

Type: property (read/write)
Return: bool
Description: whether the user should appear in the friend list

fontName

Type: property (read only)
Return: string
Description: user's custom font name

fontSize

Type: property (read only)
Return: int
Description: user's custom font size

gender

Type: property (read only)
Return: int
Description: user's gender (0 = unknown, 1 = male, 2 = female)

ignored

Type: property (read/write)
Return: bool
Description: whether a user should be ignored

level

Type: property (read only)
Return: int
Description: user's admin level

localIp

Type: property (read only)
Return: string
Description: user's local ip address (if supported)

name

Type: property (read only)
Return: string
Description: user's name

nameColor

Type: property (read only)
Return: string
Description: user's custom font name color

nudge

Type: function
Return: void
Description: nudge the user

personalMessage

Type: property (read only)
Return: string
Description: user's personal message

pm

Type: function
Return: void
Description: send a private message to the user
Argument 1: string

port

Type: property (read only)
Return: int
Description: user's port (if supported)

region

Type: property (read only)
Return: string
Description: user's region

room

Type: property (read only)
Return: Room
Description: the room object which the user belongs to

scribble

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

sendCustomData

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

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

textColor

Type: property (read only)
Return: string
Description: user's custom font text color

writing

Type: property (read only)
Return: bool
Description: whether the user is marked as currently typing

Last edited Feb 9, 2014 at 2:36 PM by oobenoob, version 3