Conventions

In this book, you will find a number of text styles that distinguish between different kinds of information. Here are some examples of these styles and an explanation of their meaning.

Code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles are shown as follows: "I’m going to update the ChasePlayerComponent class that already exists in the EngineTest project."

A block of code is set as follows:

class Animal
{
  public:
    virtual void Speak(void) const //virtual in the base class
    {
      //Using the Mach 5 console print
      M5DEBUG_PRINT("...\n");
    }
};

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

class StaticExamples
{
  public:
    static float classVariable;

    static void StaticFunction()
    {
      // Note, can only use static variables and functions within 
      // static function
      std::string toDisplay = "\n I can be called anywhere! 
      classVariable value: " + 
      std::to_string(classVariable);

      printf(toDisplay.c_str());
    }

    void InFunction()
    {
      static int enemyCount = 0;

      // Increase the value of enemyCount
      enemyCount += 10;

      std::string toDisplay = "\n Value of enemyCount: " + 
      std::to_string(enemyCount);

      printf(toDisplay.c_str());
   }
};

New terms and important words are shown in bold. Words that you see on the screen, for example, in menus or dialog boxes, appear in the text like this: "In order to download new modules, we will go to Files | Settings | Project Name | Project Interpreter."

Warnings or important notes appear in a box like this.

Tips and tricks appear like this.