eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-04 04:56:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Describe flags

Browse source
This commit is contained in:
Ske 2020-06-12 15:46:46 +02:00
parent 68b1fab369
commit d1476e1b88
2 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/commands/commands.js
View file

@ -42,8 +42,8 @@ function systemSetterCommand(cmdPrefix, valueName, valueArg, exampleVal = "examp
{cmd: `${cmdPrefix} \`${valueArg}\``, desc: `Sets your ${valueName}.`} {cmd: `${cmdPrefix} \`${valueArg}\``, desc: `Sets your ${valueName}.`}
], ],
examples: [ examples: [
{cmd: cmdPrefix, desc: `Shows your current ${valueName}.`},
{cmd: `${cmdPrefix} -clear`, desc: `Clears your ${valueName}.`}, {cmd: `${cmdPrefix} -clear`, desc: `Clears your ${valueName}.`},
...(withRaw ? [{cmd: `${cmdPrefix} -raw`, desc: `Shows your ${valueName} with formatting.`}] : []),
{cmd: `${cmdPrefix} \`${exampleVal}\``, desc: `Changes your ${valueName} to '${exampleVal}'`} {cmd: `${cmdPrefix} \`${exampleVal}\``, desc: `Changes your ${valueName} to '${exampleVal}'`}
], ],
flags: { flags: {

16
docs/content/guide/commands.md
View file

@ -22,8 +22,6 @@ Some commands accept a **target system or member**:
For **systems**, this can either be a [5-character ID](./ids.md), a `@mention`, or a [Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-). For **systems**, this can either be a [5-character ID](./ids.md), a `@mention`, or a [Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-).
In many cases you can leave the system out entirely. Instead, it'll just use your own system. In many cases you can leave the system out entirely. Instead, it'll just use your own system.
For **members**, this can be the member's name or their [5-character ID](./ids).
::: details Example of referring to systems ::: details Example of referring to systems
<CmdGroup> <CmdGroup>
<Cmd comment="Own system">system list</Cmd> <Cmd comment="Own system">system list</Cmd>
@ -33,6 +31,8 @@ For **members**, this can be the member's name or their [5-character ID](./ids).
</CmdGroup> </CmdGroup>
::: :::
For **members**, this can be the member's name or their [5-character ID](./ids).
::: details Example of referring to members ::: details Example of referring to members
<CmdGroup> <CmdGroup>
<Cmd comment="By name">member <Arg>Myriad</Arg> info</Cmd> <Cmd comment="By name">member <Arg>Myriad</Arg> info</Cmd>
@ -45,6 +45,18 @@ For **members**, this can be the member's name or their [5-character ID](./ids).
If you're trying to refer to a member with **spaces or emojis** in their name, you'll need to wrap the name in either 'single' or "double" quotes. Alternatively, you can use the [member ID](./ids). If you're trying to refer to a member with **spaces or emojis** in their name, you'll need to wrap the name in either 'single' or "double" quotes. Alternatively, you can use the [member ID](./ids).
::: :::
### Flags
**Flags** are small options you can apply to a command to change its behavior.
All flags follow the format `-word` or `-multiple-words` (as in, they all start with a **-**).
Flags **may appear in any order**, and most flags can appear anywhere in the command
(with some exceptions; although placing them before the first argument is usually a safe bet).
A common flag is `-clear`, which is used for most "change" commands. This flag instructs the command to clear a value instead of showing or changing it. For example, to clear your system description, you'd use the flag like this:
<Cmd comment="Clears your system description (note the flag: -clear)">system description -clear</Cmd>
Commands with flags list the flags in the **Flags** section below, along with an explanation of what they do.
## System commands ## System commands
::: tip ::: tip
You can use <Cmd inline>s</Cmd> instead of <Cmd inline>system</Cmd> as a short-hand. You can use <Cmd inline>s</Cmd> instead of <Cmd inline>system</Cmd> as a short-hand.