Get Started - Learn How To Make Your Bot!
List of all currently Free Items
Want a easier way to remove an item from your bot’s outfit? You found it!
The code that we’re going to use today is very similar to the code at ‣.
Today we are gonna make a function to remove an item from your bot’s outfit using on_chat commands. To do that we will use the 📬 Command Handler, note that this use is optional, you can implement this function directly on your main code or directly on your on_chat method.
The command works by saying the command (remove), and the item category.
<aside> ⚠️ MAKE SURE TO READ HOW CHANGING THE OUTFIT WORKS ABOVE:
</aside>
Highrise Official Documentation for Creators.
Highrise Official Documentation for Creators.
First of all, let’s create a new file called remove.py inside of our functions folder:
Example of workspace strucure.
Here’s what we will need to import into our remove.py file:
from highrise import *
from highrise.models import *
Let’s proceed to our function definition, since we’re using the command handler for this example, your function name will be the command that you will use in the chat to call it, I will name mine as color and I will create a list of valid categories:
from highrise import *
from highrise.models import *
categories = ["aura","bag","blush","body","dress","earrings","emote","eye","eyebrow","fishing_rod","freckle","fullsuit","glasses",
"gloves","hair_back","hair_front","handbag","hat","jacket","lashes","mole","mouth","necklace","nose","rod","shirt","shoes",
"shorts","skirt","sock","tattoo","watch"]
async def remove(self: BaseBot, user: User, message: str):
Finally, let’s implement the function and after it you will see a detailed step by step guide on how the code works:
from highrise import *
from highrise.models import *
categories = ["aura","bag","blush","body","dress","earrings","emote","eye","eyebrow","fishing_rod","freckle","fullsuit","glasses",
"gloves","hair_back","hair_front","handbag","hat","jacket","lashes","mole","mouth","necklace","nose","rod","shirt","shoes",
"shorts","skirt","sock","tattoo","watch"]
async def remove(self: BaseBot, user: User, message: str):
parts = message.split(" ")
if len(parts) != 2:
await self.highrise.chat("Invalid command format. You need to specify the category.")
return
if parts[1] not in categories:
await self.highrise.chat("Invalid category.")
return
category = parts[1].lower()
outfit = (await self.highrise.get_my_outfit()).outfit
for outfit_item in outfit:
#the category of the item in an outfit can be found by the first string in the id before the "-" character
item_category = outfit_item.id.split("-")[0][0:3]
if item_category == category[0:3]:
try:
outfit.remove(outfit_item)
except:
await self.highrise.chat(f"The bot isn't using any item from the category '{category}'.")
return
response = await self.highrise.set_outfit(outfit)
print(response)
Now let’s understand how the code works:
from highrise import * and from highrise.models import *:
categories = [... list of category strings ...]:
categories, containing strings that represent different categories of items in the game.async def remove(self: BaseBot, user: User, message: str):
remove.self (a reference to the instance of the class this method belongs to), user (an object representing the user who sent the chat message), and message (a string representing the chat message sent by the user).parts = message.split(" "):
message string into individual words using space as the separator and stores them in the list parts.if len(parts) != 2::
message, it means the user has not specified the category correctly.self.highrise.chat() to inform the user about the invalid command format and then returns, ending the function.if parts[1] not in categories::
parts (i.e., parts[1]) does not match any of the categories listed in categories.self.highrise.chat() to inform the user about the invalid category and then returns, ending the function.category = parts[1]:
category.(await self.highrise.get_my_outfit()).outfit:
get_my_outfit() on self.highrise to fetch the bot's outfit items.await.outfit appears to be the actual list of items in the bot's outfit.category.item_category = outfit_item.id.split("-")[0]:
outfit_item by splitting the item's ID using the "-" character and taking the first part (before the "-").if item_category == category::
outfit_item matches the specified category, the code attempts to remove that item from the outfit using outfit.remove(outfit_item).try: outfit.remove(outfit_item) except: await self.highrise.chat(f"The bot isn't using any item from the category '{category}'.") return:
outfit_item from the outfit. If the item is not found in the outfit (e.g., it's already been removed or wasn't present in the first place), an exception is raised.self.highrise.chat() to inform the user that the bot isn't using any item from the specified category.await self.highrise.set_outfit(outfit):
set_outfit(outfit) on self.highrise.outfit list.