TransportMgr.cpp

Go to the documentation of this file.

/*
* This file is part of Project SkyFire https://www.projectskyfire.org.
* See LICENSE.md file for Copyright information
*/
 
#include "InstanceScript.h"
#include "LegacyTransportSupport.h"
#include "MapManager.h"
#include "MoveSpline.h"
#include "ObjectMgr.h"
#include "ScriptMgr.h"
#include "Transport.h"
#include "TransportMgr.h"
 
TransportTemplate::~TransportTemplate()
{
    // Collect shared pointers into a set to avoid deleting the same memory more than once
    std::set<TransportSpline*> splines;
    for (size_t i = 0; i < keyFrames.size(); ++i)
        splines.insert(keyFrames[i].Spline);
 
    for (std::set<TransportSpline*>::iterator itr = splines.begin(); itr != splines.end(); ++itr)
        delete* itr;
}
 
TransportMgr::TransportMgr() { }
 
TransportMgr::~TransportMgr() { }
 
void TransportMgr::Unload()
{
    _transportTemplates.clear();
}
 
uint32 TransportMgr::GetLocalTransportEntry(uint32 entry) const
{
    return LegacyTransport::GetClientEntryForDbEntry(entry);
}
 
void TransportMgr::LoadTransportTemplates()
{
    uint32 oldMSTime = getMSTime();
 
    QueryResult result = WorldDatabase.Query("SELECT entry FROM gameobject_template WHERE type = 15 ORDER BY entry ASC");
 
    if (!result)
    {
        SF_LOG_INFO("server.loading", ">> Loaded 0 transport templates. DB table `gameobject_template` has no transports!");
        return;
    }
 
    uint32 count = 0;
 
    do
    {
        Field* fields = result->Fetch();
        uint32 entry = fields[0].GetUInt32();
        GameObjectTemplate const* goInfo = sObjectMgr->GetGameObjectTemplate(entry);
        if (goInfo->moTransport.taxiPathId >= sTaxiPathNodesByPath.size())
        {
            SF_LOG_ERROR("sql.sql", "Transport %u (name: %s) has an invalid path specified in `gameobject_template`.`data0` (%u) field, skipped.", entry, goInfo->name.c_str(), goInfo->moTransport.taxiPathId);
            continue;
        }
 
        // paths are generated per template, saves us from generating it again in case of instanced transports
        TransportTemplate& transport = _transportTemplates[entry];
        transport.entry = entry;
        GeneratePath(goInfo, &transport);
 
        // transports in instance are only on one map
        if (transport.inInstance)
            _instanceTransports[*transport.mapsUsed.begin()].insert(entry);
 
        ++count;
    } while (result->NextRow());
 
    SF_LOG_INFO("server.loading", ">> Loaded %u transport templates in %u ms", count, GetMSTimeDiffToNow(oldMSTime));
}
 
void TransportMgr::GeneratePath(GameObjectTemplate const* goInfo, TransportTemplate* transport)
{
    uint32 pathId = goInfo->moTransport.taxiPathId;
    TaxiPathNodeList const& path = sTaxiPathNodesByPath[pathId];
    std::vector<KeyFrame>& keyFrames = transport->keyFrames;
    Movement::PointsArray splinePath;
    bool mapChange = false;
    bool cyclic = true;
    for (size_t i = 0; i < path.size(); ++i)
    {
        if (!mapChange)
        {
            TaxiPathNodeEntry const& node_i = path[i];
            if (i != path.size() - 1 && (node_i.actionFlag == 1 || node_i.mapid != path[i + 1].mapid))
            {
                cyclic = false;
                keyFrames.back().Teleport = true;
                mapChange = true;
            }
            else
            {
                KeyFrame k(node_i);
                keyFrames.push_back(k);
                splinePath.push_back(G3D::Vector3(node_i.x, node_i.y, node_i.z));
                transport->mapsUsed.insert(k.Node->mapid);
            }
        }
        else
            mapChange = false;
    }
 
    // Not sure if data8 means the transport can be stopped or that its path in dbc does not contain extra spline points
    if (!goInfo->moTransport.canBeStopped && splinePath.size() >= 2)
    {
        // Remove special catmull-rom spline points
        splinePath.erase(splinePath.begin());
        keyFrames.erase(keyFrames.begin());
        splinePath.pop_back();
        keyFrames.pop_back();
        // Cyclic spline has one more extra point
        if (cyclic && !splinePath.empty())
        {
            splinePath.pop_back();
            keyFrames.pop_back();
        }
    }
 
    ASSERT(!keyFrames.empty());
 
    if (transport->mapsUsed.size() > 1)
    {
        for (std::set<uint32>::const_iterator itr = transport->mapsUsed.begin(); itr != transport->mapsUsed.end(); ++itr)
            ASSERT(!sMapStore.LookupEntry(*itr)->Instanceable());
 
        transport->inInstance = false;
    }
    else
        transport->inInstance = sMapStore.LookupEntry(*transport->mapsUsed.begin())->Instanceable();
 
    // last to first is always "teleport", even for closed paths
    keyFrames.back().Teleport = true;
 
    const float speed = float(goInfo->moTransport.moveSpeed);
    const float accel = float(goInfo->moTransport.accelRate);
    const float accel_dist = 0.5f * speed * speed / accel;
 
    transport->accelTime = speed / accel;
    transport->accelDist = accel_dist;
 
    int32 firstStop = -1;
    int32 lastStop = -1;
 
    // first cell is arrived at by teleportation :S
    keyFrames[0].DistFromPrev = 0;
    keyFrames[0].Index = 1;
    if (keyFrames[0].IsStopFrame())
    {
        firstStop = 0;
        lastStop = 0;
    }
 
    // find the rest of the distances between key points
    // Every path segment has its own spline
    if (cyclic)
    {
        TransportSpline* spline = new TransportSpline();
        spline->init_cyclic_spline(&splinePath[0], splinePath.size(), Movement::SplineBase::ModeCatmullrom, 0);
        spline->initLengths();
        keyFrames[0].DistFromPrev = spline->length(spline->last() - 2, spline->last() - 1);
        keyFrames[0].Spline = spline;
        for (size_t i = 0; i < keyFrames.size(); ++i)
        {
            keyFrames[i].Index = i + 1;
            keyFrames[i].DistFromPrev = spline->length(i, i + 1);
            if (i > 0)
                keyFrames[i - 1].NextDistFromPrev = keyFrames[i].DistFromPrev;
            keyFrames[i].Spline = spline;
            if (keyFrames[i].IsStopFrame())
            {
                // remember first stop frame
                if (firstStop == -1)
                    firstStop = i;
                lastStop = i;
            }
        }
    }
    else
    {
        size_t start = 0;
        for (size_t i = 1; i < keyFrames.size(); ++i)
        {
            if (keyFrames[i - 1].Teleport || i + 1 == keyFrames.size())
            {
                size_t extra = !keyFrames[i - 1].Teleport ? 1 : 0;
                TransportSpline* spline = new TransportSpline();
                spline->init_spline(&splinePath[start], i - start + extra, Movement::SplineBase::ModeCatmullrom);
                spline->initLengths();
                for (size_t j = start; j < i + extra; ++j)
                {
                    keyFrames[j].Index = j - start + 1;
                    keyFrames[j].DistFromPrev = spline->length(j - start, j + 1 - start);
                    if (j > 0)
                        keyFrames[j - 1].NextDistFromPrev = keyFrames[j].DistFromPrev;
                    keyFrames[j].Spline = spline;
                }
 
                if (keyFrames[i - 1].Teleport)
                {
                    keyFrames[i].Index = i - start + 1;
                    keyFrames[i].DistFromPrev = 0.0f;
                    keyFrames[i - 1].NextDistFromPrev = 0.0f;
                    keyFrames[i].Spline = spline;
                }
 
                start = i;
            }
 
            if (keyFrames[i].IsStopFrame())
            {
                // remember first stop frame
                if (firstStop == -1)
                    firstStop = i;
                lastStop = i;
            }
        }
    }
 
    keyFrames.back().NextDistFromPrev = keyFrames.front().DistFromPrev;
 
    if (firstStop == -1 || lastStop == -1)
        firstStop = lastStop = 0;
 
    // at stopping keyframes, we define distSinceStop == 0,
    // and distUntilStop is to the next stopping keyframe.
    // this is required to properly handle cases of two stopping frames in a row (yes they do exist)
    float tmpDist = 0.0f;
    for (size_t i = 0; i < keyFrames.size(); ++i)
    {
        int32 j = (i + lastStop) % keyFrames.size();
        if (keyFrames[j].IsStopFrame() || j == lastStop)
            tmpDist = 0.0f;
        else
            tmpDist += keyFrames[j].DistFromPrev;
        keyFrames[j].DistSinceStop = tmpDist;
    }
 
    tmpDist = 0.0f;
    for (int32 i = int32(keyFrames.size()) - 1; i >= 0; i--)
    {
        int32 j = (i + firstStop) % keyFrames.size();
        tmpDist += keyFrames[(j + 1) % keyFrames.size()].DistFromPrev;
        keyFrames[j].DistUntilStop = tmpDist;
        if (keyFrames[j].IsStopFrame() || j == firstStop)
            tmpDist = 0.0f;
    }
 
    for (size_t i = 0; i < keyFrames.size(); ++i)
    {
        float total_dist = keyFrames[i].DistSinceStop + keyFrames[i].DistUntilStop;
        if (total_dist < 2 * accel_dist) // won't reach full speed
        {
            if (keyFrames[i].DistSinceStop < keyFrames[i].DistUntilStop) // is still accelerating
            {
                // calculate accel+brake time for this short segment
                float segment_time = 2.0f * sqrt((keyFrames[i].DistUntilStop + keyFrames[i].DistSinceStop) / accel);
                // substract acceleration time
                keyFrames[i].TimeTo = segment_time - sqrt(2 * keyFrames[i].DistSinceStop / accel);
            }
            else // slowing down
                keyFrames[i].TimeTo = sqrt(2 * keyFrames[i].DistUntilStop / accel);
        }
        else if (keyFrames[i].DistSinceStop < accel_dist) // still accelerating (but will reach full speed)
        {
            // calculate accel + cruise + brake time for this long segment
            float segment_time = (keyFrames[i].DistUntilStop + keyFrames[i].DistSinceStop) / speed + (speed / accel);
            // substract acceleration time
            keyFrames[i].TimeTo = segment_time - sqrt(2 * keyFrames[i].DistSinceStop / accel);
        }
        else if (keyFrames[i].DistUntilStop < accel_dist) // already slowing down (but reached full speed)
            keyFrames[i].TimeTo = sqrt(2 * keyFrames[i].DistUntilStop / accel);
        else // at full speed
            keyFrames[i].TimeTo = (keyFrames[i].DistUntilStop / speed) + (0.5f * speed / accel);
    }
 
    // calculate tFrom times from tTo times
    float segmentTime = 0.0f;
    for (size_t i = 0; i < keyFrames.size(); ++i)
    {
        int32 j = (i + lastStop) % keyFrames.size();
        if (keyFrames[j].IsStopFrame() || j == lastStop)
            segmentTime = keyFrames[j].TimeTo;
        keyFrames[j].TimeFrom = segmentTime - keyFrames[j].TimeTo;
    }
 
    // calculate path times
    keyFrames[0].ArriveTime = 0;
    float curPathTime = 0.0f;
    if (keyFrames[0].IsStopFrame())
    {
        curPathTime = float(keyFrames[0].Node->delay);
        keyFrames[0].DepartureTime = uint32(curPathTime * float(IN_MILLISECONDS));
    }
 
    for (size_t i = 1; i < keyFrames.size(); ++i)
    {
        curPathTime += keyFrames[i - 1].TimeTo;
        if (keyFrames[i].IsStopFrame())
        {
            keyFrames[i].ArriveTime = uint32(curPathTime * float(IN_MILLISECONDS));
            keyFrames[i - 1].NextArriveTime = keyFrames[i].ArriveTime;
            curPathTime += float(keyFrames[i].Node->delay);
            keyFrames[i].DepartureTime = uint32(curPathTime * float(IN_MILLISECONDS));
        }
        else
        {
            curPathTime -= keyFrames[i].TimeTo;
            keyFrames[i].ArriveTime = uint32(curPathTime * float(IN_MILLISECONDS));
            keyFrames[i - 1].NextArriveTime = keyFrames[i].ArriveTime;
            keyFrames[i].DepartureTime = keyFrames[i].ArriveTime;
        }
    }
 
    keyFrames.back().NextArriveTime = keyFrames.back().DepartureTime;
 
    transport->pathTime = keyFrames.back().DepartureTime;
}
 
void TransportMgr::AddPathNodeToTransport(uint32 transportEntry, uint32 timeSeg, TransportAnimationEntry const* node)
{
    TransportAnimation& animNode = _transportAnimations[transportEntry];
    if (animNode.TotalTime < timeSeg)
        animNode.TotalTime = timeSeg;
 
    animNode.Path[timeSeg] = node;
}
 
Transport* TransportMgr::CreateLocalTransport(uint32 guid, Map* map)
{
    GameObjectData const* data = sObjectMgr->GetGOData(guid);
    if (!data)
    {
        SF_LOG_ERROR("entities.transport", "Local transport with guid %u will not be loaded, `gameobject` data is missing", guid);
        return NULL;
    }
 
    uint32 const entry = GetLocalTransportEntry(data->id);
    LegacyTransport::LegacyTransportSpawnDiagnostic diagnostic = { guid, data->id, entry, map->GetId(), map->GetSpawnMode(), data->posX, data->posY, data->posZ, data->orientation, 0, 0 };
    if (!LegacyTransport::IsAllowedOnMap(data->id, map->GetId(), map->GetSpawnMode()))
        return NULL;
 
    if (TransportAnimation const* animationInfo = GetTransportAnimInfo(entry))
    {
        diagnostic.AnimTime = animationInfo->TotalTime;
        diagnostic.AnimNodes = uint32(animationInfo->Path.size());
        LegacyTransport::LogCreateAttempt(diagnostic);
    }
    else
        LegacyTransport::LogMissingCreateAnimationData(guid, data->id, entry);
 
    Transport* transport = new Transport();
    if (!transport->CreateLocal(guid, entry, map, data->posX, data->posY, data->posZ, data->orientation,
        data->rotation0, data->rotation1, data->rotation2, data->rotation3, data->animprogress))
    {
        LegacyTransport::LogCreateFailure(diagnostic);
        delete transport;
        return NULL;
    }
 
    ASSERT(transport->GetMap()->AddToMap<Transport>(transport));
    diagnostic.X = transport->GetPositionX();
    diagnostic.Y = transport->GetPositionY();
    diagnostic.Z = transport->GetPositionZ();
    diagnostic.O = transport->GetOrientation();
    LegacyTransport::LogCreateSuccess(diagnostic, transport->GetGUID(), uint32(GUID_HIPART(transport->GetGUID())), uint32(GUID_LOPART(transport->GetGUID())),
        transport->GetTimer(), transport->GetTransportPeriod(), uint32(transport->GetGoState()), uint32(transport->GetGoType()),
        transport->GetUInt32Value(OBJECT_FIELD_DYNAMIC_FLAGS));
    return transport;
}
 
Transport* TransportMgr::CreateLocalTransport(uint32 entry, Map* map, float x, float y, float z, float o, uint32 animprogress)
{
    Transport* transport = new Transport();
    if (!transport->CreateLocal(0, entry, map, x, y, z, o, 0.0f, 0.0f, 0.0f, 1.0f, animprogress))
    {
        delete transport;
        return NULL;
    }
 
    ASSERT(transport->GetMap()->AddToMap<Transport>(transport));
    return transport;
}
 
Transport* TransportMgr::CreateTransport(uint32 entry, uint32 guid /*= 0*/, Map* map /*= NULL*/)
{
    // instance case, execute GetGameObjectEntry hook
    if (map)
    {
        // SetZoneScript() is called after adding to map, so fetch the script using map
        if (map->IsInstance())
            if (InstanceScript* instance = static_cast<InstanceMap*>(map)->GetInstanceScript())
                entry = instance->GetGameObjectEntry(0, entry);
 
        if (!entry)
            return NULL;
    }
 
    TransportTemplate const* tInfo = GetTransportTemplate(entry);
    if (!tInfo)
    {
        SF_LOG_ERROR("sql.sql", "Transport %u will not be loaded, `transport_template` missing", entry);
        return NULL;
    }
 
    // create transport...
    Transport* trans = new Transport();
 
    // ...at first waypoint
    TaxiPathNodeEntry const* startNode = tInfo->keyFrames.begin()->Node;
    uint32 mapId = startNode->mapid;
    float x = startNode->x;
    float y = startNode->y;
    float z = startNode->z;
    float o = 0.0f;
 
    // initialize the gameobject base
    uint32 guidLow = guid ? guid : sObjectMgr->GenerateLowGuid(HIGHGUID_MO_TRANSPORT);
    if (!trans->Create(guidLow, entry, mapId, x, y, z, o, 255))
    {
        delete trans;
        return NULL;
    }
 
    if (MapEntry const* mapEntry = sMapStore.LookupEntry(mapId))
    {
        if (mapEntry->Instanceable() != tInfo->inInstance)
        {
            SF_LOG_ERROR("entities.transport", "Transport %u (name: %s) attempted creation in instance map (id: %u) but it is not an instanced transport!", entry, trans->GetName().c_str(), mapId);
            delete trans;
            return NULL;
        }
    }
 
    // use preset map for instances (need to know which instance)
    trans->SetMap(map ? map : sMapMgr->CreateMap(mapId, NULL));
    if (map && map->IsInstance())
        trans->m_zoneScript = map->ToInstanceMap()->GetInstanceScript();
 
    // Passengers will be loaded once a player is near
 
    trans->GetMap()->AddToMap<Transport>(trans);
    return trans;
}
 
void TransportMgr::SpawnContinentTransports()
{
    if (_transportTemplates.empty())
        return;
 
    uint32 oldMSTime = getMSTime();
 
    QueryResult result = WorldDatabase.Query("SELECT guid, entry FROM transports");
 
    uint32 count = 0;
    if (result)
    {
        do
        {
            Field* fields = result->Fetch();
            uint32 guid = fields[0].GetUInt32();
            uint32 entry = fields[1].GetUInt32();
 
            if (TransportTemplate const* tInfo = GetTransportTemplate(entry))
                if (!tInfo->inInstance)
                    if (CreateTransport(entry, guid))
                        ++count;
        } while (result->NextRow());
    }
 
    SF_LOG_INFO("server.loading", ">> Spawned %u continent transports in %u ms", count, GetMSTimeDiffToNow(oldMSTime));
}
 
void TransportMgr::CreateInstanceTransports(Map* map)
{
    TransportInstanceMap::const_iterator mapTransports = _instanceTransports.find(map->GetId());
 
    // no transports here
    if (mapTransports == _instanceTransports.end() || mapTransports->second.empty())
        return;
 
    // create transports
    for (std::set<uint32>::const_iterator itr = mapTransports->second.begin(); itr != mapTransports->second.end(); ++itr)
        CreateTransport(*itr, 0, map);
}
 
void TransportMgr::SpawnLocalTransports(Map* map)
{
    TransportInstanceMap::const_iterator itr = _localTransportSpawns.find(MAKE_PAIR32(map->GetId(), map->GetSpawnMode()));
    if (itr == _localTransportSpawns.end())
    {
        LegacyTransport::LogNoRegisteredSpawns(map->GetId(), map->GetSpawnMode());
        return;
    }
 
    LegacyTransport::LogSpawnCount(uint32(itr->second.size()), map->GetId(), map->GetSpawnMode());
    for (std::set<uint32>::const_iterator guidItr = itr->second.begin(); guidItr != itr->second.end(); ++guidItr)
        CreateLocalTransport(*guidItr, map);
}
 
TransportAnimationEntry const* TransportAnimation::GetAnimNode(uint32 time) const
{
    if (Path.empty())
        return NULL;
 
    for (TransportPathContainer::const_reverse_iterator itr2 = Path.rbegin(); itr2 != Path.rend(); ++itr2)
        if (time >= itr2->first)
            return itr2->second;
 
    return Path.begin()->second;
}
 
TransportAnimationEntry const* TransportAnimation::GetPrevAnimNode(uint32 time) const
{
    if (Path.empty())
        return NULL;
 
    TransportPathContainer::const_iterator itr = Path.lower_bound(time);
    if (itr != Path.begin())
    {
        --itr;
        return itr->second;
    }
 
    return Path.rbegin()->second;
}
 
TransportAnimationEntry const* TransportAnimation::GetNextAnimNode(uint32 time) const
{
    if (Path.empty())
        return NULL;
 
    TransportPathContainer::const_iterator itr = Path.lower_bound(time);
    if (itr != Path.end())
        return itr->second;
 
    return Path.begin()->second;
}
 
G3D::Quat TransportAnimation::GetAnimRotation(uint32 time) const
{
    if (Rotations.empty())
        return G3D::Quat(0.0f, 0.0f, 0.0f, 1.0f);
 
    TransportRotationEntry const* rot = Rotations.begin()->second;
    for (TransportPathRotationContainer::const_reverse_iterator itr2 = Rotations.rbegin(); itr2 != Rotations.rend(); ++itr2)
    {
        if (time >= itr2->first)
        {
            rot = itr2->second;
            break;
        }
    }
 
    return G3D::Quat(rot->X, rot->Y, rot->Z, rot->W);
}