Difference between revisions of "ReflexCLI"
(Created page with "Welcome to the user documentation for ReflexCLI - a powerful and extensible Command Line Interface for in-game debugging in the Unity Game Engine. ==Get Reflex== Reflex is av...") |
|||
| Line 1: | Line 1: | ||
| − | Welcome to the user documentation for ReflexCLI - a | + | Welcome to the user documentation for ReflexCLI - a reflection-based Command Line Interface for debugging in the Unity Game Engine. The goal of the tool is to provide an in-game debugging tool that is powerful and highly extensible, while requiring minimal setup and minimal modifications to game code. |
| − | ==Get | + | ==What Does it Do?== |
| − | Reflex is available on the Unity Asset Store | + | In short, you can tag methods in your code with a <code>[ConsoleCommand]</code> attribute, and these will then become available in the Reflex Console, for easy debugging. As a trivial example: |
| + | |||
| + | <pre> | ||
| + | class ConsoleTest | ||
| + | { | ||
| + | [Console Command] | ||
| + | static int MultiplyAndFloor(float a, float b) | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | would become a console command, called <code>ConsoleTest.MultiplyAndFloor</code>, that takes two floating point parameters and prints an integer return value to the console. | ||
| + | |||
| + | <b>TODO - image here</b> | ||
| + | |||
| + | ==Key Features== | ||
| + | * Simple setup and integration. | ||
| + | * Intuitive command console with suggestions, history and autocomplete. | ||
| + | * Turn almost any method, field or parameter into a command line command. | ||
| + | * Handles custom commands with arbitrary parameter lists. | ||
| + | * All code excluded from Release builds (editor/development builds only). | ||
| + | |||
| + | ==Get Started== | ||
| + | Reflex is available on the [[AssetStoreLinkNeeded|Unity Asset Store]]. Download the package into your Unity project and then follow the [[Installation|Instalation Instructions]]. | ||
Revision as of 14:36, 30 August 2017
Welcome to the user documentation for ReflexCLI - a reflection-based Command Line Interface for debugging in the Unity Game Engine. The goal of the tool is to provide an in-game debugging tool that is powerful and highly extensible, while requiring minimal setup and minimal modifications to game code.
What Does it Do?
In short, you can tag methods in your code with a [ConsoleCommand] attribute, and these will then become available in the Reflex Console, for easy debugging. As a trivial example:
class ConsoleTest
{
[Console Command]
static int MultiplyAndFloor(float a, float b)
}
would become a console command, called ConsoleTest.MultiplyAndFloor, that takes two floating point parameters and prints an integer return value to the console.
TODO - image here
Key Features
- Simple setup and integration.
- Intuitive command console with suggestions, history and autocomplete.
- Turn almost any method, field or parameter into a command line command.
- Handles custom commands with arbitrary parameter lists.
- All code excluded from Release builds (editor/development builds only).
Get Started
Reflex is available on the Unity Asset Store. Download the package into your Unity project and then follow the Instalation Instructions.
