logo bannerlogo banner
Page Navigator

Example Usage

import ReportPlayerDispatch from 'yolkbot/dispatches/ReportPlayerDispatch';

bot.dispatch(new ReportPlayerDispatch('0', {
    cheating: true,
    harassment: true,
    offensive: true,
    other: false
})); // a player's ID with the "cheating", "harassment", and "offensive" reasons selected

bot.dispatch(new ReportPlayerDispatch('1ust')); // a player's name with no reasons selected (it will select just the "other" option)

Arguments

  • target (string): This can either be an ingame username or an ingame player ID. Note that IDs take priority over usernames, so if you pass something like 5 and there is a player with the name 5, the bot will select the player with the ID 5 instead of the player with the name 5. IDs should be passed as strings.

Checks

  • The bot must be in a game
  • The player passed must be a valid player in the game

Notes

The following options can be passed:

  • cheating
  • harassment
  • offensive
  • other

If you don't pass an option, it will be assumed that the option is not selected.

If you don't pass a reason object or don't pass anything, it will assume reason is "other" and go through with the report.