Click or drag to resize

commandLineEntry Class

Home | imbSCI | imbACE | imbNLP | imbWEM | imbWBI
Represents an ACE Script command entry - a textual command input, phrased into object model
Inheritance Hierarchy

Namespace:  imbACE.Core.commands
Assembly:  imbACE.Core (in imbACE.Core.dll) Version: 0.2
Syntax
C#
public class commandLineEntry
Request Example View Source

The commandLineEntry type exposes the following members.

Constructors
  NameDescription
Public methodcommandLineEntry
Initializes a new instance of the commandLineEntry class and performs command phrasing (by calling process(commandLineEntry, String)
Top
Properties
  NameDescription
Public propertycommand
Textual representation of the main command verb
Public propertycommentedOut
If true, it means that this line contains just comment. When this is true, hasComment is also true and hasCommand is false;
Public propertycommentLine
Gets the comment line - comment that was extracted from input
Public propertyerrorMessage
The message associated with this entry, generated by command phraser
Public propertyformat
What command line format was detected in the input
Public propertyhasCommand
Gets a value indicating whether this instance has a proper command.
Public propertyhasComment
Gets a value indicating whether this instance contains a comment.
Public propertyhasPrefix
Gets a value indicating whether this instance has any prefix
Public propertyinputLine
Original input line, phrased by the command input interpreter
Public propertyisEmptyLine
The command line was empty, without any command
Public propertyisSyntaxError
Indicates if the command entry had syntax error
Public propertyparameterName
List of parameter names, as specified in explicit command format
Public propertyparameterValue
List of parameter values, in their string forms
Public propertyprefix
Contains path segments, identifying a plugin/console graph node that should perform the command
Public propertyspecialFunction
Gets or sets the special function.
Top
Methods
  NameDescription
Public methodStatic memberprocess
Processes the specified input and populates the entry - the code imbACE command phraser
Top
Fields
  NameDescription
Public fieldStatic memberCOMMANDFORMAT_CommandAndSpecialSufix
Public fieldStatic memberCOMMANDFORMAT_Explicit
The commandformat explicit: explore word="kontakti";engine=hunspell;log=5;
Public fieldStatic memberCOMMANDFORMAT_Implicit
The commandformat implicit: explore "kontakti", 510, hunspell
Public fieldStatic memberCOMMANDFORMAT_OnlyCommand
Public fieldStatic memberCOMMANDPREFIX_SEPARATOR
Public fieldStatic membercommentPrefix
The comment prefix - causes interpreter to ignore this line
Public fieldStatic memberPARAM_HELP
The parameter help - causes interpreter to show help for command invoked
Public fieldStatic memberPARAM_WILLCARD
The parameter willcard - causes interpreter to ask for parameter values, instead of using default values
Top
Extension Methods
  NameDescription
Public Extension MethodaceGenEx (Defined by aceExceptionTools.)
Public Extension MethodaceSciEx (Defined by aceExceptionTools.)
Top
See Also