Show / Hide Table of Contents

    Namespace QFSW.QC

    Classes

    ActionExecuter

    BasicCachedQcParser<T>

    Parser for a single type. Caches results and reuses them if the incoming string has already been parsed.

    BasicCachedQcSuggestor<TItem>

    An IQcSuggestor that caches the created IQcSuggestion objects

    BasicQcParser<T>

    Parser for a single type.

    BasicQcSerializer<T>

    Serializer for a single type.

    CollectionFormatter

    CommandAttribute

    Marks the associated method as a command, allowing it to be loaded by the QuantumConsoleProcessor. This means it will be usable as a command from a Quantum Console.

    CommandData

    Contains the full data about a command and provides an execution point for invoking the command.

    CommandDescriptionAttribute

    Provides a command with a description. If the [Command] attribute already provides a description, that will supersede this one. Useful for when you have several [Command]s on a single method.

    CommandParameterDescriptionAttribute

    Provides a command paremeter with a description.

    CommandPlatformAttribute

    Determines which platforms the command is available on. Supersedes platform availability determined in the [Command].

    CommandPrefixAttribute

    Creates a prefix that will be prepended to all commands made within this class. Works recursively with sub-classes.

    GenericCachedQcParser

    Parser for all types that are generic constructions of a single type. Caches results and reuses them if the incoming string has already been parsed.

    GenericQcParser

    Parser for all types that are generic constructions of a single type.

    GenericQcSerializer

    Serializer for all types that are generic constructions of a single type.

    InjectionLoader<T>

    Loads and instantiates instances of the injectable types.

    InputHelper

    InvocationTargetFactory

    LambdaCommandData

    Wraps a dynamic delegate such as Action and Func so that a lambda can be used as a command.

    LogQueue

    LogStorage

    LogTypeExtensions

    MassGenericQcParser

    Parser for all types that are generic constructions of a several types.

    NoInjectAttribute

    Prevents the type from being loaded by an InjectionLoader

    ParserException

    Exception to be thrown by an IQcParser.

    ParserInputException

    Exception to be thrown by an IQcParser to indicate the input was invalid.

    PlatformExtensions

    PolymorphicCachedQcParser<T>

    Parser for all types inheriting from a single type. Caches results and reuses them if the incoming string has already been parsed.

    PolymorphicQcParser<T>

    Parser for all types inheriting from a single type.

    PolymorphicQcSerializer<T>

    Serializer for all types inheriting from a single type.

    QcIgnoreAttribute

    Instructs QC to ignore this entity when scanning the code base for commands. This can be used to optimise QCs loading times in large codebases when there are large entities that do not have any commands present.

    QuantumConsole

    Provides the UI and I/O interface for the QuantumConsoleProcessor. Invokes commands on the processor and displays the output.

    QuantumConsoleProcessor

    The core processor of Quantum Console handling command table generation and invocation.

    QuantumKeyConfig

    QuantumLocalization

    QuantumMacros

    QuantumParser

    Handles parsing values to use as console inputs.

    QuantumPreprocessor

    Handles preprocessing of console input.

    QuantumRegistry

    QuantumScanRuleset

    A set of rules for determining which entities should and shouldn't be scanned by Quantum Console for commands.

    QuantumSerializer

    Handles formatted serialization for console returns.

    QuantumSuggestor

    Provides a filtered and sorted list of suggestions for a given context using IQcSuggestors and IQcSuggestionFilter

    QuantumTheme

    RawSuggestion

    Raw suggestion of a given value.

    SuggestionDisplay

    SuggestionSet

    A managed set of suggestions for a given context.

    SuggestionStack

    Managed stack of suggestion sets updated from a user prompt. Each suggestion set represents a layer of suggestions, allowing for nested suggestions.

    SuggestorTagAttribute

    Base attribute for all IQcSuggestorTag sources.

    SuggestorUtilities

    Common utilities used by the suggestion system.

    TextProcessing

    TypeColorFormatter

    TypeFormatter

    Structs

    ActionContext

    The context that an action is being invoked on.

    Log

    ModifierKeyCombo

    ResponseConfig

    Configuration for requesting a response in the console.

    SuggestionContext

    The context to provide suggestions for.

    SuggestorOptions

    Options used by the suggestor when producing suggestions.

    TextProcessing.ReduceScopeOptions

    Options to provide the ReduceScoped functions with

    TextProcessing.ScopedSplitOptions

    Options to provide the SplitScoped functions with

    Interfaces

    ICommandAction

    Creates an action that can be yielded in commands.

    ILog

    ILogQueue

    ILogStorage

    IQcGrammarConstruct

    Creates a Parser for a custom grammar construct that is loaded and used by the QuantumParser. Grammar constructs are tested and used before resorting to IQcParsers for object value parsing.

    IQcParser

    Creates a Parser that is loaded and used by the QuantumParser.

    IQcPreprocessor

    Creates a Preprocessor that is loaded and used by the QuantumConsoleProcessor.

    IQcScanRule

    A rule for determining which entities should and shouldn't be scanned by Quantum Console for commands.

    IQcSerializer

    Creates a Serializer that is loaded and used by the QuantumSerializer.

    IQcSuggestion

    A suggestion that can be auto completed and displayed.

    IQcSuggestionFilter

    A filter that can remove suggestions produced by the QuantumSuggestor

    IQcSuggestor

    A suggestor that is loaded by the QuantumSuggestor to suggest IQcSuggestions

    IQcSuggestorTag

    Base type for tags to use for the suggestion system. Suggestors may check the context for the presence of different tags.

    Enums

    ActionState

    The execution state of an action.

    AutoScrollOptions

    LoggingLevel

    LoggingThreshold

    Thresholds for log severities.

    MonoTargetType

    Determines the target type for non static MonoBehaviour commands.

    Platform

    Bitwise flag enum for the runtime platform. Setting a platform bit to 0 includes it as a supported platform.

    ScanRuleResult

    The result of querying an entity with a scan rule.

    SortOrder

    Sort order options.

    SupportedState

    Which states of the build will be supported.

    Quantum Console by QFSW
    Back to top