Document reaction_roles parameter better

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2021-08-07 22:19:02 +02:00
parent 7bd83a28b1
commit a4530489b6
Signed by: luzifer
GPG key ID: 0066F03ED215AD7D
2 changed files with 2 additions and 2 deletions

View file

@ -147,7 +147,7 @@ func (m modReactionRole) Setup() error {
}
func (m modReactionRole) extractRoles() (map[string]string, error) {
// @attr reaction_roles required []string "" List of strings in format `emote=role-id`
// @attr reaction_roles required []string "" List of strings in format `emote=role-id[:set]` (`✅=873653932478574632:set` = Emote ✅ to add role 873653932478574632 and prevent it to be removed again, `:thx:862322180896063489=873649098740342855` = Custom emote `:thx:` with corresponding ID to add role 873649098740342855)
list, err := m.attrs.StringSlice("reaction_roles")
if err != nil {
return nil, errors.Wrap(err, "getting role list")

View file

@ -116,7 +116,7 @@ Creates a post with pre-set reactions and assigns roles on reaction
| --------- | :--: | ---- | ------------- | ----------- |
| `discord_channel_id` | ✅ | string | | ID of the Discord channel to post the message to |
| `embed_title` | ✅ | string | | Title of the embed |
| `reaction_roles` | ✅ | []string | | List of strings in format `emote=role-id` |
| `reaction_roles` | ✅ | []string | | List of strings in format `emote=role-id[:set]` (`✅=873653932478574632:set` = Emote ✅ to add role 873653932478574632 and prevent it to be removed again, `:thx:862322180896063489=873649098740342855` = Custom emote `:thx:` with corresponding ID to add role 873649098740342855) |
| `embed_color` | | int64 | `0x2ECC71` | Integer representation of the hex color for the embed |
| `embed_description` | | string | | Description for the embed block |
| `embed_thumbnail_height` | | int64 | | Height of the thumbnail |