Skip to main content
Version: 15.x (API 15) [Current]

Class CommandInfo

This class describes a registered command.

Assembly: Dalamud.dll​
Declaration
public sealed class CommandInfo : IReadOnlyCommandInfo

Implements:
Dalamud.Game.Command.IReadOnlyCommandInfo

Properties​

Handler​

Gets a Dalamud.Game.Command.IReadOnlyCommandInfo.HandlerDelegate which will be called when the command is dispatched.

Declaration
public IReadOnlyCommandInfo.HandlerDelegate Handler { get; }

HelpMessage​

Gets the help message for this command.

Declaration
public string HelpMessage { get; set; }

ShowInHelp​

Gets a value indicating whether if this command should be shown in the help output.

Declaration
public bool ShowInHelp { get; set; }

DisplayOrder​

Gets the display order of this command. Defaults to alphabetical ordering.

Declaration
public int DisplayOrder { get; set; }

AllowedInMacros​

Gets a value indicating whether this command is permitted to run in macros. Defaults to true.

Declaration
public bool AllowedInMacros { get; set; }

Implements​