Admin Commands

class AdminCommands[source]

Commands that deal with the moderation tasks.

Note

Only Admins and Owners will have access to these.

cmd_announce()[source]
Parameters

  • message (discord.Message) – The message which triggered this command.

  • ping (Optional[discord.Role]) – The role to ping when the announcement is made.

Syntax

/announce

Description

🛡️ Admin Command Make PokeGambler send an announcement in the announcement channel.

cmd_add_chips()[source]
Parameters

  • message (discord.Message) – The message which triggered this command.

  • user (discord.User) – The user whom the chips are being added to.

  • amount (int) – The amount of chips to add.

  • purchased (Optional[bool]) – Whether Pokebonds were purchased instead of chips.

  • deduct (Optional[bool]) – Whether to deduct the amount from the user’s balance.

Syntax

/add_chips user:@user amount:chips
[purchased:True/False] [deduct:True/False]

Description

🛡️ Admin Command Adds Pokechips to a user’s account. Use the purchased option in case of Pokebonds.

Examples

  • To give 50 Pokechips to user ABCD#1234

/add_chips user:@ABCD#1234 amount:50

  • To add 50 exchanged {pokebond_emoji} to user ABCD#1234

/add_chips user:ABCD#1234 amount:50 purchased:True

  • To deduct 500 Pokechips from user ABCD#1234

/add_chips user:@ABCD#1234 amount:500 deduct:True

Aliases

chips+

Parameter Config

Amount

Min_Value

10
Purchased

Default

False
Deduct

Default

False
cmd_blacklist_user()[source]
Parameters

  • message (discord.Message) – The message which triggered this command.

  • user (discord.Member) – The user to blacklist.

  • reason (Optional[str]) – The reason for blacklisting the user.

Syntax

/blacklist_user user:@user [reason:reason]

Description

🛡️ Admin Command Blacklists a user from using PokeGambler until pardoned. Use the Reason option to provide a reason for the blacklist.

Examples

  • To blacklist user ABCD#1234 from using PokeGambler

/blacklist_user user:@ABCD#1234

  • To blacklist user ABCD#1234 from using PokeGambler for spamming

/blacklist_user user:@ABCD#1234 reason:Spamming

Aliases

bl

Models

Blacklist, Profiles

cmd_user_profile()[source]
Parameters

  • message (discord.Message) – The message which triggered this command.

  • user (discord.User) – The user whose profile is being requested.

Syntax

/user_profile user:@user

Description

🛡️ Admin Command Get the complete profile of a user, including their loot information.

Examples

  • To get the complete profile of user ABCD#1234

/user_profile user:@ABCD#1234

Aliases

usr_pr

cmd_pardon_user()[source]
Parameters

Syntax

/pardon_user user:@user

Description

🛡️ Admin Command Pardons a blacklisted user so that they can use PokeGambler again.

Examples

  • To pardon user ABCD#1234

/pardon user:@ABCD#1234

Aliases

pardon

Models

Blacklist, Profiles

cmd_reset_user()[source]
Parameters

  • message (discord.Message) – The message which triggered this command.

  • user (discord.User) – The user whose profile is being reset.

Syntax

/reset_user user:@user

Description

🛡️ Admin Command Completely resets a user’s profile to the starting stage.

Examples

  • To reset user ABCD#1234

/reset_user user:@ABCD#1234

Aliases

rst_usr

cmd_update_user()[source]
Parameters

  • message (discord.Message) – The message which triggered this command.

  • user (discord.User) – The user whose profile is being updated.

Syntax

/update_user user:@user

Description

🛡️ Admin Command Updates a user’s profile.

Examples

  • To update user ABCD#1234

/update_user user:@ABCD#1234

Aliases

upd_usr

cmd_censor_uids()[source]

Censor the IDs of a user from the database. Replaces the user ID with “REDACTED”.

Parameters

  • message (discord.Message) – The message which triggered this command.

  • user (discord.User) – The user whose IDs need to be censord.

Syntax

/censor_uids user:@User

Description

👑 Owner Command Censors the IDs of a user from the database.

Examples

  • To censor a user ABC#1234:

/censor_uids user:@ABC#1234
cmd_create_item()[source]
Parameters

  • message (discord.Message) – The message which triggered this command.

  • premium (Optional[bool]) – Whether or not the item is premium.

Syntax

/create_item [premium:True/False]

Description

🛡️ Admin Command Creates a PokeGambler world Item and saves it in the database.

See also

Item

Note

  • Chests cannot be created using this.

  • RewardBoxes and Lootbags are yet to be implemented.

  • Owner(s) can create Premium items using the Premium option.

Examples

  • To create a non premium item

/create_item

  • To create a premium item

/create_item premium:True

Aliases

item+

Parameter Config

Premium

Default

False
cmd_update_item()[source]
Parameters

  • message (discord.Message) – The message which triggered the command.

  • itemid (str) – The ID of the item to update.

  • modify_all (Optional[bool]) – Whether or not to modify all copies of the item.

Syntax

/update_item itemid:Id [modify_all:True/False]

Description

🛡️ Admin Command Updates an existing Item/all copies of the Item in the database.

Tip

Check Item for available parameters.

Note

Category & Premium status change is not yet supported.

Examples

  • To update a Golden Cigar with ID 0000FFFF

/update_item itemid:0000FFFF

  • To update all copies of the item with ID 0000FFFF

/update_item itemid:0000FFFF modify_all:True

Aliases

upd_itm

Models

Item, Tradable

Parameter Config

Modify_All

Default

False
cmd_delete_item()[source]
Parameters

  • message (discord.Message) – The message which triggered the command.

  • itemid (str) – The item ID to delete.

Syntax

/delete_item itemid:Id

Description

🛡️ Admin Command Delete an item from the database. If the item was in anyone’s inventory, it will be gone.

Examples

  • To delete a Golden Cigar with ID 0000FFFF

/delete_item itemid:0000FFFF

Aliases

item-

cmd_distribute_item()[source]
Parameters

  • message (discord.Message) – The message which triggered the command.

  • itemid (str) – The item ID to distribute.

Syntax

/distribute_item itemid:Id

Description

🛡️ Admin Command Distributes an item to everyone who is not blacklisted.

Examples

  • To distribute a Golden Cigar with ID 0000FFFF

/distribute_item itemid:0000FFFF

Aliases

item_all

Models

Inventory, Item, Profiles

cmd_give_item()[source]
Parameters

  • message (discord.Message) – The message which triggered the command.

  • user (discord.User) – The user to give the item to.

  • itemid (str) – The ID of the item to give.

Syntax

/give_item user:@User itemid:Id

Description

🛡️ Admin Command Gives an item to a user.

Note

Creates a new copy of existing item before giving it to the user.

Examples

  • To give a Golden Cigar with ID 0000FFFF to ABCD#1234

/give_item user:ABCD#1234 itemid:0000FFFF

Aliases

usr_itm

Models

Inventory, Item