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.1.0b0

get_room_users(self) -> GetRoomUsersRequest.GetRoomUsersResponse | Error:

This method returns all the Users in the room along with their Position and Facing Positions.

βš™οΈ Use cases

This method is very useful to get informations about who is your room and where they are.

async def on_chat(self, user: User, message: str) -> None:
        if message.startswith("users"):
            room_users = (await self.highrise.get_room_users()).content
            await self.highrise.chat(f"There are {len(room_users)} users in the room")

In this example the bot will send a message chat telling how many users are in the room when someone says β€œusers”:

Untitled