-
-
Notifications
You must be signed in to change notification settings - Fork 44
sharedlibrarycore Command
RaidMax edited this page May 21, 2023
·
1 revision
Abstract class for command
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IManagerCommand[[IManagerCommand]]
class SharedLibraryCore.Interfaces.IManagerCommand interfaceStyle;
end
SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command
Type | Name | Methods |
---|---|---|
string |
Alias Alternate name for this command to be executed by |
get, protected set |
bool |
AllowImpersonation indicates if this command allows impersonation (run as) |
get, set |
CommandArgument []
|
Arguments Argument list for the command |
get, protected set |
string |
Description Specifies the command description |
get, protected set |
bool |
IsBroadcast |
get, set |
string |
Name Specifies the name and string that triggers the command |
get, protected set |
Permission |
Permission Minimum permission level to execute command |
get, protected set |
int |
RequiredArgumentCount Helper property to determine the number of required args |
get |
bool |
RequiresTarget Indicates if the command requires a target to execute on |
get, protected set |
Game``[] |
SupportedGames |
get, protected set |
string |
Syntax Helper property to provide the syntax of the command |
get |
Returns | Name |
---|---|
Task |
ExecuteAsync (GameEvent gameEvent)Executes the command |
Abstract class for command
public Command(CommandConfiguration config, ITranslationLookup layout)
Type | Name | Description |
---|---|---|
CommandConfiguration |
config | |
ITranslationLookup |
layout |
public abstract Task ExecuteAsync(GameEvent gameEvent)
Type | Name | Description |
---|---|---|
GameEvent |
gameEvent |
Executes the command
public int RequiredArgumentCount { get; }
Helper property to determine the number of required args
public CommandArgument Arguments { get; protected set; }
Argument list for the command
public string Name { get; protected set; }
Specifies the name and string that triggers the command
public string Description { get; protected set; }
Specifies the command description
public virtual string Syntax { get; }
Helper property to provide the syntax of the command
public string Alias { get; protected set; }
Alternate name for this command to be executed by
public bool RequiresTarget { get; protected set; }
Indicates if the command requires a target to execute on
public Permission Permission { get; protected set; }
Minimum permission level to execute command
public Game SupportedGames { get; protected set; }
public bool AllowImpersonation { get; set; }
indicates if this command allows impersonation (run as)
public virtual bool IsBroadcast { get; set; }
Generated with ModularDoc