sharedlibrarycoreinterfaces IManagerCommand - RaidMax/IW4M-Admin GitHub Wiki

IManagerCommand Public interface

Description

Defines the basic properties of a command

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SharedLibraryCore.Interfaces
  SharedLibraryCore.Interfaces.IManagerCommand[IManagerCommand](/RaidMax/IW4M-Admin/wiki/IManagerCommand)
  class SharedLibraryCore.Interfaces.IManagerCommand interfaceStyle;
  end

Members

Properties

Public properties

Type Name Methods
string AliasAlternative name of the command get
bool AllowImpersonationIndicates if the commands can be run as another client get
string DescriptionDescription of the command get
bool IsBroadcastIndicates if the command result should be broadcasted to all clients get, set
string NameName of the command get
Permission PermissionMinimum permission required to execute the command get
bool RequiresTargetIndicates if target is required get
Game``[] SupportedGamesGames the command is supported on get
string SyntaxSyntax for using the command get

Methods

Public methods

Returns Name
Task ExecuteAsync(GameEvent gameEvent)Executes the command

Details

Summary

Defines the basic properties of a command

Methods

ExecuteAsync

Source code

public Task ExecuteAsync(GameEvent gameEvent)
Arguments
Type Name Description
GameEvent gameEvent event corresponding to the command
Summary

Executes the command

Returns

Properties

Name

public string Name { get; }
Summary

Name of the command

Description

public string Description { get; }
Summary

Description of the command

Alias

public string Alias { get; }
Summary

Alternative name of the command

Permission

public Permission Permission { get; }
Summary

Minimum permission required to execute the command

SupportedGames

public Game SupportedGames { get; }
Summary

Games the command is supported on

Syntax

public string Syntax { get; }
Summary

Syntax for using the command

RequiresTarget

public bool RequiresTarget { get; }
Summary

Indicates if target is required

AllowImpersonation

public bool AllowImpersonation { get; }
Summary

Indicates if the commands can be run as another client

IsBroadcast

public bool IsBroadcast { get; set; }
Summary

Indicates if the command result should be broadcasted to all clients

Generated with ModularDoc