Skip to main content

Rentable Space

Renting and cancelling shop/gallery spaces inside other users' rooms.

C→S 2946 - RentSpace

Nitro: RENTABLE_SPACE_RENT

Source: RentSpaceEvent, RentableSpaceRentMessageComposer

Requests rental of a rentable space furniture item by ID.

Body: (empty)

C→S 1667 - RentSpaceCancel

Nitro: RENTABLE_SPACE_CANCEL_RENT

Source: RentSpaceCancelEvent, RentableSpaceCancelRentMessageComposer

Body:
itemId: int

Cancels an active rental on a rentable space furniture item.

S→C 35 - RentableFurniRentOrBuyoutOffer

Nitro: RENTABLE_FURNI_RENT_OR_BUYOUT_OFFER Source: RentableItemBuyOutPriceComposer, FurniRentOrBuyoutOfferMessageEvent

FieldTypeNotes
isWallItembooleanWhether the furniture is a wall item
furniTypeNamestringInternal furniture type name
buyoutbooleanWhether this is a buyout offer (true) or rental (false)
priceInCreditsintPrice in credits (-1 if not purchasable this way)
priceInActivityPointsintPrice in activity points (-1 if not applicable)
activityPointTypeintType of activity points used (-1 if not applicable)

Delivers the rent/buyout offer details for a rentable furniture item.

S→C 2046 - RentableSpaceRentOk

Nitro: RENTABLE_SPACE_RENT_OK Source: RentableSpaceUnknownComposer, RentableSpaceRentOkMessageEvent

FieldTypeNotes
expiryTimeintUnix timestamp when the rental expires

Confirms that a rentable space rental was successful.

S→C 1868 - RentableSpaceRentFailed

Nitro: RENTABLE_SPACE_RENT_FAILED Source: RentableSpaceUnknown2Composer, RentableSpaceRentFailedMessageEvent

FieldTypeNotes
reasonintFailure reason code

Notifies that renting a rentable space failed.

S→C 3559 - RentableSpaceStatus

Nitro: RENTABLE_SPACE_STATUS Source: RentableSpaceInfoComposer, RentableSpaceStatusMessageEvent

FieldTypeNotes
rentedbooleanWhether the space is currently rented
canRentErrorCodeint0=can rent; other values are error codes
renterIdintAccount ID of the current renter (-1 if not rented)
renterNamestringUsername of the current renter
timeRemainingintSeconds remaining on the rental
priceintPrice to rent (in credits)

Delivers the current rental status of a rentable space item, including renter identity, time remaining, and price.