Get Started - Learn How To Make Your Bot!

Guides

Code Snippets

Get methods

Post methods

Web API

Useful links

List of all currently Free Items

List of Emotes

Highrise Bot SDK Changelog

Added on version 23.3.0

set_outfit(self, outfit: list[Item]) -> None | Error:

Set the bot's outfit.

It takes list of items that bot should equip. Bot can equip free items or items in his own inventory.

<aside> 💡 PLEASE READ THE WEBSITE GUIDE ON HOW THIS METHOD WORKS

Highrise Create Portal

</aside>

Here are the most important points:

The outfit must contain items from specific categories:

1. Bot's outfit should always include the "body-flesh" item within the set_outfit requests. Note that the skin tone can be changed using active_palette, with the default being set to 27.
2. Other categories you need to include in your outfit request are "eye", "eyebrow", "nose", and "mouth".
3. Lastly, you'll need a combination of either a "shirt" and "pants", a "shirt" and "skirt", a "dress", or a "fullsuit".

<aside> 💡 You can check a list of currently free items at:

</aside>

⚙️ Use cases

Here’s a simple example of outfit:

async def on_chat(self, user: User, message: str) -> None:
        if message.lower().startswith("/equip"):
            await self.highrise.set_outfit(outfit=[
																									Item(
                                                      type='clothing',
                                                      amount=1,
                                                      id='body-flesh',
                                                      account_bound=False,
                                                      active_palette=27
                                                  ),
                                                  Item(
                                                      type='clothing',
                                                      amount=1,
                                                      id='eye-n_basic2018malesquaresleepy',
                                                      account_bound=False,
                                                      active_palette=7
                                                  ),
                                                  Item(
                                                      type='clothing',
                                                      amount=1,
                                                      id='eyebrow-n_basic2018newbrows07',
                                                      account_bound=False,
                                                      active_palette=0
                                                  ),
                                                  Item(
                                                      type='clothing',
                                                      amount=1,
                                                      id='nose-n_basic2018newnose05',
                                                      account_bound=False,
                                                      active_palette=0
                                                  ),
		                                              Item(
		                                                  type='clothing',
		                                                  amount=1,
		                                                  id='mouth-basic2018chippermouth',
		                                                  account_bound=False,
		                                                  active_palette=-1
		                                              ),
		                                              Item(
		                                                  type='clothing',
		                                                  amount=1,
		                                                  id='glasses-n_starteritems201roundframesbrown',
		                                                  account_bound=False,
		                                                  active_palette=-1
		                                              ),
		                                              Item(
		                                                  type='clothing',
		                                                  amount=1,
		                                                  id='bag-n_room32019sweaterwrapblack',
		                                                  account_bound=False,
		                                                  active_palette=-1
		                                              ),
		                                              Item(
		                                                  type='clothing',
		                                                  amount=1,
		                                                  id='shirt-n_starteritems2019tankwhite',
		                                                  account_bound=False,
		                                                  active_palette=-1
		                                              ),
		                                              Item(
		                                                  type='clothing',
		                                                  amount=1,
		                                                  id='shorts-f_pantyhoseshortsnavy',
		                                                  account_bound=False,
		                                                  active_palette=-1
		                                              ),
		                                              Item(
		                                                  type='clothing',
		                                                  amount=1,
		                                                  id='shoes-n_whitedans',
		                                                  account_bound=False,
		                                                  active_palette=-1
		                                              ),
		                                              ])