console_commands.rst 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. Console commands
  2. ================
  3. The following are commands that can be typed in the Console tab. In order for a
  4. command to be interpreted as such, you must prefix it with a colon symbol when
  5. entering it in the command prompt:
  6. .. image:: images/console_command.png
  7. game
  8. ----
  9. Pause/resume the game. Accepts one of the following parameters:
  10. ``pause``
  11. Pause the game.
  12. ``resume``
  13. Resume the game.
  14. help
  15. ----
  16. List all commands.
  17. unpause
  18. -------
  19. Resume the engine. Deprecated, use :ref:`game` instead.
  20. pause
  21. -----
  22. Pause the engine. Deprecated, use :ref:`game` instead.
  23. graph
  24. -----
  25. Plot selected profiler data over time. The <field> parameter must be the name
  26. of a profiler record that the engine provides itself or one that you recorded
  27. via the :ref:`Profiler` API. The command accepts the following
  28. parameters:
  29. ``make <name>``
  30. Create a new graph.
  31. ``list``
  32. List all the graphs.
  33. ``range <graph> [min max]``
  34. Set the range of a graph. If the range is omitted, it will be automatically
  35. computed.
  36. ``add <graph> <field>``
  37. Add a field to a graph.
  38. ``remove <graph> <field>``
  39. Remove a field from a graph.
  40. ``hide <graph>``
  41. Hide a graph.
  42. ``show <graph>``
  43. Show a graph.
  44. ``layout <graph> <type>``
  45. Set the layout of a graph.
  46. Type can be one of: ``fill``, ``left``, ``right``, ``bottom`` or ``top``.
  47. ``color <graph> <field> <color>``
  48. Set the color of a field in a graph. Color can be specified as a 3- or
  49. 6-digits hexadecimal RGB number or can be any of: ``yellow``, ``red``, ``green``
  50. or ``blue``.
  51. ``samples <graph> <samples>``
  52. Set the number of samples to show in a graph.