imvu.js

Documentation / @imvu/bot / BotOptions

Interface: BotOptions ​

Defined in: packages/bot/src/Bot.ts:30

Properties ​

admins? ​

ts
admins?: (string | number)[];

Defined in: packages/bot/src/Bot.ts:35

Bot operators: allowed every command everywhere.

client ​

ts
client: Client;

Defined in: packages/bot/src/Bot.ts:31

globalRateLimit? ​

ts
globalRateLimit?: RateLimit;

Defined in: packages/bot/src/Bot.ts:39

Outgoing chat budget for the whole account, across all rooms. Default 20 lines per 10 s.

help? ​

ts
help?: boolean;

Defined in: packages/bot/src/Bot.ts:50

Register a built-in help command. Default true.

ims? ​

ts
ims?: boolean;

Defined in: packages/bot/src/Bot.ts:56

Answer IMs (private and group conversations) as well as room chat. Default true.

join? ​

ts
join?: JoinOptions;

Defined in: packages/bot/src/Bot.ts:54

Passed to every room.join().

joinInterval? ​

ts
joinInterval?: number;

Defined in: packages/bot/src/Bot.ts:43

Pause between room joins, so joining hundreds of rooms doesn't burst. Default 1.5 s.

maxQueue? ​

ts
maxQueue?: number;

Defined in: packages/bot/src/Bot.ts:41

Lines allowed to wait for a room's rate limit before new ones are rejected. Default 20.

moderatorCacheMs? ​

ts
moderatorCacheMs?: number;

Defined in: packages/bot/src/Bot.ts:52

How long a room's moderator list is trusted before re-reading it. Default 5 min.

prefix? ​

ts
prefix?: string;

Defined in: packages/bot/src/Bot.ts:33

Command prefix. Default !.

rateLimit? ​

ts
rateLimit?: RateLimit;

Defined in: packages/bot/src/Bot.ts:37

Outgoing chat budget per room. Default 3 lines per 5 s.

rejoin? ​

ts
rejoin?: 
  | boolean
  | {
  afterBoot?: boolean;
  delays?: number[];
};

Defined in: packages/bot/src/Bot.ts:48

Rejoin when the server drops the bot (expired presence, network). Default true. afterBoot also rejoins after being booted (default false; staying out is polite).

Released under the MIT License.