Settings
Bases: GroupCog
Represents the settings commands for the discord bot.
Source code in src\cogs\settings.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
|
__init__(bot)
Creates an instance of the Settings class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
bot
|
Bot
|
The bot that the cog is being added to. |
required |
Source code in src\cogs\settings.py
list_all(interaction)
async
Lists all the settings for the discord bot.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interaction
|
Interaction
|
Represents the interaction with discord. |
required |
Source code in src\cogs\settings.py
reset_history()
restore(interaction, change)
async
Restores a past setting change to the previous state.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interaction
|
Interaction
|
Represents the interaction with discord. |
required |
change
|
int
|
The number of the change that is to be reverted. |
required |
Source code in src\cogs\settings.py
set(interaction, setting, new_value)
async
Sets a setting in the discord bot configuration file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interaction
|
Interaction
|
Represents the interaction with discord. |
required |
setting
|
str
|
The setting that is being changed. |
required |
new_value
|
str
|
The new value for the setting. |
required |
Source code in src\cogs\settings.py
unset(interaction, setting)
async
Sets a value in the discord bot configuration to a value of "unset".
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interaction
|
Interaction
|
Represents the interaction with discord. |
required |
setting
|
str
|
The setting to "unset". |
required |
Source code in src\cogs\settings.py
view_history(interaction)
async
List the history of changes to the bot settings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interaction
|
Interaction
|
Represents the interaction with discord. |
required |