OpenMod Docs OpenMod Docs
OpenMod Docs OpenMod Docs
OpenMod .NET Plugin Framework.

Class CommandHelp

Inheritance
System.Object
CommandBase
Command
CommandHelp
Implements
ICommand
Inherited Members
Command.ExecuteAsync()
CommandBase.Context
CommandBase.PrintAsync(String)
CommandBase.PrintAsync(String, Color)
CommandBase.CheckPermissionAsync(String)
Namespace: OpenMod.Core.Commands.OpenModCommands
Assembly: OpenMod.Core.dll
Syntax
public class CommandHelp : Command, ICommand

Constructors

| Improve this Doc View Source

CommandHelp(IRuntime, ICommandStore, IServiceProvider, IPermissionRegistry, ICommandPermissionBuilder, ICommandContextBuilder, IOpenModStringLocalizer)

Declaration
public CommandHelp(IRuntime runtime, ICommandStore commandStore, IServiceProvider serviceProvider, IPermissionRegistry permissionRegistry, ICommandPermissionBuilder commandPermissionBuilder, ICommandContextBuilder commandContextBuilder, IOpenModStringLocalizer stringLocalizer)
Parameters
Type Name Description
IRuntime runtime
ICommandStore commandStore
IServiceProvider serviceProvider
IPermissionRegistry permissionRegistry
ICommandPermissionBuilder commandPermissionBuilder
ICommandContextBuilder commandContextBuilder
IOpenModStringLocalizer stringLocalizer

Methods

| Improve this Doc View Source

GetCommandUsage(ICommandRegistration)

Declaration
public string GetCommandUsage(ICommandRegistration command)
Parameters
Type Name Description
ICommandRegistration command
Returns
Type Description
System.String
| Improve this Doc View Source

GetPermission(ICommandRegistration, IReadOnlyCollection<ICommandRegistration>)

Declaration
protected virtual string? GetPermission(ICommandRegistration commandRegistration, IReadOnlyCollection<ICommandRegistration> commands)
Parameters
Type Name Description
ICommandRegistration commandRegistration
IReadOnlyCollection<ICommandRegistration> commands
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

OnExecuteAsync()

Declaration
protected override Task OnExecuteAsync()
Returns
Type Description
Task
Overrides
Command.OnExecuteAsync()

Implements

ICommand

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)