Difference between revisions of "Build Configuration"

From ReflexCLI
Jump to: navigation, search
 
Line 3: Line 3:
  
 
==Enabling ReflexCLI in release builds==
 
==Enabling ReflexCLI in release builds==
If you would like to ship the game with a console then you can add the REFLEXCLI_RELEASE define to you project, with the following steps:
+
If you would like to ship the game with a console then you can add the <code>REFLEXCLI_RELEASE</code> define to you project, with the following steps:
  
 
# Open Player Settings (Edit/Project Settings/Player).
 
# Open Player Settings (Edit/Project Settings/Player).
 
# Expand "Other Settings".
 
# Expand "Other Settings".
# Add REFLEXCLI_RELEASE to the field titled "Scripting Define Symbols".
+
# Add <code>REFLEXCLI_RELEASE</code> to the field titled "Scripting Define Symbols".
  
 
Note that most of the provided commands will be disabled in release builds, to prevent debug functionality reaching players. You can therefore control more precisely what commands players have access to. See individual [[:Category:Command Library|command definitions]] for details.
 
Note that most of the provided commands will be disabled in release builds, to prevent debug functionality reaching players. You can therefore control more precisely what commands players have access to. See individual [[:Category:Command Library|command definitions]] for details.

Latest revision as of 06:00, 3 September 2017

By default, almost all console functionality will be compile-time excluded from release builds (i.e. it is only available in Editor and Development Builds). Some non-functional code stubs will exist in release builds to ensure your game code can compile in release without changes.

Enabling ReflexCLI in release builds

If you would like to ship the game with a console then you can add the REFLEXCLI_RELEASE define to you project, with the following steps:

  1. Open Player Settings (Edit/Project Settings/Player).
  2. Expand "Other Settings".
  3. Add REFLEXCLI_RELEASE to the field titled "Scripting Define Symbols".

Note that most of the provided commands will be disabled in release builds, to prevent debug functionality reaching players. You can therefore control more precisely what commands players have access to. See individual command definitions for details.