Xabbo.Core

Gets the ID.

Gets the current level.

Gets the badge ID.

Gets the base progress for the current level.

Gets the maximum progress for the current level.

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

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

Gets the total current progress of this achievement.

Gets if this the final level of this achievement has been reached.

Gets the category of this achievement.

Gets the sub-category of this achievement.

Gets the maximum level of this achievement.

Gets the root .

Gets the type of the catalog.

Searches the catalog for a matching .

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

Searches the catalog for a matching .

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

Gets the gender of the bot.

Gets the owner of the bot's ID.

Gets the owner of the bot's name.

Gets the data of the bot.

Represents a living entity in a room.

Gets if the entity has been removed from the room.

Gets if the entity is hidden client-side by the .

Gets the type of the entity.

Gets the ID of the entity.

Gets the index of the entity.

Gets the name of the entity.

Gets the motto of the entity.

Gets the figure string of the entity.

Gets the X coordinate of the entity.

Gets the Y coordinate of the entity.

Gets the XY coordinates of the entity.

Gets the Z coordinate of the entity.

Gets the current dance of the entity.

Gets if the entity is idle or not.

Gets if the entity is typing or not.

Gets the hand item the entity is currently holding.

Gets the current effect of the entity.

Gets the current update of the entity.

Gets the previous update of the entity.

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.

Gets the previous value of the dice.

Gets the current value of the dice.

Gets the user's offer.

Gets the trade partner's offer.

Gets if the user was the one who initiated the trade.

Gets the partner of the trade.

The reason that the trade failed to start.

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

Provides convenient extension methods utilizing Xabbo.Core.

Gets if Xabbo core extensions have been initialized.

Initializes Xabbo core extensions with the specified game data.

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.

Gets the name of an item or a generic type/kind specifier if unavailable.

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

Gets the variant of this item.

Gets the furni info of this item.

Gets the identifier of this item.

Gets the descriptor of this item.

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.

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.

Gets 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 entities at the specified X, Y, Z location and/or direction.

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

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

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

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

Gets 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 will not be included. 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.

Gets floor entities outside the specified areas.

The figure part type of this part set collection.

The color palette that this part set collection uses.

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.

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 specified item.

Gets the information of the furni with the specified identifier.

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

Gets the information of the specified item.

Gets the information of the furni with the specified identifier.

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.

Gets the of the specified item.

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

Contains information of a furni.

Gets the type of the furni.

Gets the kind of the furni.

Gets the unique identifier string of the furni.

Gets the name of the furni.

Gets the description of the furni.

Gets the category of the furni.

Gets the category name of the furni.

Returns true if , and are all false.

Gets the cache path where game data is stored.

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.

Invoked when game data begins loading.

Invoked when game data is successfully loaded.

Invoked when game data fails to load.

Loads game data for the specified hotel.

Waits for game data to load.

Gets if this 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 inventory immediately if it is available and has not been invalidated, otherwise attempts to retrieve it from the server. Note that 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.

Gets if this 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.

Gets the ID of this room.

Gets the data of this room.

Gets the name of this room.

Gets the description of this room.

Gets the owner of this room's ID.

Gets the owner of this room's name.

Gets the door access mode of this room.

Gets if this room is open.

Gets if this room is in doorbell mode.

Gets if this room is locked with a password.

Gets if this room is invisible.

Gets the maximum users allowed in this room.

Gets the trading permissions of this room.

Gets the score of this room.

Gets the ranking of this room.

Gets the category of this room.

Gets the flags of this room.

Gets if this room currently has an event.

Gets if this room is a group home room.

Gets if other's pets are allowed in this room.

Gets the ID of the group this room is home to.

Gets the name of the group this room is home to.

Gets the badge code of the group this room is home to.

Gets the event name for this room.

Gets the event description for this room.

Gets the number of minutes remaining of the event for this room.

Gets the moderation settings of this room.

Gets the chat settings of this room.

Gets the model of this room.

Gets the floor code of this room.

Gets the wallpaper code of this room.

Gets the landscape code of this room.

Gets the location of this room's door tile.

Gets the entry direction of this room.

Gets the floor plan of this room.

Gets the heightmap of this 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 entities in this room.

Gets the users in this room.

Gets the pets in this room.

Gets the bots in this room.

Gets the entity with the specified index if it exists.

Gets the entity with the specified name if it exists.

Gets the entity with the specified ID if it exists.

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, entities and chat.

Gets the ID of the current room. The may not be available even when the current room ID is set (e.g. when in the queue).

Invoked when the user enters the queue to a room.

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

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

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

Invoked when the room data is updated.

Invoked when the user leaves a room.

Invoked 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.

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

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

Invoked when a floor item is added to the room.

Invoked when a floor item is updated.

Invoked when a floor item's data is updated.

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

Invoked when users or furni are moved by wired.

Invoked when a floor item is removed from the room.

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

Invoked when a wall item is added to the room.

Invoked when a wall item is udpated.

Invoked when a wall item is removed from the room.

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

Invoked when an entity has been added to the room.

Invoked when entities have been added to the room.

Invoked when an entity in the room is updated.

Invoked when entities in the room are updated.

Invoked when an entity slides along a roller.

Invoked when an entity's figure, gender, motto or achievement score is updated.

Invoked when an entity's name changes.

Invoked when an entity's idle status updates.

Invoked when an entity's dance updates.

Invoked when an entity's hand item updates.

Invoked when an entity's effect updates.

Invoked when an entity performs an action.

Invoked when an entity's typing status updates.

Invoked when an entity is removed from the room.

Invoked when an entity in the room talks.

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

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

Sends a private message to the specified friend.

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

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.

Gets a catalog page by its ID.

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.

Gets the total number of fragments.

Gets the index of this fragment.

Defines crackable state as extra data in an item.

The number of hits the crackable furni has taken.

The target hit number of the crackable furni.

Defines a high score value with a list of associated users.

The value of this high score.

The users with this high score.

Defines high score information as extra data in an item.

Defines an integer array as extra data in an item.

Defines extra data attached to an item.

Gets the type of this item data.

Gets the flags of this item data.

Gets if this item data contains limited edition rare 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 this item data.

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

Defines a string to string map as extra data in an item.

Defines a string array as extra data in an item.

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.

Gets the height of the floor item.

Gets 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.

Gets the data of the floor item.

Represents a room furniture.

Gets the owner of the furni's ID.

Gets 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.

Gets the number of seconds until the furni expires.

Gets the usage policy of the furni.

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

Composes this furniture to the packet and specifies whether to write the owner's name.

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 type of furni of the item.

Gets the kind of furni of the item.

Gets the ID of the 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.

Creates a copy of the specified wall item.

Gets the average sale price in the last week.

Gets the number of currently open offers.

Gets the trading history information.

Gets the ID of the marketplace offer.

Gets the current status of this marketplace offer.

Gets the item data for the marketplace offer.

Gets the price of the marketplace offer.

Gets the remaining time of this offer in minutes.

Gets the average price for this item.

Gets the number of open offers for this item. Not available when loaded from the user's own marketplace offers.

A collection of the user's marketplace listings.

Gets the amount of credits waiting to be claimed.

Gets the ID of the pet.

Gets the name of the pet.

Gets the type ID of the pet.

Gets the palette ID of the pet.

Gets the color value of the pet.

Gets the breed ID of the pet.

Gets the custom part data of the pet.

Gets the level of the pet.

Represents an entity with an X, Y, Z location and direction in a room.

Gets the location of this entity.

Gets the direction of this entity.

Gets the area occupied by this floor entity.

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 width of this floor plan.

Gets the length of this floor plan.

Gets the tile height at the specified coordinates in this floor plan.

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 stack height at which a furni may be placed.

Gets the width of this heightmap.

Gets the length of this heightmap.

Gets the tile in this heightmap at the specified location.

Represents a tile in the heightmap.

Gets the X coordinate of this tile.

Gets the Y coordinate of this tile.

Gets the coordinates of this tile.

Gets if this is a floor tile.

Gets if this tile is blocked by an existing furni.

Gets if this is a floor tile and is not blocked by an existing furni.

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

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

Represents a type of wired movement.

Used when a user is moved by wired.

Used when a floor item is moved by wired.

Used when a wall item is moved by wired.

Defines the base parameters of a wired movement.

Defines the parameters of a user wired movement.

Contains information about the user's friend.

Gets the ID of the friend.

Gets the name of the friend.

Gets the gender of the friend.

Gets whether the friend is online or not.

Gets whether the friend can be followed or not.

Gets the figure string of the friend.

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

Gets the motto of the friend.

Gets whether the friend is accepting offline messages or not.

Gets the relation of the friend.

The current user's information that is sent upon requesting user data.

The user's own data that is sent upon requesting user data.

The user's information that is sent upon requesting their profile.

Represents an area in a 2-dimensional space.

Gets the X coordinate of the origin.

Gets the Y coordinate of the origin.

The width (on the X plane) of this area.

The length (on the Y plane) of this area.

Gets the size of this area.

The origin point of this area.

The point opposite the origin of this area.

Gets the X coordinate of the corner opposite the origin.

Gets the Y coordinate of the corner opposite the origin.

Gets the corner opposite the origin point 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 dimensions.

Returns a new area with the width and length reversed.

Checks if this area contains the specified point.

Gets if the specified area is contained within this area.

Gets if this area contains the specified floor entity.

Gets if this area intersects with the specified area.

Gets if this area intersects with the specified floor entity.

Gets all X, Y coordinates within 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.

Creates a new AreaSet consisting of the specified areas.

Represents an item type, kind, and variant (used for posters).

Gets the item type.

Gets the item kind.

Gets the item variant.

Represents a 2-dimensional location.

Creates a new point with the specified coordinates.

Represents a 2-dimensional size consisting of a width and length.

Represents a 3-dimensional location.

Represents a wall location.

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

Gets the wall X coordinate.

Gets the wall Y coordinate.

Gets the location X coordinate.

Gets the location Y coordinate.

Gets the wall orientation.

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 wall X by. The amount to offset wall Y 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. Does not take into account the floor plan which affects the offset of the LY coordinate.

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.