в чем смысл цикла bool bRet do while в cocos2d-X?

В вашем примере отсутствует важная часть, которая все объясняет - реальная логика в коде. Я не эксперт по Cocos, но, насколько я вижу, он обычно используется следующим образом:

bool bRet = false;
do 
{
    CC_BREAK_IF(!conditionA); // same as  if (!conditionA) break;
    ... some code which possibly sets bRet
    CC_BREAK_IF(!conditionB);        
    ... some other code which possibly sets bRet
    CC_BREAK_IF(!conditionC);        
    ... some other code which possibly sets bRet
    bRet = true;
} while (0);
return bRet;

в этом случае он позволяет коду переходить к оператору return без необходимости прибегать к goto или вкладывать набор операторов if. Сравните это с этим:

bool bRet = false;
if (conditionA); 
{
    ... some code which possibly sets bRet
    if (conditionB)
    {
        ... some other code which possibly sets bRet
        if (conditionC);        
        {
            ... some other code which possibly sets bRet
        }
    }
}
bRet = true;

return bRet;

Я нашел обоснование на форуме Cocos2d-x.

Ранее разработчик Cocos2d-x написал код, который управлял очисткой с помощью gotos:

#define check(ret)  if(!ret) goto cleanup;

void func()
{
  bool bRet = false;

  bRet = doSomething();
  check(bRet);
  bRet = doSomethingElse();
  check(bRet);

  bRet = true;

cleanup:
  // Do clean up here

  return bRet;
}

Как видите, это действительно неприятный способ перейти к очистке в конце функции, если что-то пойдет не так. Каждый вызов функции возвращает результат, был ли он успешным или нет. Затем используется макрос check, чтобы узнать, верно ли bRet, а если нет, сразу переходит к метке cleanup.

Затем он решил избавиться от goto и заменить его на break из цикла do while:

#define CC_BREAK_IF(cond)  if(!cond) break;

void func()
{
  bool bRet = false;

  do {
    bRet = doSomething();
    CC_BREAK_IF(bRet);
    bRet = doSomethingElse();
    CC_BREAK_IF(bRet);

    bRet = true;
  } while (0);

  // Do clean up here

  return bRet;
}

Это имеет точно такой же эффект. Он просто использует break как механизм goto для перехода к коду после цикла do while.

Нет смысла, это просто плохой стиль. Весь метод можно (и нужно) переписать так:

bool GameScene::init()
{
    CCLog("GameScene::init");

    if (!CCLayer::init())
        return false;

    // Initialize the parent - gets the sprite sheet loaded, sets the background and inits the clouds
    MainScene::init();

    // … lots of scene setup code here ...

    return true;
}

Я видел похожий код, в котором движок выполняет свой основной цикл, но в этом случае это будет бесконечный цикл:

do
{
    // run game loop as fast as it can

    // end the game
    if (userQuits)
        break;
} while(true);

Даже если вам нужна дополнительная область видимости, например, чтобы избежать конфликтов имен локальных переменных, пары дополнительных фигурных скобок будет достаточно. Вот так:

{
    int x = 10;
    // do stuff
}
{
    int x = 234; // this x is in its own scope
    // do other stuff
}