1 sharedlibrarycore Command

RaidMax edited this page 2023-05-20 22:09:21 -05:00

Table of Contents

• Command Public class
• Description
• Diagram
• Members
• Properties
• Public properties
• Methods
• Public methods
• Details
• Summary
• Inheritance
• Constructors
• Command
• Arguments
• Methods
• ExecuteAsync
• Arguments
• Summary
• Returns
• Properties
• RequiredArgumentCount
• Summary
• Arguments
• Summary
• Name
• Summary
• Description
• Summary
• Syntax
• Summary
• Alias
• Summary
• RequiresTarget
• Summary
• Permission
• Summary
• SupportedGames
• AllowImpersonation
• Summary
• IsBroadcast

Command Public class

Description

Abstract class for command

Diagram

  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

Members

Properties

Public properties

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

Methods

Public methods

Returns	Name
Task	ExecuteAsync(GameEvent gameEvent) Executes the command

Details

Summary

Abstract class for command

Inheritance

• IManagerCommand

Constructors

Command

Source code

public Command(CommandConfiguration config, ITranslationLookup layout)

Arguments

Type	Name	Description
CommandConfiguration	config
ITranslationLookup	layout

Methods

ExecuteAsync

public abstract Task ExecuteAsync(GameEvent gameEvent)

Arguments

Type	Name	Description
GameEvent	gameEvent

Summary

Executes the command

Returns

Properties

RequiredArgumentCount

public int RequiredArgumentCount { get; }

Summary

Helper property to determine the number of required args

Arguments

public CommandArgument Arguments { get; protected set; }

Summary

Argument list for the command

Name

public string Name { get; protected set; }

Summary

Specifies the name and string that triggers the command

Description

public string Description { get; protected set; }

Summary

Specifies the command description

Syntax

public virtual string Syntax { get; }

Summary

Helper property to provide the syntax of the command

Alias

public string Alias { get; protected set; }

Summary

Alternate name for this command to be executed by

RequiresTarget

public bool RequiresTarget { get; protected set; }

Summary

Indicates if the command requires a target to execute on

Permission

public Permission Permission { get; protected set; }

Summary

Minimum permission level to execute command

SupportedGames

public Game SupportedGames { get; protected set; }

AllowImpersonation

public bool AllowImpersonation { get; set; }

Summary

indicates if this command allows impersonation (run as)

IsBroadcast

public virtual bool IsBroadcast { get; set; }

Generated with ModularDoc

• Overview
• Getting Started
• FAQ
• Knowledge Base
• Features
  • Commands
  • Webfront
  • Game Interface
  • Permission Sets
  • Plugins
  • API
  • Searching
• Plugin Development
  • Examples
• Configuration
• Game Log Server