Executes an action associated with a specific key More...
Public Member Functions | |
| bool | Execute (Entity e=null) |
| Executes the specific command on the entity parameter More... | |
Protected Member Functions | |
| Command (Keys key, CommandType commandType) | |
| Initializes a new instance of the T:MidnightBlue.Command class. More... | |
| abstract void | OnKeyPress (Entity e=null) |
| Defines the logic to perform when operating on a given entity More... | |
Properties | |
| CommandType | Type [get, set] |
| Gets or sets the trigger type of the command. More... | |
| Keys | Key [get] |
| Gets the keycode associated with the command. More... | |
| bool | Disabled [get, set] |
Detailed Description
Executes an action associated with a specific key
Constructor & Destructor Documentation
§ Command()
|
inlineprotected |
Initializes a new instance of the T:MidnightBlue.Command class.
- Parameters
-
key Key to associate with the command commandType Trigger or hold command
Member Function Documentation
§ Execute()
|
inline |
Executes the specific command on the entity parameter
- Parameters
-
e Entity to operate on. Optional
§ OnKeyPress()
|
protectedpure virtual |
Defines the logic to perform when operating on a given entity
- Parameters
-
e Entity to operate on
Implemented in MB2D.IO.RotateLeft, MB2D.IO.RotateRight, MB2D.IO.MoveBackward, MidnightBlue.LeaveStarSystem, MB2D.IO.MoveForward, MidnightBlue.EnterStarSystem, MB2D.IO.MoveLeft, MidnightBlue.LaunchCommand, MB2D.IO.MoveDown, MidnightBlue.LandCommand, MB2D.IO.MoveRight, MidnightBlue.MoveShip, MB2D.IO.MoveUp, MidnightBlue.MenuCommand, and MB2D.IO.ConsoleCommand.
Property Documentation
§ Key
|
get |
Gets the keycode associated with the command.
The key code
§ Type
|
getset |
Gets or sets the trigger type of the command.
The command type
The documentation for this class was generated from the following file:
- MB2D/src/Input/Command.cs
