Xabbo.Core

Represents a user achievement.

The ID of the achievement.

The current level of the achievement.

The badge code of the achievement.

The current progress of the achievement.

The base progress for the current level of the achievement.

The maximum progress for the current level of the achievement.

The number of reward points that will be given upon leveling up the achievement.

The type of reward points that will be given upon leveling up the achievement.

Whether the final level of this achievement has been reached.

The category of the achievement.

The subcategory of the achievement.

The maximum level of the achievement.

A collection of achievements.

Represents an avatar action.

Represents a type of avatar dance.

Represents a sign held by a user in a room.

Represents the stance of an avatar in a room.

Represents the type of an avatar in a room.

Represents a direction in a room.

Values range from 0-7, with each increment representing a 45-degree turn in the clockwise direction. The first value (North) points towards the negative Y axis. (↗)

Represents the north direction.

Points towards the negative Y axis. (↗)

Represents the north-east direction.

Points towards the positive X, negative Y axis. (→)

Represents the east direction.

Points towards the positive X axis. (↘)

Represents the south-east direction.

Points towards the positive X, positive Y axis. (↓)

Represents the south direction.

Points towards the positive Y axis. (↙)

Represents the south-west direction.

Points towards the negative X, positive Y axis. (←)

Represents the west direction.

Points towards the negative X axis. (↖)

Represents the north-west direction.

Points towards the negative X, negative Y axis. (↑)

Gets the client-specific string representation of the specified ban duration.

If an invalid ban duration is specified.

Converts the figure part type to its short 2-letter string representation.

Gets the client value of the floor or wall item type.

One of the following: : 0 : 1 The specified type is not or .

Gets the lowercase single-character identifier of the item type.

One of the following: : "s" : "i" : "b" : "e" : "r"

Gets the uppercase single-character identifier of the specified gender.

Represents an avatar in a room.

Whether the avatar has been removed from the room.

Whether the avatar is hidden client-side by the .

The type of the avatar.

The ID of the avatar.

The index of the avatar.

Each avatar is assigned a temporary incremental index number upon entering the room.

The name of the avatar.

The motto of the avatar.

The figure string of the avatar.

The X coordinate of the avatar.

The Y coordinate of the avatar.

The XY coordinates of the avatar.

The Z coordinate of the avatar.

The current dance of the avatar.

Whether the avatar is idle or not.

Whether the avatar is typing or not.

The ID of the hand item that the avatar is currently holding.

The current effect of the avatar.

The current update of the avatar.

The previous update of the avatar.

Represents a status update of an avatar in a room.

The index of the avatar that the update is for.

The updated location of the avatar.

The direction the avatar's head is facing.

The direction the avatar's body is facing.

The stance of the avatar.

Whether the user has rights.

The rights level of the user.

Whether the user is trading.

The tile that the avatar is currently moving towards.

Whether the avatar is sitting on the floor.

The height of the sit or lay stance.

The sign currently held by the avatar.

Represents a bot in a room.

The gender of the bot.

The ID of the owner of the bot.

The name of the owner of the bot.

Represents a pet in a room.

The ID of the owner of the pet.

The name of the owner of the pet.

Represents a user in a room.

The gender of the user.

The ID of the user's selected group.

The name of the user's selected group.

The achievement score of the user.

Whether the user is a staff member.

The rights level of the user in the room.

Whether the user has rights in the room.

Represents a hierarchical tree structure of catalog page nodes.

The root node.

The type of the catalog.

Searches the catalog for a matching page node.

The title of the catalog page. The name of the catalog page. The ID of the catalog page. The first matching catalog page node, or null if it was not found.

Searches the catalog for a matching page node.

A function to test each node for a condition. The first matching catalog page node, or null if it was not found.

Represents an offer in the catalog.

The ID of the catalog page.

The price of the offer in credits.

The price of the offer in activity points.

The activity point type is specified by .

The type of activity points used to purchase the offer, if is greater than zero.

Whether the offer can be purchased as a gift.

The list of products included in the offer.

The club level required to purchase the offer.

Whether multiple offers can be purchased.

Whether the offer is a pet.

Represents a page in the catalog.

The ID of the catalog page.

The type of catalog the page is for.

The list of offers on the page.

Represents an item on a catalog page.

Represents a page node in the catalog. Defines basic information about a .

The catalog this page node belongs to.

The parent of this node. May be null if this is the root node.

Whether the page is visible in the catalog.

The ID of the icon shown in the catalog.

The ID of the catalog page.

The string identifier of the catalog page.

The localized title of the catalog page.

The list of child nodes.

Searches this node and its descendants for a matching page node.

A function to test each node for a condition. The first matching catalog page node, or null if it was not found.

Searches this node and its descendants for a matching page node.

The title of the catalog page. The name of the catalog page. The ID of the catalog page. The first matching catalog page node, or null if it was not found.

Enumerates this node and its descendants.

Represents a product in a catalog offer.

Represents the duration of a room ban.

Represents the reason for a disconnection.

Represents an error received when attempting to follow a friend.

The followed user is not a friend.

The friend is not currently in a room.

The friend cannot be followed.

Represents the status of an offer in the marketplace.

The offer is currently open.

The item has been sold.

The item was not sold.

Defines the sort orders available when searching the marketplace.

Sorts results by highest price first.

Sorts results by lowest price first.

Sorts results by highest volume of trades first.

Sorts results by lowest volume of trades first.

Sorts results by most number of offers first.

Sorts results by least number of offers first.

Represents an error received when failing to start a trade.

Trading is currently disabled hotel-wide.

Trading is disabled for the current user.

The target user currently has trading disabled.

Trading is currently disabled in the room.

The user is currently in a trade.

The target user is currently in a trade.

Provides data for the event.

The achievement that was updated.

Provides data for the event.

The achievement that was updated.

Provides data for the event.

The avatar that performed the action. The action that the avatar performed.

Provides data for the event.

The avatar that performed the action. The action that the avatar performed.

The action that the avatar performed.

Provides data for the event.

The avatar. The chat type. The message content. The chat bubble style.

Provides data for the event.

The avatar. The chat type. The message content. The chat bubble style.

Gets the chat type.

Gets the message content.

Gets the chat bubble style.

Gets whether the chat message has been blocked.

Blocks the chat message.

Provides data for the event.

The avatar. The previous dance of the avatar. contains the updated state of the avatar.

Provides data for the event.

The avatar. The previous dance of the avatar. contains the updated state of the avatar.

Gets the previous dance of the avatar.

Provides data for the event.

Gets the avatar's previous figure.

Gets the avatar's previous gender.

Gets the avatar's previous motto.

Gets the avatar's previous achievement score.

Gets whether the avatar's figure was updated.

Gets whether the avatar's gender was updated.

Gets whether the avatar's motto was updated.

Gets whether the avatar's achievement score was updated.

Provides data for the event.

The avatar that was rotated. The previous direction of the avatar. The previous head direction of the avatar. The wired movement that caused the event.

Provides data for the event.

The avatar that was rotated. The previous direction of the avatar. The previous head direction of the avatar. The wired movement that caused the event.

Gets the previous direction of the avatar.

Gets the previous head direction of the avatar.

Gets the wired movement that caused this event.

Provides data for the event.

The avatar. The previous effect of the avatar. contains the updated state of the avatar.

Provides data for the event.

The avatar. The previous effect of the avatar. contains the updated state of the avatar.

Gets the previous effect of the avatar.

Provides data for the , , or event.

The avatar involved in the event.

Provides data for the , , or event.

The avatar involved in the event.

Gets the avatar involved in the event.

Provides data for the event.

The avatar. The previous item that the avatar was holding. contains the updated state of the avatar.

Provides data for the event.

The avatar. The previous item that the avatar was holding. contains the updated state of the avatar.

Gets the previous item that the avatar was holding.

Provides data for the event.

The avatar. Whether the avatar was previously idle. contains the updated state of the avatar.

Provides data for the event.

The avatar. Whether the avatar was previously idle. contains the updated state of the avatar.

Gets whether the avatar was previously idle.

Provides data for the event.

The avatar. The previous name of the avatar. contains the updated state of the avatar.

Provides data for the event.

The avatar. The previous name of the avatar. contains the updated state of the avatar.

Gets the previous name of the avatar.

Provides data for the or event.

The avatars.

Provides data for the or event.

The avatars.

Gets the avatars.

Provides data for the event.

The sliding avatar. The previous location of the avatar. contains the updated state of the avatar.

Provides data for the event.

The sliding avatar. The previous location of the avatar. contains the updated state of the avatar.

Gets the previous locatin of the avatar.

Provides data for the event.

The avatar. Whether the avatar was previously typing. contains the updated state of the avatar.

Provides data for the event.

The avatar. Whether the avatar was previously typing. contains the updated state of the avatar.

Whether the avatar was previously typing.

Provides data for the event.

The avatar that was moved. The previous location of the avatar. The previous direction of the avatar. The previous head direction of the avatar. The wired movement that caused the event.

Provides data for the event.

The avatar that was moved. The previous location of the avatar. The previous direction of the avatar. The previous head direction of the avatar. The wired movement that caused the event.

Gets the previous location of the avatar.

Gets the previous direction of the avatar.

Gets the wired movement that caused this event.

Provides data for the event.

The user's current credit amount. The user's previous credit amount. May be null if this is the first update.

Provides data for the event.

The user's current credit amount. The user's previous credit amount. May be null if this is the first update.

The user's current credit amount.

The user's previous credit amount. May be null if this is the first update.

Provides data for the event.

The dice. The previous value of the dice. The updated value of the dice.

Provides data for the event.

The dice. The previous value of the dice. The updated value of the dice.

Gets the previous value of the dice.

Gets the updated value of the dice.

Provides data for the event.

The floor item. The previous state of the updated floor item's data. contains the updated state of the item.

Provides data for the event.

The floor item. The previous state of the updated floor item's data. contains the updated state of the item.

Gets the previous state of the updated floor item's data.

Provides data for the or event.

The item involved in the event.

Provides data for the or event.

The item involved in the event.

Gets the floor item.

Provides data for the event.

The floor items.

Provides data for the event.

The floor items.

Gets the floor items.

Provides data for the event.

The sliding item. The previous location of the item. The ID of the roller that caused the slide.

Provides data for the event.

The sliding item. The previous location of the item. The ID of the roller that caused the slide.

Gets the previous location of the item.

Gets the ID of the roller that caused the slide.

Provides data for the event.

The previous state of the item. The updated state of the item. contains the updated state of the item.

Provides data for the event.

The previous state of the item. The updated state of the item. contains the updated state of the item.

Gets the previous state of the item.

Provides data for the event.

The floor item that was moved. The previous location of the floor item. The previous direction of the floor item. The wired movement that caused the event.

Provides data for the event.

The floor item that was moved. The previous location of the floor item. The previous direction of the floor item. The wired movement that caused the event.

Gets the previous location of the floor item.

Gets the previous direction of the floor item.

Gets the wired movement that caused this event.

Provides data for the or event.

The friend involved in the event.

Provides data for the or event.

The friend involved in the event.

Provides data for the event.

The friend that sent the message. The message content.

Provides data for the event.

The friend that sent the message. The message content.

The message content.

Provides data for the event.

The ID of the user who sent the friend request. The name of the user who sent the friend request. The figure string of the user who sent the friend request.

Provides data for the event.

The ID of the user who sent the friend request. The name of the user who sent the friend request. The figure string of the user who sent the friend request.

The ID of the user who sent the friend request.

The name of the user who sent the friend request.

The figure string of the user who sent the friend request.

Provides data for the event.

The previous state of the friend. The updated state of the friend.

Provides data for the event.

The previous state of the friend. The updated state of the friend.

The previous state of the friend.

Provides data for events involving a single .

The furni involved in the event.

Provides data for events involving a single .

The furni involved in the event.

Gets the furni involved in the event.

Provides data for the , , or event.

The item involved in the event.

Provides data for the , , or event.

The item involved in the event.

Gets the inventory item involved in the event.

Provides data for the event.

The type of activity point that was updated. The updated amount of the activity point. The relative change of the activity point.

Provides data for the event.

The type of activity point that was updated. The updated amount of the activity point. The relative change of the activity point.

The type of activity point that was updated.

The updated amount of the activity point.

The relative change of the activity point.

Provides data for the event.

The room data.

Provides data for the event.

The room data.

Gets the room data.

Provides data for the event.

The room instance.

Provides data for the event.

The room instance.

Gets the room instance.

Provides data for events involving a single .

The user instance.

Provides data for events involving a single .

The user instance.

Gets the user involved in the event.

Provides data for the event.

The user who accepted or unaccepted. Whether the user accepted.

Provides data for the event.

The user who accepted or unaccepted. Whether the user accepted.

Gets whether the user accepted the trade.

Provides data for the event.

The user that closed the trade. The reason that the trade was closed.

Provides data for the event.

The user that closed the trade. The reason that the trade was closed.

Gets the user that closed the trade.

Available on modern clients.

Gets the reason that the trade was closed.

Available on modern clients.

Provides data for the event.

Whether the user initiated the trade. The user's avatar instance. The trade partner's avatar instance. The user's own offer. The trade partner's offer.

Provides data for the event.

Whether the user initiated the trade. The user's avatar instance. The trade partner's avatar instance. The user's own offer. The trade partner's offer.

Gets whether the current user initiated the trade.

Gets the user's own avatar instance.

Gets the trade partner's avatar instance.

Provides data for the event.

Whether the current user initiated the trade. The user's own avatar instance. The partner's avatar instance.

Provides data for the event.

Whether the current user initiated the trade. The user's own avatar instance. The partner's avatar instance.

Gets whether the current user initiated the trade.

Gets the user's own avatar instance.

Gets the trade partner's avatar instance.

Provides data for the event.

The reason that the trade failed to start. The name of the user that the trade failed to start with.

Provides data for the event.

The reason that the trade failed to start. The name of the user that the trade failed to start with.

Gets reason that the trade failed to start.

Gets name of the user that the trade failed to start with.

Provides data for the event.

The user's own offer. The trade partner's offer.

Provides data for the event.

The user's own offer. The trade partner's offer.

Gets the user's own offer.

Gets the trade partner's offer.

Provides data for the or event.

The wall item.

Provides data for the or event.

The wall item.

Gets the wall item.

Provides data for the event.

The list of wall items.

Provides data for the event.

The list of wall items.

Gets the list of wall items that were loaded.

Provides data for the event.

The previous wall item. The updated wall item. contains the updated state of the item.

Provides data for the event.

The previous wall item. The updated wall item. contains the updated state of the item.

The previous state of the wall item before the update.

Provides data for the event.

The wall item that was moved. The previous location of the wall item. The wired movement that caused the event.

Provides data for the event.

The wall item that was moved. The previous location of the wall item. The wired movement that caused the event.

Gets the previous location of the floor item.

Gets the wired movement that caused this event.

Provides data for the event.

The list of wired movements.

Provides data for the event.

The list of wired movements.

Provides convenient extension methods utilizing Xabbo.Core.

Gets whether xabbo core extensions have been initialized.

Initializes xabbo core extensions with the specified game data provider.

Gets the name of an item, or if it is unavailable, returns its identifier or a generic type/kind specifier.

This method will throw an exception if extensions have not been initialized. This method will throw an exception if extensions have not been initialized. This method will throw an exception if extensions have not been initialized. This method will throw an exception if extensions have not been initialized.

Gets the identifier of this item.

This method may throw an exception if extensions have not been initialized.

Gets the identifier of this item.

Gets the descriptor of this item.

Attempts to get the name of the item from game data if it is available.

The item to retrieve the name of. The name of the item. Whether the item name was successfully retrieved from game data.

Attempts to get the description of the item from game data if it is available.

The item to retrieve the description of. The description of the item. Whether the item description was successfully retrieved from game data.

Gets the name of this item.

Gets the category of this item.

Gets the category name of this item.

Gets the furni line of this item.

Selects floor items.

Selects wall items.

Selects items of the specified type, kind and variant.

Selects items of the same kind as the specified furni info.

Selects items of the same kind as any of the specified furni info.

Selects items with the specified furni identifier.

This method may throw an exception if extensions have not been initialized.

Selects items with any of the specified furni identifiers.

This method may throw an exception if extensions have not been initialized.

Selects items with any of the specified furni identifiers.

Selects items without the specified identifier.

Selects items without any of the specified identifiers.

Selects items of the specified variant.

Selects items of any of the specified variants.

Selects items belonging to the specified category.

Selects items belonging to any of the specified categories.

Selects items with the specified category name.

Selects items with any of the specified category names.

Selects items not belonging to the specified category.

Selects items not belonging to any of the specified categories.

Selects items without the specified category name.

Selects items without any of the specified category names.

Selects items belonging to the specified furni line.

Selects items belonging to any of the specified furni lines.

Selects items not belonging to the specified furni line.

Selects items not belonging to any of the specified furni lines.

Selects items with names matching the specified name.

Selects items with names matching any of the specified names.

Selects items that do not have the specified name.

Selects items that do not have any of the specified names.

Selects items with names containing the specified search text.

Selects items with names not containing the specified search text.

Attempts to get the size of the item.

Attempts to get the area occupied by a floor item.

Gets furni that are in the specified state.

Gets furni that are in any of the specified states.

Gets furni that are not in the specified state.

Gets furni that are not in any of the specified states.

Gets floor items intersecting the specified area. Includes items contained inside, and items partially intersecting the area.

Gets items of the specified kind.

Gets items of the specified kinds.

Gets items owned by the specified user ID.

Gets items owned by the specified user.

Gets wall items placed at the specified location.

Gets tradeable inventory items.

Gets sellable inventory items.

Splits inventory items into groups limited by the specified maximum slot and item counts.

Groups the specified inventory items into fragments to be sent to the client.

The items to group into fragments. The maximum number of items per fragment.

Gets room avatars at the specified X, Y, Z location and/or direction.

Gets room avatars not a the specified X, Y, Z location and/or direction.

Gets floor entities at the specified X, Y location and optionally direction.

Gets floor entities not at the specified X, Y location and optionally direction.

Gets floor entities at the specified X, Y, Z location and optionally direction.

Gets floor entities not at the specified X, Y, Z location and optionally direction.

Gets floor entities contained inside the specified area. Entities partially intersecting the area are not considered to be inside. To include these, use .

Gets floor entities contained inside any of the areas in the specified set.

Gets floor entities contained inside all of the areas in the specified set.

Gets floor entities outside the specified area. Entities partially intersecting the area are not considered to be outside.

Gets floor entities outside the specified areas. Entities partially intersecting any of the areas are not considered to be outside.

Represents an avatar figure.

Gets the parts contained in the figure.

Gets or sets the gender of the figure.

Gets or sets the figure part of the specified type.

If the specified key differs from the part type when setting the part.

Gets whether the figure has a part of the specified type.

Adds the specified part to the figure.

Adds the specified part type and ID to the figure.

Adds the specified part type, ID, and colors to the figure.

Attempts to get the part of the specified type in the figure.

Removes the specified part type from the figure.

The part type to remove. Whether the part was removed.

Composes the figure to a figure string.

Parses the specified figure string into a .

Attempts to parse the specified figure string into a .

Attempts to get the gender from the specified figure.

This works by detecting certain parts in the figure that belong to a specific gender.

Represents a part type in a figure.

The current location of the friend.

Only available on Shockwave.

The last access time of the friend.

Only available on Shockwave.

Represents a friend in the user's friend list.

The ID of the friend.

The name of the friend.

The gender of the friend.

Whether the friend is online.

Whether the friend can currently be followed.

The figure string of the friend.

The category in the friend list that the friend belongs to.

The motto of the friend.

Whether the friend is accepting offline messages.

Whether the friend is a club member.

Gets the relation of the friend.

Represents a special relationship type in the friend list.

No special relation.

Displays a heart icon next to the friend's name.

Displays a smiley face icon next to the friend's name.

Displays a skull icon next to the friend's name.

Defines a dictionary of external texts.

Attempts to get a poster name by its variant from the external texts.

Attempts to get a poster description by its variant from the external texts.

Attempts to get a badge name by its code from the external texts.

Gets a badge name by its code from the external texts. Returns null if it is not found.

Attempts to get a badge description by its code from the external texts.

Gets a badge description by its code from the external texts. Returns null if it is not found.

Attempts to get an effect name by its ID from the external texts.

Gets an effect name by its ID from the external texts. Returns null if it is not found.

Attempts to get an effect description by its ID from the external texts.

Gets an effect description by its ID from the external texts. Returns null if it is not found.

Attempts to get a hand item name by its ID from the external texts.

Gets a hand item name by its ID from the external texts. Returns null if it is not found.

Gets all hand item IDs matching the specified name from the external texts.

Defines a dictionary of external variables.

Defines a map of color ID to .

The ID of the palette. The figure part colors.

Defines a map of color ID to .

The ID of the palette. The figure part colors.

The ID of the palette.

The figure part colors.

Converts origins figure strings into their modern representation.

Creates a new figure converter with the specified origins and modern figure data.

The modern figure data. The origins figure data.

Converts the specified origins figure string to its modern representation.

Defines a map of and .

Loads figure data in modern XML format from the specified stream.

Loads figure data in modern XML format from the specified file path.

Loads figure data in origins JSON format from the specified file path.

Defines a map of ID to .

Defines a map of to .

Gets the palette for the specified .

Attempts to derive the specified Figure's gender using information from the figure data.

Defines information about a figure part.

The type of the figure part. The ID of the figure part. Whether the part is colorable.

Defines information about a figure part.

The type of the figure part. The ID of the figure part. Whether the part is colorable.

The type of the figure part.

The ID of the figure part.

Whether the part is colorable.

Defines a figure part color.

The ID of the color. The index of the color. The hexadecimal value of the color. Whether the color is selectable in client. Whether the color requires a club subscription.

Defines a figure part color.

The ID of the color. The index of the color. The hexadecimal value of the color. Whether the color is selectable in client. Whether the color requires a club subscription.

The ID of the color.

The index of the color.

The hexadecimal value of the color.

Whether the color is selectable in client.

Whether the color requires a club subscription.

Defines a set of .

The ID of the part set. The gender of the part set. The parts in this part set. The club level required to wear this part set. Whether the part set is colorable. Whether the part set is selectable in client. Whether the part set has an associated clothing furniture.

Defines a set of .

The ID of the part set.

The gender of the part set.

The parts in this part set.

The club level required to wear this part set.

Whether the part set is colorable.

Whether the part set is selectable in client.

Whether the part set has an associated clothing furniture.

Defines a collection of figure part sets of the same .

Defines a map of floor and wall .

Gets the information of all floor items.

Gets the information of all wall items.

Gets the total number of contained in the furni data.

Gets the information of the furni with the specified identifier.

Merges the base furni data with furni names and descriptions from the provided external texts.

Gets whether furni info with the specified type and kind exists or not.

Gets whether furni info for the specified item exists or not.

Gets whether furni info with the specified identifier exists or not.

Gets whether floor furni info with the specified kind exists or not.

Gets whether wall furni info with the specified kind exists or not.

Gets the information of the furni with the specified type and kind.

Gets the information of the furni with the specified identifier.

Gets the information of the specified item.

Gets the information of the furni with the specified type and kind.

Gets the information of the furni with the specified identifier.

Attempts to get the information of the specified item.

Gets the information of the floor item with the specified kind.

Gets the information of the wall item with the specified kind.

Finds information of all furni containing the specified text in its name.

Finds information of all floor furni containing the specified text in its name.

Finds information of all wall furni containing the specified text in its name.

Finds the first information of a furni containing the specified text in its name, or null if no matches were found.

Finds the first information of a floor furni containing the specified text in its name, or null if no matches were found.

Finds the first information of a wall furni containing the specified text in its name, or null if no matches were found.

Determines whether an item specifies a variant (not state) in its data.

Determines whether the item specifies a variant (not state) in its data.

Gets the item's variant, or null if the specified item does not have a variant.

Attempts to get the variant of the specified item, if the item has a variant.

Gets the of the specified item.

Gets the of the specified inventory item.

Groups items by maximum slots/items in order to offer in a trade.

Attempts to extract the variant string from the item.

The returned string is not guaranteed to be the item variant, which may be unrelated extra data contained within the item. The caller should first check whether returns true to determine whether this method will return the item's variant string.

Gets whether the item may have a variant (not state) in its item data.

You should call or if furni data is available.

Defines information about a furniture.

The furniture type. The furniture kind. The furniture's unique string identifier. The revision number. The default direction when placed in a room. The size of the furniture. The name of the furniture. The description of the furniture. is the numeric identifier of a furniture. This number can be different across hotels. It is only unique for each item type - a floor and a wall item may have the same kind. is a unique string identifier, also known as its class name. This identifier is unique across both furniture types, and is the same across hotels.

Defines information about a furniture.

The furniture type.

The furniture kind.

The furniture's unique string identifier.

The revision number.

The default direction when placed in a room.

The size of the furniture.

The name of the furniture.

The description of the furniture.

Returns true if , and are all false.

Manages the game data for a specified hotel.

Loads the specified game data types. If no types are specified, then all types are loaded.

The hotel to load game data for. The game data types to load. The cancellation token. If game data is currently being loaded.

Waits for the game data to load.

Represents a type of game data.

The default implementation.

Loads the game data hashes for the specified hotel.

Saves the updated game data hashes to the cache.

Downloads game data for the specified hotel, game data type and hash, then returns the updated hash and the file path to the downloaded data.

Represents a service that manages game data for a hotel.

Occurs when game data begins loading.

Occurs when game data is successfully loaded.

Occurs when game data fails to load.

Loads game data for the specified hotel.

Waits for game data to load.

Gets the figure data, if it is available.

Gets the furni data, if it is available.

Gets the product data, if it is available.

Gets the external texts, if they are available.

Gets the external variables, if they are available.

Provides URL resource locations for game data.

Gets the game data hashes URL for the specified hotel. If a hashes endpoint does not exist for the hotel, null will be returned.

Gets the URL for the specified hotel, game data type and hash.

Defines a map of product code to .

Defines a product information.

The product code. The product name. The product description.

Defines a product information.

The product code. The product name. The product description.

The product code.

The product name.

The product description.

Manages the user's friend list.

Gets whether the user's friend list has been initialized.

Gets the user's friends.

Gets whether a user with the specified user ID is in the current user's friend list.

The ID of the user to check.

Gets whether a user with the specified name is in the current user's friend list.

The name of the user to check. Case-insensitive.

Gets the friend with the specified ID, or returns null if the friend does not exist.

The ID of the friend to get.

Gets the friend with the specified name, or returns null if the friend does not exist. The name is case-insensitive.

The name of the friend to get. Case-insensitive.

Occurs when the user's friends are loaded.

Occurs then the game has disconnected and the friend list is cleared.

Occurs when a friend is added.

Occurs when a friend is removed.

Occurs when a friend is updated.

Occurs when a friend request is received.

Occurs when a message is received from a friend.

Sends a private message to a user with the specified ID.

Sends a private message to the specified friend.

Called when it is probably safe to initialize the state manager.

Represents an inventory of items.

Gets the number of items in the inventory.

Gets whether the inventory has been invalidated by the server.

Attempts to get the item with the specified ID.

The ID of the item to retrieve. The item with the specified ID, or null if it does not exist.

Attempts to get the item with the specified ID.

The ID of the item to retrieve. When this method returns, contains the item with the specified ID, or null if it does not exist. true if the item was retrieved successfully, otherwise false.

Manages the user's inventory.

Returns the user's inventory immediately if it is available and has not been invalidated, otherwise attempts to retrieve it from the server.

The user must be in a room to retrieve the inventory from the server. If the user is not in a room and a request to load the inventory is made, this method will time out.

Occurs when the user's inventory is invalidated and needs to be reloaded.

Occurs when the user's inventory is loaded.

Occurs when the inventory is cleared due to being reloaded or disconnected.

Occurs when an item is added to the user's inventory.

Occurs when an item in the user's inventory is updated.

Occurs when an item removed from the user's inventory.

Manages the current user's information.

Gets the user's current information.

Gets the user's current achievements.

Gets the user's current achievement score.

Gets the user's current credits.

Gets the user's current activity points.

Gets the user's current amount of diamonds.

Gets the user's current amount of duckets.

Occurs when the user's data is first loaded.

Occurs when the user's data is updated.

Occurs when the user's achievements are loaded.

Occurs when the an achievement of the user is updated.

Occurs when the user's credits are updated.

Occurs when the user's activity points are loaded.

Occurs when the user's activity points are updated.

Waits for the user data to load, or returns the user's data immediately if it has already been loaded.

Gets the ID of this room.

Gets the room data. The client should request room data before entering a room, however this may be null during room teleport transitions before the game client loads

Gets the model of this room.

Gets the floor pattern of the room.

Gets the wallpaper pattern of the room.

Gets the landscape pattern of the room.

Gets the location of the entry tile.

Gets the direction of the entry tile.

Gets the floor plan of the room.

Gets the heightmap of the room.

Gets if the walls are hidden.

Gets the wall thickness.

Gets the floor thickness.

Gets the furni in this room.

Gets the floor items in this room.

Gets the wall items in this room.

Gets if a floor item with the specified ID exists in this room.

Gets if a wall item with the specified ID exists in this room.

Gets the furni of the specified type with the specified ID if it exists.

Gets the floor item with the specified ID if it exists.

Gets the wall item with the specified ID if it exists.

Gets the avatars in this room.

Gets the users in this room.

Gets the pets in this room.

Gets the bots in this room.

Gets the avatar with the specified index if it exists.

Gets the avatar with the specified name if it exists.

Gets the avatar with the specified ID if it exists.

Finds locations within the specified area where a furniture of the specified size can likely be placed successfully.

The area to place furniture inside. The size of the furniture to place. Whether to allow placement on the room entry tile. Locations where a furni of the specified size can likely be placed successfully.

Attempts to find a location within the specified area where a furniture of the specified size can likely be placed successfully.

The area to place furniture inside. The size of the furniture to place. Whether to allow placement on the room entry tile. A point where a furni of the specified size can likely be placed successfully.

Attempts to find a location where a furniture of the specified size can likely be placed successfully.

The size of the furniture to place. Whether to allow placement on the room entry tile. A point where a furni of the specified size can likely be placed successfully.

Gets whether the floor item with the specified ID exists in the room or not.

Gets whether the wall item with the specified ID exists in the room or not.

Attempts to get the furni of the specified type with the specified ID and returns true if successful.

Attempts to get the floor item with the specified ID and returns true if successful.

Attempts to get the wall item with the specified ID and returns true if successful.

Gets the furni of the specified type with the specified ID, or null if it does not exist.

Gets the floor item with the specified ID or null if it does not exist.

Gets the wall item with the specified ID or null if it does not exist.

Manages information about the current room, the user's permissions in the room, its furni, avatars and chat.

Gets whether the user is currently ringing the doorbell to a room.

Gets whether the user is currently in a queue to enter a room.

Gets the user's current position in the queue.

Gets whether the user is currently spectating a room.

Gets whether a room is currently being loaded.

Gets whether the user is currently in a room.

Gets the instance of the room that the user is currently in. Returns null if the user is not in a room.

Gets the user's rights level in the current room.

Gets whether the user has rights in the current room.

Gets whether the user is the owner of the current room.

Gets whether the user has permission to mute in the current room.

Gets whether the user has permission to kick in the current room.

Gets whether the user has permission to ban in the current room.

Gets whether the user has permission to trade in the current room.

Retrieves the room data from the cache if it is available.

Ensures the user is in a room. If so, this method will return true and will contain the current room instance.

Occurs when the user enters the queue to a room.

Occurs when the user's position in the queue is updated.

Occurs when the user enters a room and begins loading the room state.

Occurs after the user has entered the room and the room state is fully loaded.

Occurs when the room data is updated.

Occurs when the user leaves a room.

Occurs when the user is kicked from the room. The user still remains in the room at this point until their avatar leaves through the door.

Occurs when the user's rights to the room are updated.

Occurs when the floor items are loaded. This may happen multiple times depending on how many items are in the room.

Occurs when a floor item is added to the room.

Occurs when a floor item is updated.

Occurs when a floor item's data is updated.

Occurs when a floor item is moved by wired.

Occurs when a dice value is updated.

Occurs when a floor item slides due to a roller or wired update.

Occurs when users or furni are moved by wired.

Occurs when a floor item is removed from the room.

Occurs when the wall items are loaded. This may happen multiple times depending on how many items are in the room.

Occurs when a wall item is added to the room.

Occurs when a wall item is udpated.

Occurs when a wall item is moved by wired.

Occurs when a wall item is removed from the room.

Occurs when a furni's visibility is toggled using or .

Occurs when an avatar has been added to the room.

Occurs when avatars have been added to the room.

Occurs when an avatar in the room is updated.

Occurs when avatars in the room are updated.

Occurs when an avatar slides along a roller.

Occurs when an avatar is moved by wired.

Occurs when an avatar's direction is changed by wired.

Occurs when an avatar's figure, gender, motto or achievement score changes.

Occurs when an avatar's name changes.

Occurs when an avatar's idle status updates.

Occurs when an avatar's dance updates.

Occurs when an avatar's hand item updates.

Occurs when an avatar's effect updates.

Occurs when an avatar performs an action.

Occurs when an avatar's typing status updates.

Occurs when an avatar is removed from the room.

Occurs when an avatar in the room talks.

Manages the user's trading state.

Gets whether the user is currently trading.

Gets whether the user initiated the current trade.

Gets whether the trade has completed.

Gets the user's own room instance.

Gets the trading parter's room user instance.

Gets the user's own trade offer.

Gets the trading partner's offer.

Gets whether the user has accepted the current trade.

Gets whether the trading partner has accepted the current trade.

Gets whether the trade is awaiting confirmation of both users.

Used on modern clients.

Occurs when a trade is opened.

Occurs when a trade fails to open.

Available on modern clients.

Occurs when a trade is updated.

Occurs when a trade is accepted by one of the users.

Occurs when a trade is awaiting confirmation.

Available on modern clients.

Occurs when a trade is closed.

Occurs when a trade completes successfully.

Represents the type of a group member search.

Represents the current group membership status of a user.

Represents a type of group member.

Represents the membership type of a group.

Defines extended information about a group.

Defines basic information about a group.

Represents a member of a group.

Represents a list of group members.

Pattern:
^[a-zA-Z0-9_\\-=?!@:.,]{3,15}$
Explanation:


            ○ Match if at the beginning of the string.

            ○ Match a character in the set [!,-.0-:=?-Z_a-z] atomically at least 3 and at most 15 times.

            ○ Match if at the end of the string or if before an ending newline.

Gets a vector that can be used to face the specified direction regardless of the position of the user in the room.

The direction to face.

Gets a vector that points in the specified direction by one tile space.

Represents a type of activity point.

Represents a mapping of to their current amount.

Represents a fragment of inventory items received when loading the inventory.

Gets the total number of fragments.

Gets the index of this fragment.

Gets the floor items in the inventory.

Gets the wall items in the inventory.

Represents an inventory item.

Gets the ID of the inventory item.

Gets the furni category of the inventory item.

Gets the item data of the inventory item.

Gets if the inventory item is recyclable.

Gets if the inventory item is groupable.

Gets if the inventory item is tradeable.

Gets if the inventory item is sellable in the marketplace.

Gets the seconds to expiration of the inventory item.

Gets if the rent period of the inventory item has started.

Gets the room ID that the inventory item is in.

Gets the extra state of the inventory item which is used for consumable state, linked teleporter ID, etc.

Gets the size of the item.

Used on Origins.

Represents a crackable furni state.

The number of hits the crackable furni has taken.

The target hit count of the crackable furni.

Represents an empty item data.

Associates a high score value with a list of users.

The value of the high score.

The list of users with this score.

Represents a list of high scores.

Represents an array of integers.

Represents extra data attached to an item.

Gets the type of the item data.

Gets the flags of the item data.

Whether the item data has limited edition rare (LTD) information.

Gets the unique number in the limited edition rare series.

Gets the total number of limited edition rares in the series.

Gets the legacy string value of the item data.

Gets the state of the item data from the legacy string if it is of an integer format, otherwise returns -1.

Represents legacy item data.

Represents a map of string keys and values.

Represents an array of strings.

Represents a type of .

Represents the result of a vote.

Represents the color state of a color tile.

Constructs a new empty floor item.

Constructs a new copy of the specified floor item.

Represents a furniture category.

Represents a furniture usage policy.

The furni cannot be used.

Users with rights can use the furni.

Anyone can use the furni.

Represents a floor furniture.

Gets the X coordinate of the floor item.

Gets the Y coordinate of the floor item.

Gets the XY coordinates of the floor item.

Gets the Z coordinate of the floor item.

The height of the floor item.

The extra field of the floor item. This may be the consumed state (of perishable items like cabbages), or if this is a teleporter, the linked teleporter ID.

The data of the floor item.

The floor item's colors.

Only available on Shockwave.

The floor item's runtime data.

Only available on Shockwave.

Represents a room furniture.

The owner of the furni's ID.

The owner of the furni's name.

Gets the state of the furni from its data if the data string is an integer, otherwise returns -1.

The number of seconds until the furni expires.

The usage policy of the furni.

Gets whether the furni is hidden client-side by the .

Represents an item.

The type of the item.

The kind of the item.

The identifier of the item.

The item's ID.

Represents an item type, kind, identifier, and variant.

Enables items to be grouped together by using the descriptor as a key. Identifier is included for compatibility with Origins. Variant ensures different posters are separated from each other.

Represents an item type, kind, identifier, and variant.

Enables items to be grouped together by using the descriptor as a key. Identifier is included for compatibility with Origins. Variant ensures different posters are separated from each other.

Represents the type of an item.

Represents a wall furniture.

Gets the location of the wall item.

Gets the wall X coordinate of the wall item.

Gets the wall Y coordinate of the wall item.

Gets the X location of the wall item.

Gets the Y location of the wall item.

Gets the orientation of the wall item.

Gets the data of the wall item.

Represents an item type, kind, identifier, and variant, as well as whether the item is tradable and groupable.

Similar to , but intended for inventory item stacks. Enables items to be grouped into inventory stacks. Identifier is included for compatibility with origins. Variant ensures different posters are separated from each other.

Represents an item type, kind, identifier, and variant, as well as whether the item is tradable and groupable.

Represents a sticky note.

Represents a sticky color.

Defines the standard sticky note colors.

Constructs a new empty wall item.

Constructs a new copy of the specified wall item.

Represents the marketplace statistics of an item.

The average sale price in the last 7 days.

The number of offers for this item kind that are currently open.

The trading history data.

Represents an offer for an item in the marketplace.

Gets the ID of the marketplace offer.

Gets the current status of the marketplace offer.

Gets the item data of the marketplace offer.

Gets the price of the marketplace offer.

Gets the remaining time of the offer in minutes.

Gets the current average price of the item.

Gets the number of open offers for the item.

This is not available when the offers are loaded from the user's own marketplace listings.

Represents a single data point containing the daily trading history of an item.

Gets the negative offset in days from the day the information was requested.

Gets the average sale price of the day.

Gets the total trade volume of the day.

Contains the user's own marketplace listings.

Gets the amount of credits waiting to be claimed.

Received when an achievement is updated. Supported clients: Identifiers:

Received when achievements are loaded. Response for . Supported clients: Identifiers:

Received when activity points are loaded. Supported clients: Identifiers:

Received when the user's activity points are updated. Supported clients: Identifiers:

Received when an avatar performs an action. Supported clients: Identifiers: Flash:

The avatar's index. The action that the avatar peformed.

Received when an avatar performs an action. Supported clients: Identifiers: Flash:

The avatar's index. The action that the avatar peformed.

The avatar's index.

The action that the avatar peformed.

Received when an avatar in the room sends a chat message. Supported clients: Identifiers: Flash: , , Shockwave: , ,

Received when an avatar in the room sends a talk message. Supported clients: Identifiers: Flash: Shockwave:

Received when an avatar in the room sends a shout message. Supported clients: Identifiers: Flash: Shockwave:

Received when an avatar in the room sends a whisper message. Supported clients: Identifiers: Flash: Shockwave:

Received when an avatar starts or stops dancing. Supported clients: Identifiers: Flash:

The avatar's index. The avatar's updated dance.

Received when an avatar starts or stops dancing. Supported clients: Identifiers: Flash:

The avatar's index. The avatar's updated dance.

The avatar's index.

The avatar's updated dance.

Received when an avatar's effect is updated. Supported clients: Identifiers: Flash:

The index of the avatar. The avatar's updated effect ID. The effect delay.

Received when an avatar's effect is updated. Supported clients: Identifiers: Flash:

The index of the avatar. The avatar's updated effect ID. The effect delay.

The index of the avatar.

The avatar's updated effect ID.

The effect delay.

Received when an avatar's hand item updates. Supported clients: Identifiers: Flash:

The index of the avatar. The avatar's updated hand item ID.

Received when an avatar's hand item updates. Supported clients: Identifiers: Flash:

The index of the avatar. The avatar's updated hand item ID.

The index of the avatar.

The avatar's updated hand item ID.

Received when an avatar starts or stops idling. Supported clients: Identifiers: Flash:

The index of the avatar. Whether the avatar is idle.

Received when an avatar starts or stops idling. Supported clients: Identifiers: Flash:

The index of the avatar. Whether the avatar is idle.

The index of the avatar.

Whether the avatar is idle.

Received when an avatar is removed from the room. Supported clients: Identifiers: Flash: Shockwave:

The index of the avatar that was removed.

Received when an avatar is removed from the room. Supported clients: Identifiers: Flash: Shockwave:

The index of the avatar that was removed.

Received when avatars are added to the room. Supported clients: Identifiers: Flash: Shockwave:

Received when an avatar in the room starts or stops typing. Supported clients: Identifiers: Flash:

The index of the avatar. Whether the avatar is typing.

Received when an avatar in the room starts or stops typing. Supported clients: Identifiers: Flash:

The index of the avatar. Whether the avatar is typing.

The index of the avatar.

Whether the avatar is typing.

Represents a list of avatar status updates. Received when avatars' statuses are updated in the room. Supported clients: Identifiers: Flash: Shockwave:

Received after requesting the user's list of badges. A sequence of fragments are received in response to . Supported clients: Identifiers: Flash:

The list of badges in the fragment. The sequence index of the fragment. The total number of fragments in the sequence.

Received after requesting the user's list of badges. A sequence of fragments are received in response to . Supported clients: Identifiers: Flash:

The list of badges in the fragment. The sequence index of the fragment. The total number of fragments in the sequence.

The list of badges in the fragment.

The sequence index of the fragment.

The total number of fragments in the sequence.

Received after requesting the list of banned users from a room. Response for . Supported clients: Identifiers: Flash:

The ID of the room. The list of banned users.

Received after requesting the list of banned users from a room. Response for . Supported clients: Identifiers: Flash:

The ID of the room. The list of banned users.

The ID of the room.

The list of banned users.

Received when a console message is received from a friend. Supported clients: Identifiers: Flash: Shockwave:

Received when multiple console messages are received from friends. Supported clients: Identifiers: Shockwave:

Received when the user's credit balance changes or is explicitly requested. Response for . Supported clients: Identifiers: Flash: Shockwave:

Received when the value of a dice is updated. Supported clients: Identifiers: Flash: Shockwave:

The ID of the dice. The updated dice value.

Received when the value of a dice is updated. Supported clients: Identifiers: Flash: Shockwave:

The ID of the dice. The updated dice value.

The ID of the dice.

The updated dice value.

May be received before the server closes the connection to specify a reason for the disconnection. Supported clients: Identifiers: Flash:

Receives when a user rings the doorbell. Supported clients: Identifiers: Flash: Shockwave:

The name of the user who is ringing the doorbell.

Receives when a user rings the doorbell. Supported clients: Identifiers: Flash: Shockwave:

The name of the user who is ringing the doorbell.

Received when the user's own figure is updated. Supported clients: Identifiers: Flash:

The user's updated figure string. The user's updated gender.

Received when the user's own figure is updated. Supported clients: Identifiers: Flash:

The user's updated figure string. The user's updated gender.

The user's updated figure string.

The user's updated gender.

Received when a floor item is added to the room. Supported clients: Identifiers: Flash: Shockwave:

The floor item that was added.

Received when a floor item is added to the room. Supported clients: Identifiers: Flash: Shockwave:

The floor item that was added.

Received when a floor item's data is updated. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item that was updated. The updated item data.

Received when a floor item's data is updated. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item that was updated. The updated item data.

The ID of the floor item that was updated.

The updated item data.

Received when a floor item is removed from the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item that was removed. The instance of the floor item that was removed. Only available on Whether the item expired or not. Applies to clients. The ID of the user who picked up the item. Applies to clients. The delay in milliseconds after which the item will be removed by the client. Applies to clients.

Received when a floor item is removed from the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item that was removed.

The instance of the floor item that was removed. Only available on

Whether the item expired or not. Applies to clients.

The ID of the user who picked up the item. Applies to clients.

The delay in milliseconds after which the item will be removed by the client. Applies to clients.

Received when the item data of multiple floor items are updated. Supported clients: Identifiers: Flash:

The list of floor item data updated.

Received when the item data of multiple floor items are updated. Supported clients: Identifiers: Flash:

The list of floor item data updated.

Represents a list of floor items. Received when floor items in the room are loaded. Supported clients: Identifiers: Flash: Shockwave:

Received when a floor item is updated in the room. Supported clients: Identifiers: Flash: Shockwave:

The updated floor item.

Received when a floor item is updated in the room. Supported clients: Identifiers: Flash: Shockwave:

The updated floor item.

Received when a new friend is added to the user's friend list. Supported clients: Identifiers: Shockwave:

The friend that was added.

Received when a new friend is added to the user's friend list. Supported clients: Identifiers: Shockwave:

The friend that was added.

Represents a friend list fragment. Received after requesting the user's list of friends. Supported clients: Identifiers: Flash: Shockwave:

Received when a friend request is received. Supported clients: . Identifiers: Flash: Shockwave:

The ID of the user who sent the request. The name of the user who sent the request. The figure of the user who sent the request.

Received when a friend request is received. Supported clients: . Identifiers: Flash: Shockwave:

The ID of the user who sent the request. The name of the user who sent the request. The figure of the user who sent the request.

The ID of the user who sent the request.

The name of the user who sent the request.

The figure of the user who sent the request.

Represents a list of user IDs to be removed from the friend's list. Received when friends are removed from the user's friend list. Supported clients: Identifiers: Shockwave:

Received when friends are added, updated, or removed. Supported clients: Identifiers: Flash: Shockwave:

On Origins, this message will only contain friend updates. For friends that are added or removed, see or .

The friend list categories.

Used on modern clients.

The list of friend updates.

Shockwave only supports updates with type .

Received after requesting a group's information. Response for . Supported clients: Identifiers: Flash:

The group's information.

Received after requesting a group's information. Response for . Supported clients: Identifiers: Flash:

The group's information.

Received after searching the list of a group's members. Response for . Supported clients: Identifiers: Flash:

The group members.

Received after searching the list of a group's members. Response for . Supported clients: Identifiers: Flash:

The group members.

Received when the user's inventory is invalidated and should be reloaded. Supported clients: Identifiers: Flash:

Received when an item is added or updated in the user's inventory. Supported clients: Identifiers: Flash:

The items that were added or updated.

Received when an item is added or updated in the user's inventory. Supported clients: Identifiers: Flash:

The items that were added or updated.

Received when an item is removed from the user's inventory. Supported clients: Identifiers: Flash: Shockwave:

The ID of the item that was removed.

Received when an item is removed from the user's inventory. Supported clients: Identifiers: Flash: Shockwave:

The ID of the item that was removed.

Received after requesting the data of a wall item. Response for . Supported clients: Identifiers: Flash: Shockwave:

Received after requesting the marketplace statistics of an item. Response for . Supported clients: Identifiers: Flash:

The marketplace item statistics.

Received after requesting the marketplace statistics of an item. Response for . Supported clients: Identifiers: Flash:

The marketplace item statistics.

Received after searching the marketplace for offers. Response for . Supported clients: Identifiers: Flash:

The list of marketplace offers.

Received after searching the marketplace for offers. Response for . Supported clients: Identifiers: Flash:

The list of marketplace offers.

Received when initializing the messenger. Supported clients: Identifiers: Flash: Shockwave:

Sent by the server to display a notification dialog in client. Supported clients: Identifiers: Flash:

The type of the notification dialog.

Sent by the server to display a notification dialog in client. Supported clients: Identifiers: Flash:

The type of the notification dialog.

Received after requesting the user's own marketplace offers. Response for . Supported clients: Identifiers: Flash:

Received after requesting a pet's information. Response for . Supported clients: Identifiers: Flash:

The requested pet's information.

Received after requesting a pet's information. Response for . Supported clients: Identifiers: Flash:

The requested pet's information.

Received periodically to check if the connection is alive. Supported clients: Identifiers: Flash: Shockwave:

Received after requesting a user's profile. Response for or . Supported clients: Identifiers: Flash:

The requested user's profile.

Received after requesting a user's profile. Response for or . Supported clients: Identifiers: Flash:

The requested user's profile.

Received after requesting the room rights list. Response for . Supported clients: Identifiers: Flash:

The ID of the room. The list of users with rights.

Received after requesting the room rights list. Response for . Supported clients: Identifiers: Flash:

The ID of the room. The list of users with rights.

The ID of the room.

The list of users with rights.

Received after requesting room data for a specified room. Response for . Supported clients: Identifiers: Flash: Shockwave:

Received after requesting the settings of a room. Response for . Supported clients: Identifiers: Flash:

The room settings.

Received after requesting the settings of a room. Response for . Supported clients: Identifiers: Flash:

The room settings.

Received after searching for a user in the console. Response for . Supported clients: Identifiers: Flash: Shockwave:

The search results.

Received after searching for a user in the console. Response for . Supported clients: Identifiers: Flash: Shockwave:

The search results.

Received when a group of items and/or an avatar are moved by a roller. Supported clients: Identifiers: Flash: Shockwave:

The group of items being updated.

Received when a group of items and/or an avatar are moved by a roller. Supported clients: Identifiers: Flash: Shockwave:

The group of items being updated.

Received when a user accepts or unaccepts at trade. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user who accepted or unaccepted. Used on modern clients. The name of the user who accepted or unaccepted. Used on the Shockwave client. Whether the user accepted.

Received when a user accepts or unaccepts at trade. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user who accepted or unaccepted. Used on modern clients. The name of the user who accepted or unaccepted. Used on the Shockwave client. Whether the user accepted.

The ID of the user who accepted or unaccepted. Used on modern clients.

The name of the user who accepted or unaccepted. Used on the Shockwave client.

Whether the user accepted.

Received when both users have accepted the trade and the server is now awaiting confirmation from both users. Supported clients: Identifiers: Flash:

Received when a trade is closed. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user who closed the trade. Used on modern clients. The reason that the trade was closed. Used on modern clients.

Received when a trade is closed. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user who closed the trade. Used on modern clients. The reason that the trade was closed. Used on modern clients.

The ID of the user who closed the trade. Used on modern clients.

The reason that the trade was closed. Used on modern clients.

Received when a trade completes successfully. Supported clients: Identifiers: Flash: Shockwave:

Received when a trade offer is updated. Supported clients: Identifiers: Flash: Shockwave:

The first offer in the trade. The second offer in the trade.

Received when a trade offer is updated. Supported clients: Identifiers: Flash: Shockwave:

The first offer in the trade. The second offer in the trade.

The first offer in the trade.

The second offer in the trade.

Received when a trade is opened. Supported clients: Identifiers: Flash:

The ID of the user who initiated the trade. Whether the trader can trade. The ID of the user who received the trade. Whether the tradee can trade.

Received when a trade is opened. Supported clients: Identifiers: Flash:

The ID of the user who initiated the trade. Whether the trader can trade. The ID of the user who received the trade. Whether the tradee can trade.

The ID of the user who initiated the trade.

Whether the trader can trade.

The ID of the user who received the trade.

Whether the tradee can trade.

Received when a trade fails to open. Supported clients: Identifiers: Flash:

Indicates the reason that the trade failed to open. The name of the user that the trade failed to open with.

Received when a trade fails to open. Supported clients: Identifiers: Flash:

Indicates the reason that the trade failed to open. The name of the user that the trade failed to open with.

Indicates the reason that the trade failed to open.

The name of the user that the trade failed to open with.

Received when an avatar's figure, motto or achievement score updates. Supported clients: Identifiers: Flash:

Received after requesting the user's data. Response for . Supported clients: Identifiers: Flash: Shockwave:

The current user's data.

Received after requesting the user's data. Response for . Supported clients: Identifiers: Flash: Shockwave:

The current user's data.

Received when a user is unbanned from a room. Response for . Supported clients: Identifiers: Flash:

The ID of the room that the user was unbanned from. The ID of the user that was unbanned.

Received when a user is unbanned from a room. Response for . Supported clients: Identifiers: Flash:

The ID of the room that the user was unbanned from. The ID of the user that was unbanned.

The ID of the room that the user was unbanned from.

The ID of the user that was unbanned.

Received when a wall item is added to the room. Supported clients: Identifiers: Flash: Shockwave:

The wall item that was added.

Received when a wall item is added to the room. Supported clients: Identifiers: Flash: Shockwave:

The wall item that was added.

Received when a wall item is removed from the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the wall item that was removed. The ID of the user who picked up the item. Only available on clients.

Received when a wall item is removed from the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the wall item that was removed. The ID of the user who picked up the item. Only available on clients.

The ID of the wall item that was removed.

The ID of the user who picked up the item. Only available on clients.

Represents a list of wall items. Received when wall items in the room are loaded. Supported clients: Identifiers: Flash: Shockwave:

Received when a wall item is updated. Supported clients: Identifiers: Flash: Shockwave:

The updated wall item.

Received when a wall item is updated. Supported clients: Identifiers: Flash: Shockwave:

The updated wall item.

Represents a list of wired movement updates. Received when objects in the room are moved by wired. Supported clients: Identifiers:

Sent when performing an action in a room. Supported clients: Identifiers: Flash: Shockwave:

The action to perform. Only is supported on .

Sent when performing an action in a room. Supported clients: Identifiers: Flash: Shockwave:

The action to perform. Only is supported on .

Sent when responding to the doorbell. Supported clients: Identifiers: Flash: Shockwave:

The name of the user. Whether to accept the user into the room.

Sent when responding to the doorbell. Supported clients: Identifiers: Flash: Shockwave:

The name of the user. Whether to accept the user into the room.

The name of the user.

Whether to accept the user into the room.

Sent when banning a user from a room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user to ban. Applies to clients. The name of the user to ban. Applies to the client. The ID of the room to ban the user from. Applies to clients. The duration of the ban. A custom ban duration string. Used when is -1.

Sent when banning a user from a room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user to ban. Applies to clients.

The name of the user to ban. Applies to the client.

The ID of the room to ban the user from. Applies to clients.

The duration of the ban.

A custom ban duration string. Used when is -1.

Constructs a new with the specified user, room ID and duration.

The user to ban.

Constructs a new with the specified user/ID pair, room ID and duration.

The ID and name of the user to ban.

Sent when sending a chat message in a room. Supported clients: Identifiers: Flash: , , Shockwave: , , .

The type of the chat message. The chat message content. The chat bubble style. Applies to clients. The recipient of the message, if this is a message.

Sent when sending a chat message in a room. Supported clients: Identifiers: Flash: , , Shockwave: , , .

The type of the chat message. The chat message content. The chat bubble style. Applies to clients. The recipient of the message, if this is a message.

The type of the chat message.

The chat message content.

The chat bubble style. Applies to clients.

The recipient of the message, if this is a message.

Sent when clicking a furni. Supported clients: Identifiers: Flash:

The type of item that was clicked. The ID of the item that was clicked. Appears to be unused.

Sent when clicking a furni. Supported clients: Identifiers: Flash:

The type of item that was clicked. The ID of the item that was clicked. Appears to be unused.

The type of item that was clicked.

The ID of the item that was clicked.

Appears to be unused.

Sent when closing a trade. Supported clients: Identifiers: Flash: Shockwave:

Sent when starting, stopping or changing dances in a room. Supported clients: Identifiers: Flash: Shockwave: , .

The dance to change to.

Sent when starting, stopping or changing dances in a room. Supported clients: Identifiers: Flash: Shockwave: , .

The dance to change to.

Sent when requesting the user's achievements. Request for . Returns . Supported clients: Identifiers: Flash:

Sent when requesting the user's badges. Responds with a sequence of . Supported clients: Identifiers: Flash:

Sent when requesting the list of users banned from a room. Request for . Returns the list of banned users as an array of . Supported clients: Identifiers: Flash:

The ID of the room to request banned users for.

Sent when requesting the list of users banned from a room. Request for . Returns the list of banned users as an array of . Supported clients: Identifiers: Flash:

The ID of the room to request banned users for.

Sent when requesting a catalog page. Supported clients: Identifiers: Flash:

Sent when requesting a catalog page. Supported clients: Identifiers: Shockwave:

Sent when requesting the user's credit balance. Request for . Returns an indicating the user's current balance. Supported clients: Identifiers: Flash: Shockwave:

Sent when requesting a group's information. Request for . Returns . Supported clients: Identifiers: Flash:

The ID of the group to request information for. Whether to open the group information in-client.

Sent when requesting a group's information. Request for . Returns . Supported clients: Identifiers: Flash:

The ID of the group to request information for. Whether to open the group information in-client.

The ID of the group to request information for.

Whether to open the group information in-client.

Sent when searching the list of a group's members. Request for . Returns a . Supported clients: Identifiers: Flash: The ID of the group. The page number of the group's member list to retrieve. The search text used to filter members by name. The type of the member search. Sent when searching the list of a group's members. Request for . Returns a . Supported clients: Identifiers: Flash: The ID of the group. The page number of the group's member list to retrieve. The search text used to filter members by name. The type of the member search.

The ID of the group.

The page number of the group's member list to retrieve.

The search text used to filter members by name.

The type of the member search.

Sent when requesting a wall item's data. Request for . Returns a representing the item's data. Supported clients: Identifiers: Flash: Shockwave:

Sent when requesting the marketplace statistics of an item. Request for . Returns a . Supported clients: Identifiers: Flash:

The type of the item to get marketplace statistics for. The kind of the item to get marketplace statistics for.

Sent when requesting the marketplace statistics of an item. Request for . Returns a . Supported clients: Identifiers: Flash:

The type of the item to get marketplace statistics for. The kind of the item to get marketplace statistics for.

The type of the item to get marketplace statistics for.

The kind of the item to get marketplace statistics for.

Sent when searching the marketplace for offers. Request for . Returns an array of . Supported clients: Identifiers: Flash:

The name of the item to search for. May be left blank. The minimum inclusive offer price to search for. -1 indicates no minimum. The maximum inclusive offer price to search for. -1 indicates no maximum. Specifies the order in which to return results.

Sent when searching the marketplace for offers. Request for . Returns an array of . Supported clients: Identifiers: Flash:

The name of the item to search for. May be left blank.

The minimum inclusive offer price to search for. -1 indicates no minimum.

The maximum inclusive offer price to search for. -1 indicates no maximum.

Specifies the order in which to return results.

Sent when requesting the user's own marketplace offers. Request for . Returns a . Supported clients: Identifiers: Flash:

Sent when requesting a pet's information. Request for . Returns a . Supported clients: Identifiers: Flash:

The ID of the pet to retrieve information for.

Sent when requesting a pet's information. Request for . Returns a . Supported clients: Identifiers: Flash:

The ID of the pet to retrieve information for.

Sent when requesting a user's profile. Request for . Returns . Supported clients: Identifiers: Flash:

The name of the user whose profile to request.

Sent when requesting a user's profile. Request for . Returns . Supported clients: Identifiers: Flash:

The name of the user whose profile to request.

Sent when requesting a user's profile. Request for . Returns a . Supported clients: Identifiers: Flash:

The ID of the user whose profile to request. Whether the open the profile in-client.

Sent when requesting a user's profile. Request for . Returns a . Supported clients: Identifiers: Flash:

The ID of the user whose profile to request. Whether the open the profile in-client.

The ID of the user whose profile to request.

Whether the open the profile in-client.

Sent when requesting the rights list of a room. Request for . Supported clients: Identifiers: Flash:

The ID of the room to request the rights list for.

Sent when requesting the rights list of a room. Request for . Supported clients: Identifiers: Flash:

The ID of the room to request the rights list for.

Sent when requesting room data for the specified room ID. Request for . Returns . Supported clients: Identifiers: Flash: Shockwave:

The room ID to request data for. Whether the user is entering the room. Does not apply to Origins. Whether to forward the user to the room in-client. Does not apply to Origins.

Sent when requesting room data for the specified room ID. Request for . Returns . Supported clients: Identifiers: Flash: Shockwave:

The room ID to request data for. Whether the user is entering the room. Does not apply to Origins. Whether to forward the user to the room in-client. Does not apply to Origins.

The room ID to request data for.

Whether the user is entering the room. Does not apply to Origins.

Whether to forward the user to the room in-client. Does not apply to Origins.

Sent when requesting the settings for a room. Request for . Supported clients: Identifiers: Flash:

The ID of the room to request settings for.

Sent when requesting the settings for a room. Request for . Supported clients: Identifiers: Flash:

The ID of the room to request settings for.

Sent when requesting a sticky note's contents. Request for . Returns a . Supported clients: Identifiers: Flash: Shockwave:

The ID of the sticky note to retrieve.

Sent when requesting a sticky note's contents. Request for . Returns a . Supported clients: Identifiers: Flash: Shockwave:

The ID of the sticky note to retrieve.

Sent when requesting the user's data. Request for . Supported clients: Identifiers: Flash: Shockwave:

Sent when giving rights to a user in the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user to give rights to. Applies to clients. The name of the user to give rights to. Applies to the client.

Sent when giving rights to a user in the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user to give rights to. Applies to clients. The name of the user to give rights to. Applies to the client.

The ID of the user to give rights to. Applies to clients.

The name of the user to give rights to. Applies to the client.

Sent when kicking a user from the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user to kick. Applies to clients. The name of the user to kick. Applies to the client.

Sent when kicking a user from the room. Supported clients: Identifiers: Flash: Shockwave:

The ID of the user to kick. Applies to clients. The name of the user to kick. Applies to the client.

The ID of the user to kick. Applies to clients.

The name of the user to kick. Applies to the client.

Constructs a new with the specified user.

The user to kick.

Constructs a new with the specified user ID and name.

The ID and name of the user to kick.

Constructs a new with the specified user ID. Applies to clients.

The ID of the user to kick.

Constructs a new with the specified name. Applies to the client.

The name of the user to kick.

Sent when looking towards a tile. Supported clients: Identifiers: Flash: Shockwave:

The point to look towards.

Sent when looking towards a tile. Supported clients: Identifiers: Flash: Shockwave:

The point to look towards.

Gets the X coordinate.

Gets the Y coordinate.

Sent when moving a floor item. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item to move. The location to move the floor item to. The direction to set the floor item to.

Sent when moving a floor item. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item to move. The location to move the floor item to. The direction to set the floor item to.

The ID of the floor item to move.

The location to move the floor item to.

The direction to set the floor item to.

Gets the X coordinate.

Gets the Y coordinate.

Sent when moving a wall item. Supported clients: Identifiers: Flash: Shockwave:

The ID of the wall item to move. The location to move the wall item to.

Sent when moving a wall item. Supported clients: Identifiers: Flash: Shockwave:

The ID of the wall item to move. The location to move the wall item to.

The ID of the wall item to move.

The location to move the wall item to.

Sent when muting a user in a room. Supported clients: Identifiers: Flash:

The ID of the user to mute. The ID of the room to mute the user in. The duration in minutes to mute the user for.

Sent when muting a user in a room. Supported clients: Identifiers: Flash:

The ID of the user to mute. The ID of the room to mute the user in. The duration in minutes to mute the user for.

The ID of the user to mute.

The ID of the room to mute the user in.

The duration in minutes to mute the user for.

Constructs a new with the specified user, room ID and duration.

The user to mute.

Sent when offering a single item in a trade. Supported clients: . Identifiers: Shockwave:

The ID of the item to offer.

Sent when offering a single item in a trade. Supported clients: . Identifiers: Shockwave:

The ID of the item to offer.

Sent when offering items in a trade. Supported clients: . Identifiers: Flash:

Sent when picking up or ejecting a furni from a room. Supported clients: Identifiers: Flash: Shockwave:

The type of the furni to pick up. The ID of the furni to pick up.

Sent when picking up or ejecting a furni from a room. Supported clients: Identifiers: Flash: Shockwave:

The type of the furni to pick up. The ID of the furni to pick up.

The type of the furni to pick up.

The ID of the furni to pick up.

Constructs a new with the specified furni.

The furni to pick up.

Sent when placing a floor item in a room. Supported clients: , Identifiers: Flash: Shockwave:

The ID of the floor item to place. The location to place the item at. The direction to place the item in. The size of the object on the X axis. Applies to the client. The size of the object on the Y axis. Applies to the client.

Sent when placing a floor item in a room. Supported clients: , Identifiers: Flash: Shockwave:

The ID of the floor item to place.

The location to place the item at.

The direction to place the item in.

The size of the object on the X axis. Applies to the client.

The size of the object on the Y axis. Applies to the client.

Gets the X coordinate.

Gets the Y coordinate.

Sent when placing a wall item in a room. Supported clients: , Identifiers: Flash: Shockwave:

The ID of the wall item to place. The location to place the wall item at.

Sent when placing a wall item in a room. Supported clients: , Identifiers: Flash: Shockwave:

The ID of the wall item to place. The location to place the wall item at.

The ID of the wall item to place.

The location to place the wall item at.

Response to . Supported clients: Identifiers: Flash: Shockwave:

Sent when removing friends from the user's friends list. Supported clients: Identifiers: Flash: Shockwave:

Sent when removing the rights of a user from the current room. Supported clients: Identifiers: Flash: Shockwave:

The list of user IDs to remove rights from. Applies to clients. The name of the user to remove rights from. Applies to the client.

Sent when removing the rights of a user from the current room. Supported clients: Identifiers: Flash: Shockwave:

The list of user IDs to remove rights from. Applies to clients. The name of the user to remove rights from. Applies to the client.

The list of user IDs to remove rights from. Applies to clients.

The name of the user to remove rights from. Applies to the client.

Sent when searching for a user in the console. Request for . Returns . Supported clients: Identifiers: Flash: Shockwave:

The name of the user to search for. The type of search to perform. Only used on . Defaults to "MESSENGER".

Sent when searching for a user in the console. Request for . Returns . Supported clients: Identifiers: Flash: Shockwave:

The name of the user to search for. The type of search to perform. Only used on . Defaults to "MESSENGER". >

The name of the user to search for.

The type of search to perform. Only used on . Defaults to "MESSENGER".

Sent when sending a message to a friend via the console. Supported clients: Identifiers: Flash: Shockwave:

Only a single recipient is supported on clients. On the client, you can specify multiple recipients.

The list of recipient IDs. Only a single recipient is supported on clients.

The message content.

Sent when updating a room background toner. Supported clients: Identifiers: Flash:

The ID of the background toner. The hue of the background toner, ranging from 0-255. The saturation of the background toner, ranging from 0-255. The value of the background toner, ranging from 0-255.

Sent when updating a room background toner. Supported clients: Identifiers: Flash:

The ID of the background toner. The hue of the background toner, ranging from 0-255. The saturation of the background toner, ranging from 0-255. The value of the background toner, ranging from 0-255.

The ID of the background toner.

The hue of the background toner, ranging from 0-255.

The saturation of the background toner, ranging from 0-255.

The value of the background toner, ranging from 0-255.

Sent when shouting in a room. Supported clients: Identifiers: Flash: Shockwave:

The chat message content. The chat bubble style. Applies to clients.

Sent when shouting in a room. Supported clients: Identifiers: Flash: Shockwave:

The chat message content. The chat bubble style. Applies to clients.

The chat message content.

The chat bubble style. Applies to clients.

Sent when talking in a room. Supported clients: Identifiers: Flash: Shockwave:

The chat message content. The chat bubble style. Applies to clients. The tracking ID of the message.

Sent when talking in a room. Supported clients: Identifiers: Flash: Shockwave:

The chat message content. The chat bubble style. Applies to clients. The tracking ID of the message.

The chat message content.

The chat bubble style. Applies to clients.

The tracking ID of the message.

Sent when opening a trade with a user. Supported clients: Identifiers: Flash: Shockwave:

The avatar index of the user to trade.

Sent when opening a trade with a user. Supported clients: Identifiers: Flash: Shockwave:

The avatar index of the user to trade.

Sent when unbanning a user from a room. The server may respond with if the user was unbanned. Supported clients: Identifiers: Flash:

The ID of the user to unban. The ID of the room to unban the user from.

Sent when unbanning a user from a room. The server may respond with if the user was unbanned. Supported clients: Identifiers: Flash:

The ID of the user to unban. The ID of the room to unban the user from.

The ID of the user to unban.

The ID of the room to unban the user from.

Sent when updating the user's avatar looks. Supported clients: (Intercept/Send) (Send only: translates to Identifiers: Flash: Shockwave:

Sent when updating the user's motto. Supported clients: (Send only: translates to Identifiers: Flash: Shockwave:

Sent when updating the user's profile or account. Supported clients: Identifiers: Shockwave:

Sent when using a floor item. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item. The state of the floor item. Appears to be unused - items are always toggled between states.

Sent when using a floor item. Supported clients: Identifiers: Flash: Shockwave:

The ID of the floor item. The state of the floor item. Appears to be unused - items are always toggled between states.

The ID of the floor item.

The state of the floor item. Appears to be unused - items are always toggled between states.

Sent when using a wall item. Supported clients: Identifiers: Flash:

The ID of the wall item. The state of the wall item. Appears to be unused - items are always toggled between states.

Sent when using a wall item. Supported clients: Identifiers: Flash:

The ID of the wall item. The state of the wall item. Appears to be unused - items are always toggled between states.

The ID of the wall item.

The state of the wall item. Appears to be unused - items are always toggled between states.

Sent when clicking a tile in a room to walk to. Supported clients: Identifiers: Flash: Shockwave:

The coordinates of the tile.

Sent when clicking a tile in a room to walk to. Supported clients: Identifiers: Flash: Shockwave:

The coordinates of the tile.

Sent when whispering in a room. Supported clients: Identifiers: Flash: Shockwave:

The recipient of the message. The chat message content. The chat bubble style. Applies to clients.

Sent when whispering in a room. Supported clients: Identifiers: Flash: Shockwave:

The recipient of the message. The chat message content. The chat bubble style. Applies to clients.

The recipient of the message.

The chat message content.

The chat bubble style. Applies to clients.

Represents a list of .

Represents a collection of .

Defines information about a pet.

Defines the chat bubble width for a room.

Defines the chat flood protection level for a room.

Defines the chat flow behavior for a room.

Defines the speed at which chat scrolls in a room.

Represents a type of chat message.

Defines chat related settings for a room.

Specifies the chat flow behavior.

Specifies the chat bubble width;

Specifies the chat scroll speed.

Specifies the distance at which users can hear each other talk.

Specifies the chat flood protection level.

Represents a type of room mute.

Gets whether a floor item that would occupy the specified area can likely be placed.

The area that the floor item would occupy if placed. Whether the item can likely be placed.

Finds all potential locations a floor item of the specified size could be placed within the specified area. If the entry point it not null, it will be excluded from the placement area.

The area to search for placeable locations. The size of the floor item. The entry tile to optionally ignore. All points within the specified area where a floor item of the specified size could likely be placed.

Constructs a new heightmap tile with the specified coordinates and encoded value.

The location of the tile. The encoded value.

Updates the tile with the specified encoded value.

The encoded value.

Represents an entity that occupies a space in a room.

Gets the location of the entity in the room.

Gets the direction the entity is facing.

Gets the size of the entity, if it is available.

Gets the area occupied by the entity, if it is available.

Gets the original string that this floor plan was parsed from.

Gets the wall scaling for this floor plan.

Gets the wall height for this floor plan.

Gets the size of the floor plan.

Gets the area of the floor plan.

Gets the tile height at the specified coordinates.

Gets if the tile at the specified coordinates in this floor plan is walkable.

Represents the stacking heightmap of a room. Stores whether a certain location contains a floor tile, whether a furni may be placed on that tile, and the height at which a furni may be placed.

Gets the size of the heightmap.

Gets the area of the heightmap.

Gets the heightmap tile at the specified coordinates.

Gets whether a furni can be placed at the specified area.

Attempts to find a point where a furniture of the specified size can be placed.

The size of the furniture to place. The room entry tile. This tile will be ignored if specified.

Represents a tile in the heightmap.

Gets the X coordinate of the tile.

Gets the Y coordinate of the tile.

Gets the coordinates of the tile.

Whether the tile is a floor tile.

Whether the tile is blocked by a furniture.

Gets whether the tile is a floor tile and is not blocked by a furniture.

Gets the height for this tile at which furni may be placed.

Represents extended information about a room.

Whether the user is entering the room.

Whether to forward the user to the room in client.

Whether the user is a member of the room's group.

Whether the room is muted.

The moderation settings for the room.

Whether the room can be muted.

The chat settings for the room.

Represents information about a room.

The ID of the room.

The name of the room.

The ID of the room owner.

The name of the room owner.

The room access mode.

Gets whether the room is open.

Gets whether users must ring the doorbell.

Gets whether the room is password protected.

Gets whether the room is invisible.

The number of users in the room.

The maximum number of users allowed in the room.

The room description.

The room trading permissions.

The room category.

A list of tags that can be used to search for the room.

Whether the room is a group home room.

Whether the room current has an event.

Whether to show the room owner name in client.

Whether other users' pets are allowed in the room.

The room's group ID.

The room's group name.

The room's group badge code.

The current event name.

The current event description.

The remaining time of the event in minutes.

Represents a room rights level.

Represents no rights.

Represents standard rights.

Represents a group administrator's rights.

Represents the room owner's rights.

Represents a type of avatar slide caused by a roller.

Represents an error received after failing to enter a room.

The password was incorrect.

The room is full.

The room is closed.

The user is banned from the room.

Defines who can mute, kick or ban in a room.

Specifies who is allowed to mute other users in the room.

Specifies who is allowed to kick other users from the room.

Specifies who is allowed to ban other users from the room.

Defines a room moderation permission.

Represents a type of room access.

The room is open.

Users must ring the doorbell.

The room is password protected.

The room is invisible.

The room is only open to friends.

Represents the category of a room in the navigator.

Defines the settings for a room.

The ID of the room.

The name of the room.

The description of the room.

The access mode of the room.

The password for the room if is .

The maximum number of users allowed in the room.

The category of the room in the navigator.

A list of tags that can be used to search for the room in the navigator.

The trading permissions for the room.

Whether others users' pets are allowed in the room.

Whether other users' pets are allowed to eat food placed in the room.

Whether to disable room blocking and allow users to walk through each other.

Whether to hide the walls.

The thickness of the walls.

The thickness of the floor.

The moderation settings for the room.

The chat settings for the room.

Writes the values of this to the specified packet to be sent to the server with .

Specifies the thickness of a room's walls or floor.

Represents a room's trading permissions.

Trading is not allowed.

Only rights holders may initiate a trade.

Trading is allowed.

Represents an avatar being moved by a roller.

The index of the avatar.

The height the avatar is sliding from.

The height the avatar is sliding to.

Constructs a new .

Represents a floor item being moved by a roller.

The ID of the floor item.

The height the object is sliding from.

The height the object is sliding to.

Constructs a new .

Represents a group of objects being moved by a roller.

Associates a single roller with a group of floor item slide movements and/or a single avatar slide movement.

The position the objects are sliding from.

The position the objects are sliding to.

The group of objects being moved by the roller.

The ID of the roller that caused the slide.

The type of the avatar slide, if in avatar is being moved.

The avatar being moved by the roller.

Available if is or .

Constructs a new empty .

Represents a type of wired movement.

Used when an avatar is moved by wired.

Used when a floor item is moved by wired.

Used when a wall item is moved by wired.

Used when an avatar's direction is updated by wired.

Defines the base parameters of a wired movement.

Defines the parameters of an avatar being moved by wired.

Defines the parameters of a floor item being moved by wired.

Defines the parameters of a wall item being moved by wired.

Defines the parameters of an avatar's direction being changed by wired.

Defines the source generated JSON serialization contract metadata for a given type.

The default associated with a default instance.

The source-generated options associated with this context.

Defines the source generated JSON serialization contract metadata for a given type.

The default associated with a default instance.

The source-generated options associated with this context.

Defines the source generated JSON serialization contract metadata for a given type.

The default associated with a default instance.

The source-generated options associated with this context.

Attempts to enter a specified room by its ID, and optionally a password. On Shockwave, this task can only enter another room if the user is currently in a room.

On Flash, this task does the following: Requests the specified room data by its ID with . Modifies the , , and fields in the response, causing the client to attempt to enter the room. Replaces the password in the packet if required. Handles and to determine whether room entry was successful. On Shockwave, this task does the following: Attempts to initiate room entry by room ID and password with , causing the client to send . Replaces the room ID in with the target room ID. This is required because the packet will have the ID of the room the user is currently in. Handles , , and to determine whether room entry was successful.

Attempts to enter a specified room by its ID, and optionally a password. On Shockwave, this task can only enter another room if the user is currently in a room.

Gets a catalog page by its ID.

Sends a request to place a floor item and returns whether the item was successfully placed.

The interceptor. The ID of the item to place. The location to place the item. The direction to place the item in.

Sends a request to place a floor item and returns whether the item was successfully placed.

The interceptor. The ID of the item to place. The location to place the item. The direction to place the item in.

Sends a request to place a wall item and returns whether the item was successfully placed.

The interceptor. The ID of the item to place. The location to place the item.

Sends a request to place a wall item and returns whether the item was successfully placed.

The interceptor. The ID of the item to place. The location to place the item.

Represents an item in a trade.

Represents a user's offer in a trade.

The ID of the user.

Used on modern clients.

The name of the user.

Used on Origins.

The number of furni in the trade offer.

Used on modern clients.

The number of credits in the trade offer.

Used on modern clients. This appears to be an unused field in the Origins packet structure as users will automatically unaccept the trade whenever a trade offer updates.

Represents a badge ID and code.

Represents an avatar's gender.

Represents information about the current user.

Represents the in-game profile of user.

Represents a user search result.

The current location of the user.

Only available on Shockwave.

Represents a list of user search results.

On Shockwave, this should contain a single user in the list.

Represents an area in a room.

Gets the point with the minimum X and Y coordinates of the area.

Gets the point with the maximum X and Y coordinates of the area.

Gets the size of this area.

Constructs a new area at the specified point with the specified size.

The width or length is less than 1.

Constructs a new area from the specified corner points.

Constructs a new area with the specified size.

Returns a new area translated to the specified coordinates.

Returns a new area with the width and length reversed.

Checks if this area contains the specified point.

Gets whether another area is contained within this area.

Gets whether specified floor entity is contained within this area.

Gets whether the specified area intersects with this area.

Gets whether the specified area contains this area.

The containing area to check whether this area is inside.

Gets whether the specified floor entity intersects with this area.

Gets all tile coordinates contained in this area.

Implicitly casts the specified corner points to an area.

Implicitly casts the specified points to an area.

Implicitly casts the specified origin point, width, and length to an area.

Gets all points contained within the specified area.

Gets all distinct points contained within the specified areas.

Gets a string representation of this area.

Gets the intersection of two areas.

The first area. The second area. The intersection of the two areas.

Represents a set of combined areas.

Creates a new AreaSet consisting of the specified areas.

Represents a name and ID.

Adds or updates the specified item in the dictionary, and returns whether the item was added via the '' out parameter. Returns the previous value if the item was updated, or the default value if it was added.

Represents a 2-dimensional location.

Returns a new point with the X and Y coordinates flipped.

Represents a 3-dimensional location.

Compares two Z coordinates and returns whether they are close enough to each other to be considered equivalent when two furni are placed at either coordinate.

Represents a wall item location.

The wall coordinates. The location coordinates. The wall orientation.

Represents a wall item location.

The wall coordinates. The location coordinates. The wall orientation.

The wall coordinates.

The location coordinates.

The wall orientation.

Represents a wall location with all coordinates at zero, and the orientation set to the left wall.

Constructs a new wall location with the specified coordinates and orientation.

Offsets the wall coordinates by the specified values attempting to keep the location fixed in place, relative to the original wall location.

The amount to offset the wall coordaintes by. The scale value of the room as specified in the floor plan.

Attempts to adjust all coordinates to a valid location using the room scale, and returns the updated wall location. This does not take into account the floor plan, which affects the Location's Y coordinate depending on the wall height and tile location.

The scale value of the room as specified in the floor plan.

Flips the wall orientation between left and right, and returns the new wall location.

Returns a new wall location with the specified orientation.

Adds the specified offset values and returns the new wall location.

Adds the specified location offset values and returns the new wall location.

Represents a wall orientation.

Represents a left wall orientation.

Gets the character value of this wall orientation.

Gets if this is a left wall orientation.

Gets if this is a right wall orientation.

Gets the wall orientation by the specified character. Must be l or r.

The specified character is not a valid wall orientation.

Reads a value of the specified type from the current position in the packet.

Reads a value of the specified type from the specified position in the packet.

Writes a value of the specified type to the current position in the packet.

Writes a value of the specified type to the specified position in the packet.

Replaces a value of the specified type at the current position in the packet.

Replaces a value of the specified type at the specified position in the packet.

Modifies a value of the specified type at the current position in the packet.

Modifies a value of the specified type at the specified position in the packet.

Reads 2 values of the specified types from the current position in the packet.

Replaces 2 values of the specified types at the current position in the packet.

Sends a value of the specified type with the specified message identifier.

Sends 2 values of the specified types with the specified message identifier.

Sends 3 values of the specified types with the specified message identifier.

Custom -derived type for the RegexAvatarValidator method.

Cached, thread-safe singleton instance.

Initializes the instance.

Provides a factory for creating instances to be used by methods on .

Creates an instance of a used by methods on .

Provides the runner that contains the custom logic implementing the specified regular expression.

Scan the starting from base.runtextstart for the next match.

The text being scanned by the regular expression.

Search starting from base.runtextpos for the next location a match could possibly start.

The text being scanned by the regular expression. true if a possible match was found; false if no more matches are possible.

Determine whether at base.runtextpos is a match for the regular expression.

The text being scanned by the regular expression. true if the regular expression matches at the current position; otherwise, false.

Helper methods used by generated -derived implementations.

Default timeout value set in , or if none was set.

Whether is non-infinite.