transport.c

Go to the documentation of this file.

class TransportType : EntityAIType
{
 
};
 
#ifdef FEATURE_NETWORK_RECONCILIATION
 
class TransportOwnerState : PawnOwnerState
{
    proto native void   SetWorldTransform(vector transform[4]);
    proto native void   GetWorldTransform(out vector transform[4]);
 
    proto native void   SetLinearVelocity(vector value);
    proto native void   GetLinearVelocity(out vector value);
 
    proto native void   SetAngularVelocity(vector value);
    proto native void   GetAngularVelocity(out vector value);
    
    proto native void   SetBuoyancySubmerged(float value);
    proto native float  GetBuoyancySubmerged();
 
#ifdef DIAG_DEVELOPER
    override event void GetTransform(inout vector transform[4])
    {
        GetWorldTransform(transform);
    }
#endif
};
 
class TransportMove : PawnMove
{
    proto native void   SetWorldTransform(vector transform[4]);
    proto native void   GetWorldTransform(out vector transform[4]);
 
    proto native void   SetLinearVelocity(vector value);
    proto native void   GetLinearVelocity(out vector value);
 
    proto native void   SetAngularVelocity(vector value);
    proto native void   GetAngularVelocity(out vector value);
    
#ifdef DIAG_DEVELOPER
    override event void GetTransform(inout vector transform[4])
    {
        GetWorldTransform(transform);
    }
#endif
};

class Transport extends Pawn
#else
class Transport extends EntityAI
#endif
{
    private static ref VehicleFlippedContext m_FlippedContext;
    
    ref TIntArray m_SingleUseActions;
    ref TIntArray m_ContinuousActions;
    ref TIntArray m_InteractActions;
    
    protected bool m_EngineZoneReceivedHit;
    protected vector m_fuelPos;
    
    protected ref set<int> m_UnconsciousCrewMemberIndices;
    protected ref set<int> m_DeadCrewMemberIndices;
    
    void Transport()
    {
        RegisterNetSyncVariableBool("m_EngineZoneReceivedHit");
        
        if ( MemoryPointExists("refill") )
            m_fuelPos = GetMemoryPointPos("refill");
        else
            m_fuelPos = "0 0 0";
        
        m_UnconsciousCrewMemberIndices  = new set<int>();
        m_DeadCrewMemberIndices         = new set<int>();
    }
    
    override void EEHitBy(TotalDamageResult damageResult, int damageType, EntityAI source, int component, string dmgZone, string ammo, vector modelPos, float speedCoef)
    {
        super.EEHitBy(damageResult, damageType, source, component, dmgZone, ammo, modelPos, speedCoef);
 
        SetEngineZoneReceivedHit(dmgZone == "Engine");
    }
 
    override int GetMeleeTargetType()
    {
        return EMeleeTargetType.NONALIGNABLE;
    }

    protected override event typename GetOwnerStateType()
    {
        return TransportOwnerState;
    }

    protected override event typename GetMoveType()
    {
        return TransportMove;
    }

    proto native void Synchronize();

    proto native int CrewSize();

    proto native int CrewPositionIndex( int componentIdx );

    proto native int CrewMemberIndex( Human player );

    proto native Human CrewMember( int posIdx );

    proto native Human CrewDriver();

    proto void CrewEntry( int posIdx, out vector pos, out vector dir );

    proto void CrewEntryWS( int posIdx, out vector pos, out vector dir );

    proto void CrewTransform( int posIdx, out vector mat[4] );

    proto void CrewTransformWS( int posIdx, out vector mat[4] );

    proto native void CrewGetIn( Human player, int posIdx );

    proto native Human CrewGetOut( int posIdx );
    
    proto native void CrewDeath( int posIdx );

    void OnDriverEnter(Human player) {}

    void OnDriverExit(Human player) {}

    proto native bool LightIsOn();

    proto native void LightOn();

    proto native void LightOff();

    proto native void LightToggle();

    bool OnBeforeLightOn()
    {
        // light can turn on by default
        return true;
    }

    void OnUpdateLight()
    {
        UpdateLights();
    }
    

    proto void ApplyForce(vector force);

    proto void ApplyTorque(vector force);

    proto void ApplyForceAt(vector pos, vector force);

    proto void ApplyCentralImpulse(vector centralImpulse);

    proto void ApplyTorqueImpulse(vector torqueImpulse);
    
    proto void ApplyImpulseAt(vector pos, vector force);
    

    proto native int Random();
        
    proto native float RandomRange(int pRange);

    proto native float Random01();

    float RandomFloat(float min, float max)
    {
        return Random01() * (max - min) + min;
    }

    void OnContact(string zoneName, vector localPos, IEntity other, Contact data) {}

    void OnInput(float dt) {}

    void OnUpdate(float dt) {}
 
    // Scripted function
    void UpdateLights(int new_gear = -1) {}
 
    override bool IsTransport()
    {
        return true;
    }
    
    override bool IsIgnoredByConstruction()
    {
        return false;
    }
    
    override bool IsHealthVisible()
    {
        return true;
    }
 
    override bool ShowZonesHealth()
    {
        return true;
    }
 
    override int GetHideIconMask()
    {
        return EInventoryIconVisibility.HIDE_VICINITY;
    }
    
    float GetMomentum()
    {
        return GetVelocity(this).Length() * dBodyGetMass(this);
    }
    
    bool IsVitalSparkPlug()
    {
        return true;
    }
    
    string GetVehicleType()
    {
        return "VehicleTypeUndefined";
    }
    
    string GetActionCompNameFuel()
    {
        return "refill";
    }
    
    float GetActionDistanceFuel()
    {
        return 1.5;
    }
    
    vector GetRefillPointPosWS()
    {
        return ModelToWorld( m_fuelPos );
    }
    
    protected /*sealed*/ VehicleFlippedContext GetFlipContext()
    {
        if (!m_FlippedContext)
        {
            m_FlippedContext = new VehicleFlippedContext();
        }
 
#ifdef DIAG_DEVELOPER
        m_FlippedContext.Reset(DiagMenu.GetBool(DiagMenuIDs.VEHICLE_DRAW_FLIP_CONTEXT));
#endif
        
        return m_FlippedContext;
    }
    
    protected bool DetectFlippedUsingSurface(VehicleFlippedContext ctx, float angleTolerance)
    {
        vector corners[4];
        GetTightlyPackedCorners(ETransformationAxis.BOTTOM, corners);
        
        // compute the average position to find the lowest "center-most" position
        vector avgPosition = vector.Zero;       
        for (int i = 0; i < 4; i++)
        {           
            avgPosition = avgPosition + corners[i];
        }
        
        avgPosition = avgPosition * 0.25;
        
        // get depth of the water to determine if we should use the roadway surface normal or just up vector
        float depth = g_Game.GetWaterDepth(avgPosition);
        
        vector normal = vector.Up;
        vector dirUp = GetDirectionUp();
        
        bool testLand = depth < -1.0;
        
        // iterate over the corners to find the average normal
        if (testLand)
        {
            // trace roadway, incase the vehicle is on a rock, or bridge
            ctx.m_SurfaceParams.type = SurfaceDetectionType.Roadway;
            
            // ignore expensive water computation, we already know we are above land
            ctx.m_SurfaceParams.includeWater = false;
            
            // ignore this vehicle, it may have a roadway LOD
            ctx.m_SurfaceParams.ignore = this;
            
            // detect closest to the given point
            ctx.m_SurfaceParams.rsd = RoadSurfaceDetection.CLOSEST;
            
            for (i = 0; i < 4; i++)
            {
                ctx.m_SurfaceParams.position = corners[i];
                
                g_Game.GetSurface(ctx.m_SurfaceParams, ctx.m_SurfaceResult);
                
                corners[i][1] = ctx.m_SurfaceResult.height;
            }
            
            vector d0 = vector.Direction(corners[0], corners[1]);
            vector d1 = vector.Direction(corners[0], corners[2]);
            
            d0.Normalize();
            d1.Normalize();
            
            // cross product the two directions to get the normal vector of the land
            normal = d0 * d1;
        }
                
        bool isFlipped = vector.Dot(normal, dirUp) < Math.Cos(angleTolerance * Math.DEG2RAD);
        
#ifdef DIAG_DEVELOPER
        if (ctx.IsDebug())
        {
            int color = 0xFF00FF00;
            if (isFlipped)
                color = 0xFFFF0000;
            
            ctx.AddShape(Shape.Create(ShapeType.LINE, color, ShapeFlags.NOZBUFFER, corners[0], corners[0] + normal));
            ctx.AddShape(Shape.Create(ShapeType.LINE, color, ShapeFlags.NOZBUFFER, corners[1], corners[1] + normal));
            ctx.AddShape(Shape.Create(ShapeType.LINE, color, ShapeFlags.NOZBUFFER, corners[2], corners[2] + normal));
            ctx.AddShape(Shape.Create(ShapeType.LINE, color, ShapeFlags.NOZBUFFER, corners[3], corners[3] + normal));
        }
#endif
        
        return isFlipped;
    }
    
    protected bool DetectFlipped(VehicleFlippedContext ctx)
    {
        return false;
    }
    
    /*sealed*/ bool IsFlipped()
    {
        VehicleFlippedContext ctx = GetFlipContext();
        ctx.m_bIsAction = false;
        ctx.m_ActionPlayer = null;
        return DetectFlipped(ctx);
    }
    
    /*sealed*/ bool IsActionFlipped(Man player)
    {
        VehicleFlippedContext ctx = GetFlipContext();
        ctx.m_bIsAction = true;
        ctx.m_ActionPlayer = player;
        return DetectFlipped(ctx);
    }
    
    bool IsAnyCrewPresent()
    {
        for (int index = 0; index < CrewSize(); ++index)
        {
            if (CrewMember(index) != null)
                return true;
        }
        
        return false;
    }
    
    float GetTransportCameraDistance()
    {
        return 4.0;
    }
    
    void MarkCrewMemberUnconscious(int crewMemberIndex);    
    void MarkCrewMemberDead(int crewMemberIndex);
 
    vector GetTransportCameraOffset()
    {
        return "0 1.3 0";
    }
    
    int GetAnimInstance()
    {
#ifndef CFGMODS_DEFINE_TEST
        Error("GetAnimInstance() not implemented");
        return 0;
#else
        return 2;
#endif
    }
 
    int GetSeatAnimationType( int posIdx )
    {
#ifndef CFGMODS_DEFINE_TEST
        Error("GetSeatAnimationType() not implemented");
#endif
        return 0;
    }
 
    int Get3rdPersonCameraType()
    {
#ifndef CFGMODS_DEFINE_TEST
        Error("Get3rdPersonCameraType() not implemented");
        return 0;
#else
        return 31;
#endif
    }
    
    bool CrewCanGetThrough( int posIdx )
    {
#ifndef CFGMODS_DEFINE_TEST
        return false;
#else
        return true;
#endif
    }
    
    bool CanReachSeatFromSeat( int currentSeat, int nextSeat )
    {
#ifndef CFGMODS_DEFINE_TEST
        return false;
#else
        return true;
#endif
    }
    
    bool CanReachSeatFromDoors( string pSeatSelection, vector pFromPos, float pDistance = 1.0 )
    {
#ifndef CFGMODS_DEFINE_TEST
        return false;
#else
        return true;
#endif  
    }
 
    bool CanReachDoorsFromSeat( string pDoorsSelection, int pCurrentSeat )
    {
#ifndef CFGMODS_DEFINE_TEST
        return false;
#else
        return true;
#endif
    }
    
    int GetSeatIndexFromDoor( string pDoorSelection )
    {
        //Potientially could be fixed some other way, currently follows the unfortunate pattern that CanReachDoorsFromSeat has created
        switch (pDoorSelection)
        {
            case "DoorsDriver":
                return 0;
                break;
            case "DoorsCoDriver":
                return 1;
                break;
            case "DoorsCargo1":
                return 2;
                break;
            case "DoorsCargo2":
                return 3;
                break;
        }
        return -1;
    }
    
    bool IsIgnoredObject( Object o )
    {
        if (!o)
            return false;

        int layer = dBodyGetInteractionLayer(o);
        bool interacts = dGetInteractionLayer(this, PhxInteractionLayers.CHARACTER, layer);
        if (!interacts)
        {
            return true;
        }
 
        DayZPlayer player;
        if (Class.CastTo(player, o))
        {
            HumanCommandVehicle hcv = player.GetCommand_Vehicle();
            if (hcv && hcv.GetTransport() == this)
            {
                return true;
            }
        }
 
        EntityAI e = EntityAI.Cast(o);          
        // CanBeSkinned means it is a dead entity which should not block the door
        return ( ( e && (e.IsZombie() || e.IsHologram()) ) || o.CanBeSkinned() || o.IsBush() || o.IsTree() );
    }
    
    void SetEngineZoneReceivedHit(bool pState)
    {
        m_EngineZoneReceivedHit = pState;
        SetSynchDirty();
    }
    
    bool HasEngineZoneReceivedHit()
    {
        return m_EngineZoneReceivedHit;
    }
 
    override void GetDebugActions(out TSelectableActionInfoArrayEx outputList)
    {
        super.GetDebugActions(outputList);
        
        outputList.Insert(new TSelectableActionInfoWithColor(SAT_DEBUG_ACTION, EActions.DELETE, "Delete", FadeColors.RED));
        if (Gizmo_IsSupported())
            outputList.Insert(new TSelectableActionInfoWithColor(SAT_DEBUG_ACTION, EActions.GIZMO_OBJECT, "Gizmo Object", FadeColors.LIGHT_GREY));
        outputList.Insert(new TSelectableActionInfoWithColor(SAT_DEBUG_ACTION, EActions.GIZMO_PHYSICS, "Gizmo Physics (SP Only)", FadeColors.LIGHT_GREY)); // intentionally allowed for testing physics desync
        outputList.Insert(new TSelectableActionInfoWithColor(SAT_DEBUG_ACTION, EActions.SEPARATOR, "___________________________", FadeColors.RED));
    }
    
    override bool OnAction(int action_id, Man player, ParamsReadContext ctx)
    {
        if (super.OnAction(action_id, player, ctx))
            return true;
 
        if (g_Game.IsClient() || !g_Game.IsMultiplayer())
        {
            switch (action_id)
            {
                case EActions.GIZMO_OBJECT:
                    if (GetGizmoApi())
                        GetGizmoApi().SelectObject(this);
                    return true;
                case EActions.GIZMO_PHYSICS:
                    if (GetGizmoApi())
                        GetGizmoApi().SelectPhysics(GetPhysics());
                    return true;
            }
        }
 
        if (g_Game.IsServer())
        {
            switch (action_id)
            {
                case EActions.DELETE:
                    Delete();
                    return true;
            }
        }
    
        return false;
    }
    
    bool IsAreaAtDoorFree( int currentSeat, float maxAllowedObjHeight, inout vector extents, out vector transform[4] )
    {
        GetTransform(transform);
        
        vector crewPos;
        vector crewDir;
        CrewEntry( currentSeat, crewPos, crewDir );
        
        vector entry[4];
        entry[2] = crewDir;
        entry[0] = vector.Up * crewDir;
        entry[1] = entry[2] * entry[0];
        entry[3] = crewPos;
        
        Math3D.MatrixMultiply4( transform, entry, transform );
        
        vector position = transform[3];
        vector orientation = Math3D.MatrixToAngles(transform);
        
        position[1] = position[1] + maxAllowedObjHeight + (extents[1] * 0.5);
        
        array<Object> excluded = new array<Object>;
        array<Object> collided = new array<Object>;
        
        excluded.Insert(this);
        
        g_Game.IsBoxColliding(position, orientation, extents, excluded, collided);
        
        orientation.RotationMatrixFromAngles(transform);
        transform[3] = position;
        
        foreach (Object o : collided)
        {
            EntityAI e = EntityAI.Cast(o);          
            if (IsIgnoredObject(o))
                continue;
            
            vector minmax[2];
            if (o.GetCollisionBox(minmax))
                return false;
        }
 
        return true;
    }
 
    bool IsAreaAtDoorFree( int currentSeat, float maxAllowedObjHeight = 0.5, float horizontalExtents = 0.5, float playerHeight = 1.7 )
    {
        vector transform[4];
        vector extents;
        
        extents[0] = horizontalExtents;
        extents[1] = playerHeight;
        extents[2] = horizontalExtents;
        
        return IsAreaAtDoorFree( currentSeat, maxAllowedObjHeight, extents, transform );
    }
    
    Shape DebugFreeAreaAtDoor( int currentSeat, float maxAllowedObjHeight = 0.5, float horizontalExtents = 0.5, float playerHeight = 1.7 )
    {
        int color = ARGB(20, 0, 255, 0);
        
        vector transform[4];
        vector extents;
        
        extents[0] = horizontalExtents;
        extents[1] = playerHeight;
        extents[2] = horizontalExtents;
        
        if (!IsAreaAtDoorFree( currentSeat, maxAllowedObjHeight, extents, transform ))
        {
            color = ARGB(20, 255, 0, 0);
        }
        
        Shape shape = Debug.DrawBox(-extents * 0.5, extents * 0.5, color);
        shape.SetMatrix(transform);
        return shape;
    }
};
 
class VehicleContactData
{
    vector m_LocalPos;
    IEntity m_Other;
    float m_Impulse;
    
    void SetData(vector localPos, IEntity other, float impulse)
    {
        m_LocalPos  = localPos;
        m_Other     = other;
        m_Impulse   = impulse;
    }
};
 
class VehicleFlippedContext
{
    bool m_bIsAction = false;
    Man m_ActionPlayer;
    
    ref SurfaceDetectionParameters m_SurfaceParams = new SurfaceDetectionParameters();
    ref SurfaceDetectionResult m_SurfaceResult = new SurfaceDetectionResult();
    
#ifdef DIAG_DEVELOPER   
    private ref array<Shape> m_DebugShapes;
    private bool m_bIsDebug;
 
    void VehicleFlippedContext()
    {
        m_DebugShapes = new array<Shape>();
    }
    
    void ~VehicleFlippedContext()
    {
        Reset();
    }
    
    void Reset(bool isDebug = false)
    {
        foreach (Shape shape : m_DebugShapes)
        {
            shape.Destroy();
        }
        
        m_DebugShapes.Clear();
        
        m_bIsDebug = isDebug;
    }
    
    void AddShape(Shape shape)
    {
        m_DebugShapes.Insert(shape);
    }
    
    bool IsDebug()
    {
        return m_bIsDebug;
    }
#endif
    
    [Obsolete("no replacement")]
    protected void HandleByCrewMemberState(ECrewMemberState state);
};