Integration Phase 1c: Setting up a World

The World is a core runtime object that contains one or more sets of NavData, and other dynamic objects that use that NavData.

You can create as many Worlds as you need in your game:

• Many games need only one World at a time: for example, a first-person shooter type of game might create a single World to represent each level or scenario. When the player finishes that level or scenario and moves on to the next, the World can be destroyed and a new World created to take its place, with a different set of AI components or with different configuration values. The same World could also be used for the entire length of a game, changing its configuration and components on-the-fly.
• Alternatively, the game can host multiple simultaneous Worlds, each of which is entirely separate from all others. For example, massively multiplayer on-line games often use multiple different World instances to reflect different "shards" or "rooms". Although these multiple Worlds are not aware of each other’s existence at all, they can all access the tools and computational services provided by the BaseSystem, and can all use the same NavData without duplicating the data in memory. Worlds are thread-safe, so if you do need to use multiple Worlds in your project, you may be able to improve performance by distributing their updates over multiple threads.

When you create a World, you indicate the number of Databases the World should create and maintain. For the purposes of this tutorial, you need only one Database. Eventually, you will need to create a separate Database for each set of NavData you plan to load into the World: i.e. one for each type of character whose physical characteristics and/or movement capabilities are different enough to require its own set of NavData.

For example: [code from Tutorial_FirstIntegration.cpp]

#include "gwnavruntime/world/world.h"
...
 
class MyGameWorld
{
public:
    MyGameWorld() : m_gameFrameIdx(0), m_navWorld(KY_NULL) {}
    bool Initialize(bool doVisualDebugTutorial);
    void Update(float deltaTimeInSeconds);
    void Destroy();

    ...

public: // internal
    KyUInt32               m_gameFrameIdx;
    Kaim::Ptr<Kaim::World> m_navWorld;
    ...
};
 
bool MyGameWorld::Initialize(bool doVisualDebugTutorial)
{
    ...
    const KyUInt32 databaseCount = 1;
    m_navWorld = *KY_NEW Kaim::World(databaseCount);
    ...
}
 
void MyGameWorld::Update(float deltaTimeInSeconds)
{
    ...
    UpdateLogic(deltaTimeInSeconds);
    
    UpdateNavigation(deltaTimeInSeconds);
    
    UpdatePhysics(deltaTimeInSeconds);
    ...
}
 
void MyGameWorld::Destroy()
{
    ...
    m_navWorld = KY_NULL;
}
...
 
class MyGame
{
public:
    bool Initialize(bool doVisualDebugTutorial);
    void Update(float deltaTimeInSeconds);
    void Destroy();
    ... 

protected:
    MyGameWorld m_world;
};

bool MyGame::Initialize(bool doVisualDebugTutorial)
{
    ...
    return m_world.Initialize(doVisualDebugTutorial);
}

...

void MyGame::Update(float deltaTimeInSeconds)
{
    m_world.Update(deltaTimeInSeconds);
}

void MyGame::Destroy()
{
    m_world.Destroy();
    ...
}