LUA_API_Vehicle.h

Go to the documentation of this file.

// |      _                   ____         __ _   
// |     / \  _   _ _ __ __ _/ ___|  ___  / _| |_ 
// |    / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
// |   / ___ \ |_| | | | (_| |___) | (_) |  _| |_ 
// |  /_/   \_\__,_|_|  \__,_|____/ \___/|_|  \__|
// | 
// |  Aurasoft UK 2008 - 2018 http://www.aurasoft.co.uk
// | 
// |  Skyline Game Engine Lua API Documentation
// | 
// |    This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
// |    This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other 
// |    person outside of the Skyline Game Engine development team.
// |    
// | © Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2018
// |

// SKYLINE LUA CLASS FOR API DOCUMENTATION

class vehicle
{
public:

    void createVehicle( string vehicleName, int sceneEntityID, float posX, float posY, float posZ, float rotW, float rotX, float rotY, float rotZ); 
    
    void destroy( int vehicleID );

    int getVehicleID( int sceneEntityID, string vehicleName );
    int getActiveVehicleID();

    void setAsPlayer( int vehicleID, int isPlayer [1 or 0] );
    int isPlayer( int vehicleID );

    void setCurrentThrottle( int vehicleID, float throttle );
    float getCurrentThrottle( int vehicleID );
    void setCurrentGear( int vehicleID, int gear );
    int getCurrentGear( int vehicleID ) ;
    int getRPM( int vehicleID ) ;

    void setNumOfChassis( int vehicleID, int chassisNum );
    void setNumberOfWheels( int vehicleID, int numWheels );
    int getNumOfChassis( int vehicleID );
    int getNumOfWheels( int vehicleID );
    void createPhyicsBody( int vehicleID );
    void addChassis( int vehicleID, int chassisIndex, float posXfloat posY, float posZ, float scaleX, float scaleY, float scaleZ );
    void addWheel( int vehicleID, int vehicleID, int wheelIndex, int driveWheel, int steerWheel, float posX, float posY, float posZ);
    void setWheelAsHandbrake( int vehicleID, int wheelIndex );
    void createWheels( int vehicleID );
    void setWheelMesh( int vehicleID, string wheelMeshName );
    string getWheelMesh( int vehicleID );
    void setWheelRadius( int vehicleID, int wheelIndex, float radius );
    float getWheelRadius( int vehicleID, int wheelIndex );
    float3 getWheelGlobalPosition( int vehicleID, int wheelIndex );
    float3 getWheelLocalPosition( int vehicleID, int wheelIndex );
    void setMaxSpeed_MPH( int vehicleID, int maxSpeedMPH );
    void setMaxSpeed_KPH( int vehicleID, int maxSpeedKPH );
    int getMaxSpeed_MPH( int vehicleID );
    int getMaxSpeed_KPH( int vehicleID );
    void setTorqueCurveSlot( int vehicleID, int rpm, int torque );
    int getSpeed_Mph( int vehicleID );
    int getSpeed_Kph( int vehicleID );
    int getVelocity( int vehicleID );

    void setLinearVelocity( int vehicleID, float x, float y, float z );
    void setAngularVelocity( int vehicleID, float x, float y, float z );
    void setLinearMomentum( int vehicleID, float x, float y, float z );
    void setAngularMomentum( int vehicleID, float x, float y, float z );
    void setLinearDamping( int vehicleID, float damp );
    void setAngularDamping( int vehicleID, float damp );

    void setInverseWheelMass( int vehicleID, int wheelIndex, float amt );
    void useAirResistance( int vehicleID, int useResistance [0 or 1] );
    void setAirResistance( int vehicleID, float baseValue, float multiplier );
    void useAntiRoll( int vehicleID, int useAntiRoll [0 or 1] );
    void setAntiRollAmount( int vehicleID, float antiRollAmt );

    void setMaxSteeringAngle( int vehicleID, float angle );
    void setSteeringCoefMulti( int vehicleID, float coeff );
    void setMotorTorque( int vehicleID, int wheelIndex, float torque );
    void setBrakeTorque( int vehicleID, int wheelIndex, float torque );
    void setPosition( int vehicleID, float posX, float posY, float posZ );
    void setOrientation( int vehicleID, float rotW, float rotX, float rotY, float rotZ );

    void setNumberOfGears( int vehicleID, int numGears );
    void setGearRatio( int vehicleID, float gearRatio );
    void setRPM( int vehicleID, int minRpmToGearDown, int maxRpmToGearUp, int minRpm, int maxRpm );
    void setMass( int vehicleID, float mass );
    void setDownforce( int vehicleID, float downforce );
    void setNoWheelsDownforce( int vehicleID, float downforce );
    void setPairDownforce( int vehicleID, float downforce );

    void useWheelParticle( int vehicleID, int wheelIndex, int useParticle [0 or 1] );
    void setWheelParticle( int vehicleID, int wheelIndex, string particleName );
    void setWheelParticlePosition( int vehicleID, int wheelIndex, float x, float y, float z );
    void setWheelParticleEnabled( int vehicleID, int wheelIndex, int isEnabled [0 or 1] );

    void setCenterOfMass( int vehicleID, float offsetX, float offsetY, float offsetZ );
    void setLatWheelFrictionStiffness( int vehicleID, int wheelIndex, float stiffnessFactor );
    void setLongWheelFrictionStiffness( int vehicleID, int wheelIndex, float stiffnessFactor );
    void setLatWheelFrictionSettings( int vehicleID, int wheelIndex, float asymptoteSlip, float asymptoteValue, float extremumSlip, float extremumValue, float stiffnessFactor );
    void setLongWheelFrictionSettings( int vehicleID, int wheelIndex, float asymptoteSlip, float asymptoteValue, float extremumSlip, float extremumValue, float stiffnessFactor );
    void setSuspensionSettings( int vehicleID, int wheelIndex, float damperAmt, float springAmt, float targetValue, float suspensionTravel );

    void showDebug( int vehicleID, int showDebug[0 or 1] );
    void setCustomDebugMaterial( int vehicleID, string customDebugMaterialName );

    void useSound( int vehicleID, int soundEnumSection, int useSound[0 or 1] );
    void setSound( int vehicleID, int soundEnumSection, string soundFile );
    void setVolume( int vehicleID, int soundEnumSection, float volume );
    void setPitch( int vehicleID, int soundEnumSection, float pitch );
    void setLength( int vehicleID, int soundEnumSection, float length );
    void setLooped( int vehicleID, int soundEnumSection, int isLooped[0 or 1] );

    void accelerate( int vehicleID );
    void decelerate( int vehicleID );

    void steerLeft( int vehicleID, int overrideSteering, float steeringAngle );
    
    void steerRight( int vehicleID, int overrideSteering, float steeringAngle);

    void handBrake( int vehicleID, float torque );

    void applyForce( int vehicleID, float axizX, float axizY, float axizZ );
    void applyForceAtPoint( int vehicleID, float axizX, float axizY, float axizZ, float posX, float posY, float posZ );

    float getMaxBrakeForce( int vehicleID );

    int getMoveDirection( int vehicleID );

    void applyLocalForce( int vehicleID, float axizX, float axizY, float axizZ );
    
    void applyLocalForceAtPoint( int vehicleID, float axizX, float axizY, float axizZ, float posX, float posY, float posZ );
    
    int getWheel_ContactGround( int vehicleID, int wheelIndex );
    
    float3 getWheel_ContactPoint( int vehicleID, int wheelIndex );
    
    float getWheel_ContactPosition( int vehicleID, int wheelIndex );
    
    float3 getWheel_ContactNormal( int vehicleID, int wheelIndex );
    
    float getWheel_ContactForce( int vehicleID, int wheelIndex );
    
    float3 getWheel_LateralDirection( int vehicleID, int wheelIndex );
        
    float getWheel_LateralImpulse( int vehicleID, int wheelIndex );

    float getWheel_LateralSlip( int vehicleID, int wheelIndex );
    
    float3 getWheel_LongitudalDirection( int vehicleID, int wheelIndex );

    float getWheel_LongitudalImpulse( int vehicleID, int wheelIndex );

    float getWheel_LongitudalSlip( int vehicleID, int wheelIndex );

    void enableAutoMaxSteer(int vehicleID, int state);

    int getAutoMaxSteerEnabled(int vehicleID);
    
    void setSteeringMulti(int vehicleID, float multi);

    float getSteeringMulti(int vehicleID);



    void followPath(int vehicleID, string pathName, float throttle);
    
    int isFollowingPath(int vehicleID);

    string getFollowPathName(int vehicleID);
    
    void setPathAccuracy(int vehicleID, float accuracy);

    void setPathMaxTurn(int vehicleID, float maxTurn);
    
    void setPathNodeIndex(int vehicleID, int nodeIndex);
    
    void followPathPosition(int vehicleID, float x, float y, float z);

    int isDestinationReached(int vehicleID);

    vehicle.setTagOffset(vehID, wheelID, offset);

    vehicle.getTagOffset(vehID, wheelID);

};