25 replies

Read property from custom Command Options

Hey folks,

I have a custom command options object, that contains a property called

shortDesc

shortDesc

.
I want to read a property from the options, inside the

registerApplicationCommands

registerApplicationCommands

method, so that I can not have to provide this value (

Get a random trivia question

Get a random trivia question

) twice.

How do I read

shortDesc

shortDesc

this.shortDesc

this.shortDesc

didn't work the same as

this.name

this.name

did - I assume because

name

name

exists on the default

CommandOptions

CommandOptions

object, but it's having trouble parsing the Options here as

IDrpgCommandOptions

IDrpgCommandOptions

@ApplyOptions<IDrpgCommandOptions>({
    name: "Trivia",
    aliases: ["q", "t", "question", "trivia", "quiz"],
    shortDesc: "Get a random trivia question",
    showInHelpMenu: true,
})
export class QuestionCommand extends DrpgCommand {
    public override async registerApplicationCommands(registry: ApplicationCommandRegistry) {
        const shortDesc = "Get a random trivia question"; //TODO How to get shortDesc from above?
        registry.registerChatInputCommand((builder) => builder.setName(this.name).setDescription(shortDesc), {
            idHints: [""],
            behaviorWhenNotIdentical: RegisterBehavior.Overwrite,
        });
    }

@ApplyOptions<IDrpgCommandOptions>({
    name: "Trivia",
    aliases: ["q", "t", "question", "trivia", "quiz"],
    shortDesc: "Get a random trivia question",
    showInHelpMenu: true,
})
export class QuestionCommand extends DrpgCommand {
    public override async registerApplicationCommands(registry: ApplicationCommandRegistry) {
        const shortDesc = "Get a random trivia question"; //TODO How to get shortDesc from above?
        registry.registerChatInputCommand((builder) => builder.setName(this.name).setDescription(shortDesc), {
            idHints: [""],
            behaviorWhenNotIdentical: RegisterBehavior.Overwrite,
        });
    }

Solution

First of all, the reason it works in your help command is because you're using

command.options

command.options

, likewise if you use

this.options.shortDesc

this.options.shortDesc

it'll also be there.

Secondly, categories are built into sapphire so whatever you're setting in the constructor there is pretty pointless. That dates back to a very old by now version of Sapphire where categories weren't integrated

Thirdly, Sapphire Command class has a

detailedDescription

detailedDescription

option which can be an object of whatever you want and is set automatically so you do not even need custom properties for this at all. Just use module augmentation to modify the interface for

detailedDescription

detailedDescription

then use

detailedDescription: {
  shortDesc: 'whatever'
}

detailedDescription: {
  shortDesc: 'whatever'
}

and reference it with

this.detailedDescription.shortDesc

this.detailedDescription.shortDesc

Fourthly, you don't need a help command when going slash commands only because every command and every option already gets a description and if your commands/options are so convoluted that you cannot describe them in 100 characters then you should revise the command as a whole.

Jump to solution

S-IaF

Sapphire - Imagine a Framework•4y ago•

25 replies

Bejasc

Read property from custom Command Options

Hey folks,

I have a custom command options object, that contains a property called

shortDesc

shortDesc

.
I want to read a property from the options, inside the

registerApplicationCommands

registerApplicationCommands

method, so that I can not have to provide this value (

Get a random trivia question

Get a random trivia question

) twice.

How do I read

shortDesc

shortDesc

this.shortDesc

this.shortDesc

didn't work the same as

this.name

this.name

did - I assume because

name

name

exists on the default

CommandOptions

CommandOptions

object, but it's having trouble parsing the Options here as

IDrpgCommandOptions

IDrpgCommandOptions

@ApplyOptions<IDrpgCommandOptions>({
    name: "Trivia",
    aliases: ["q", "t", "question", "trivia", "quiz"],
    shortDesc: "Get a random trivia question",
    showInHelpMenu: true,
})
export class QuestionCommand extends DrpgCommand {
    public override async registerApplicationCommands(registry: ApplicationCommandRegistry) {
        const shortDesc = "Get a random trivia question"; //TODO How to get shortDesc from above?
        registry.registerChatInputCommand((builder) => builder.setName(this.name).setDescription(shortDesc), {
            idHints: [""],
            behaviorWhenNotIdentical: RegisterBehavior.Overwrite,
        });
    }

@ApplyOptions<IDrpgCommandOptions>({
    name: "Trivia",
    aliases: ["q", "t", "question", "trivia", "quiz"],
    shortDesc: "Get a random trivia question",
    showInHelpMenu: true,
})
export class QuestionCommand extends DrpgCommand {
    public override async registerApplicationCommands(registry: ApplicationCommandRegistry) {
        const shortDesc = "Get a random trivia question"; //TODO How to get shortDesc from above?
        registry.registerChatInputCommand((builder) => builder.setName(this.name).setDescription(shortDesc), {
            idHints: [""],
            behaviorWhenNotIdentical: RegisterBehavior.Overwrite,
        });
    }

Solution

First of all, the reason it works in your help command is because you're using

command.options

command.options

, likewise if you use

this.options.shortDesc

this.options.shortDesc

detailedDescription

detailedDescription

option which can be an object of whatever you want and is set automatically so you do not even need custom properties for this at all. Just use module augmentation to modify the interface for

detailedDescription

detailedDescription

then use

detailedDescription: {
  shortDesc: 'whatever'
}

detailedDescription: {
  shortDesc: 'whatever'
}

and reference it with

this.detailedDescription.shortDesc

this.detailedDescription.shortDesc

Jump to solution

Read property from custom Command Options

Read property from custom Command Options

Similar Threads

Similar Threads

Similar Threads