From 9dea6bc647fe1dd8e9dd0a98b97736ff4bf97839 Mon Sep 17 00:00:00 2001 From: Bluenix Date: Tue, 5 Oct 2021 20:57:53 +0200 Subject: [PATCH] Add documentation entry about using several options (#1) --- docs/mkdocs.yml | 1 + docs/source/tutorial/mcdonalds-order.md | 119 ++++++++++++++++++++++++ 2 files changed, 120 insertions(+) create mode 100644 docs/source/tutorial/mcdonalds-order.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 45874c6..7bfcbaf 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -47,6 +47,7 @@ nav: - Message commands: tutorial/context-menus/message-commands.md - User commands: tutorial/context-menus/user-commands.md - Option choices: tutorial/rock-paper-scissors.md + - Multiple options: tutorial/mcdonalds-order.md - Reference: - Application commands: reference/interactions/commands.md diff --git a/docs/source/tutorial/mcdonalds-order.md b/docs/source/tutorial/mcdonalds-order.md new file mode 100644 index 0000000..29a791d --- /dev/null +++ b/docs/source/tutorial/mcdonalds-order.md @@ -0,0 +1,119 @@ +# McDonald's order slash command + +On this page we're gonna go into how you can have multiple options for a +command and cover more of the types supported. + +## Scoping out the command + +First let's figure out what we want to do. The plan is to create a `/order` +command that will allow you to order a burger. + +The options the comand will take is an integer being the amount of hamburgers +as well as a bool whether the order includes fries. + +## Creating the command + +Let's start like we always do: + +```python +from wumpy import interactions + + +app = interactions.InteractionApp(...) + + +@app.command() +async def order(interaction: interactions.CommandInteraction) -> None: + """Order a McDonald's burger menu.""" + pass +``` + +Now we add the first option, the amount of burgers: + +```python +from wumpy import interactions + + +app = interactions.InteractionApp(...) + + +@app.command() +async def order( + interaction: interactions.CommandInteraction, + amount: int = interactions.Option(description='The amount of burgers'), +) -> None: + """Order a McDonald's burger menu.""" + pass +``` + +We want to give this a default value though, if it isn't passed then of course +you only want one burger. + +Let's see how this looks together with a response: + +```python +from wumpy import interactions + + +app = interactions.InteractionApp(...) + + +@app.command() +async def order( + interaction: interactions.CommandInteraction, + amount: int = interactions.Option(1, description='The amount of burgers'), +) -> None: + """Order a McDonald's burger menu.""" + await interaction.respond(f"Here's your order: {amount}x 🍔") +``` + +## Adding fries to the mix + +Now our command can take an optional `amount` argument, let's add the bool +that we scoped out earlier. + +The interaction option will look like this: + +```python +from wumpy import interactions + + +app = interactions.InteractionApp(...) + + +@app.command() +async def order( + interaction: interactions.CommandInteraction, + amount: int = interactions.Option(1, description='The amount of burgers'), + fries: bool = interactions.Option( + False, description='Whether you want fries included.' + ), +) -> None: + """Order a McDonald's burger menu.""" + await interaction.respond(f"Here's your order: {amount}x 🍔") +``` + +The very last part is updating our code to handle this. Like this: + +```python +from wumpy import interactions + + +app = interactions.InteractionApp(...) + + +@app.command() +async def order( + interaction: interactions.CommandInteraction, + amount: int = interactions.Option(1, description='The amount of burgers'), + fries: bool = interactions.Option( + False, description='Whether you want fries included.' + ), +) -> None: + """Order a McDonald's burger menu.""" + extra = '' + if fries: + extra += ' + 🍟' + + await interaction.respond(f"Here's your order: {amount}x 🍔" + extra) +```