LUA_API_Entity.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 entity
{
public:

    int spawn( string meshFilename, float posX, float posY, float posZ, float scaleX, float scaleY, float scaleZ );
    
    void setPosition( int entityID, float posX, float posY, float posZ);


    void setPos( int entityID, Table pos);


    float3 getPosition( int entityID );

    float3 getLocalPosition( int entityID );

    float3 getWorldPosition( int entityID );

    void setScale( int entityID, float scaleX, float scaleY, float scaleZ );
    
    float3 subtractPositions(int entityID_1, int entityID_2);

    float3 subtractPositions_float3(float x1, float y1, float z1, float x2, float y2, float z2);


    void delete( int entityID );

    void addScript( int entityID, string scriptName );

    void setShadow(int entityID ,int enabledState);

    void setVisible(int entityID ,int enabledState);

    void setVisibleDistance(int entityID, float distance);

    void setStatic(int entityID, int state);

    void setRotation( int entityID, float rotX, float rotY, float rotZ );

    void roll( int entityID, float angle, int DegreeOrRadian);
        
    void pitch( int entityID, float angle );
        
    void yaw( int entityID, float angle );

    void setFixedYaw( int entityID, int check[0 or 1] );


    void turn( int objID, float pitch, float yaw, float roll );

    void move( int objID, float pitch, float yaw, float roll );


    float4 getRotationTo(float srcRotX, float srcRotY, float srcRotZ, float destRotX, float destRotY, float destRotZ);

    float3 getRadialOffset(int objID, float radiusOffset, float posx, float posy, float posz);

    float3 getDirection( int entityID_1, int entityID_2 );

    float3 getForward( int entityID );

    float3 getRight( int entityID );
    
    float3 getUp( int entityID );

    float3 getDirectionOfEntity( int entityID );

    void setDirection( int entityID, float dirX, float dirY, float dirZ );

    float4 getWorldOrientation( int entityID );
    
    float3 getWorldOrientationByAxis( int entityID, int axisX, int axisY, int axisZ );

    void setWorldOrientation( int entityID,int rotW, int rotX, int rotY, int rotZ );        

    float4 getLocalOrientation( int entityID );     

    float3 getLocalOrientationByAxis(int entityID, int axisX, int axisY, int axisZ);

    void setLocalOrientation( int entityID, int rotW, int rotX, int rotY, int rotZ );       

    void lookatObject(int entityID, int targetID, float rotProgress, int axisX, int axisY, int axisZ ); 
    
    void lookatPosition( int entityID, float lookAtPosX, float lookAtPosY, float lookAtPosZ, float rotProgress, int axisX, int axisY, int axisZ);

    void setQueryFlag_DoNotSelect( int entityID );

    void setQueryFlag_Model( int entityID );        

    void setQueryFlag( int entityID, int QueryFlag );

    int getIDFromTag( string entityTagName );   

    int getTagFromID(int entityID);



    int getDescription(int entityID);

    int setDescription(int entityID, string description);

    int setTag(int entityID, string tag);

    String getName( int objID );        
    
     setName(int objID, string name);



    int getLastHitID();

    int isColliding(int objID ,float direction_x,float direction_y, float direction_z,float range,int queryflag); 


    int exist(int entityID);


    void setMaterialName(int objId, string materialName); 

    void setSubMaterialName(int objId, int subentityIndex, string materialName); 
        
    void getMaterialName(int objId, int subentityIndex); 

    int getNumSubEntities();
        
    void callPublicFn(entityID, targetID, value);


    
    void callFn(int entityID, int targetID, String functionName, String arg);


    void attach(int parentID, int childID);

    void detach(int parentID, int childID);
    
    /*FIXME*/
    float getElevation(int objectID, int TargetID);//get the pitch angle between the 2 objects

    float getHeading(int objectID, int TargetID);

    float getHeadingV3(int objectID, float x, float y, float z);

    float getSquaredDistance(int objectID, int TargetID);

    float getDistance(int objectID, int TargetID);

    float3 inverseTransform( int entityID, float x, float y, float z ); 



    entity.followPath( entityID, Pathname, Speed, (opt) useRoll);

    int getDistanceToVector(obj,x,y,z);

    int setAdvancedMaterial(id, materialname);

    float getBoundingSize(objID);


    float getBoundingRadius(objID);

    float getBoundingMinimum(objID);

    float getBoundingMaximum(objID)

    
    float getScale();

    float getDynamicProperty( eID, paramName )

    
    float setDynamicProperty( eID, paramName, paramValue );

    void entity.refreshDynamicProperties();

    void rotateToSurface( eID, normalx, normaly, normalz, qw, qx, qy, qz );

    float distance = entity.getDistanceToCamera(objID);

    bool setStatic(bool state);

    float setVisibleDistance(float distaance);

    string getMeshName(objID);

    int registerTodEvent(int objID);

    int removeRegisteredTodEvent(int objID);
};