Otter  0.9.88
2d Game Development Framework based on SFML.Net
 All Classes Namespaces Functions Variables Enumerations Properties
Otter.OtterCommand Class Reference

Inherits Attribute.

Public Member Functions

 OtterCommand (string alias="", string usageText="", string helpText="", string group="", bool isBuffered=false)
 Use named parameters to define this to make your life way easier. More...
 

Public Attributes

string Alias
 The string that can be typed into the console to invoke this method. More...
 
string UsageText
 The text that will appear when the method is called with no parameters (note: will never show up if the method has no parameters by default.) More...
 
string HelpText
 The text that will appear along with the method when the user invokes the help command. More...
 
string Group
 The method group to associate this method with. Groups can be added or removed during runtime. More...
 
bool IsBuffered
 If true the method will not run until the next update. More...
 

Constructor & Destructor Documentation

Otter.OtterCommand.OtterCommand ( string  alias = "",
string  usageText = "",
string  helpText = "",
string  group = "",
bool  isBuffered = false 
)

Use named parameters to define this to make your life way easier.

Parameters
aliasThe string that can be typed into the console to invoke this method.
usageTextThe text that will appear when the method is called with no parameters (note: will never show up if the method has no parameters by default.)
helpTextThe text that will appear along with the method when the user invokes the help command.
groupThe method group to associate this method with. Groups can be added or removed during runtime.
isBufferedIf true the method will not run until the next update.

Member Data Documentation

string Otter.OtterCommand.Alias

The string that can be typed into the console to invoke this method.

string Otter.OtterCommand.Group

The method group to associate this method with. Groups can be added or removed during runtime.

string Otter.OtterCommand.HelpText

The text that will appear along with the method when the user invokes the help command.

bool Otter.OtterCommand.IsBuffered

If true the method will not run until the next update.

string Otter.OtterCommand.UsageText

The text that will appear when the method is called with no parameters (note: will never show up if the method has no parameters by default.)


The documentation for this class was generated from the following file: