GameScriptClass.h

Go to the documentation of this file.

/*
This source file is part of Rigs of Rods
 
For more information, see http://www.rigsofrods.org/
 
Rigs of Rods is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3, as 
published by the Free Software Foundation.
 
Rigs of Rods is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with Rigs of Rods.  If not, see <http://www.gnu.org/licenses/>.
*/
// created on 23th May 2011 by neorej16
 
namespace Script2Game {
 
class GameScriptClass
{
public:
    // PLEASE maintain the same order as in GameScript.h and GameScriptAngelscript.cpp!
 
 
    void log(string message);
 
    double getTime();
    
    float rangeRandom(float from, float to);
 
    int useOnlineAPI(const string apiquery, const dictionary dict, string result);
    
    void getFPS();
    
    void getAvgFPS();
 
    void backToMenu();
 
    void quitGame();
    
    bool pushMessage(MsgType type, dictionary@ dict);
    
    bool checkResourceExists(const string &in filename, const string &in resource_group);
 
    bool deleteResource(const string &in filename, const string &in resource_group);
 
    std::string loadTextResourceAsString(const string &in filename, const string &in resource_group);
 
    bool createTextResourceFromString(const string &in, const string &in filename, const string &in resource_group, bool overwrite=false);
 
    AngelOgre::SceneManager@ getSceneManager();
 
    void openUrlInDefaultBrowser(const std::string& url);
 
    void fetchUrlAsStringAsync(const std::string& url, const std::string& display_filename);
 
 
 
    void flashMessage(string message, float time, float charHeight);
 
    void message(string txt, string icon, float timeMilliseconds, bool forceVisible);
 
    int getChatFontSize();
 
    void setChatFontSize(int size);
 
    void showMessageBox(string mTitle, stringmText, bool button1, stringmButton1, bool AllowClose, bool button2, stringmButton2);
 
    void showChooser(string type, string instance, string box);
 
    void updateDirectionArrow(string text, vector3 position);
 
    void hideDirectionArrow();
 
    bool getScreenPosFromWorldPos(const vector3&in, vector2&out);
    
    vector2 getDisplaySize();
    
    Ogre::Vector2 getMouseScreenPosition();    
 
 
 
    void registerForEvent(int eventValue);
    
    void unRegisterEvent(int eventValue);
 
    BitMask_t getRegisteredEventsMask(ScriptUnitId_t nid);
 
    void setRegisteredEventsMask(ScriptUnitId_t nid, BitMask_t eventMask);
    
    ScriptRetCode addScriptFunction(const string func, ScriptUnitId_t nid = -2);
    
    ScriptRetCode scriptFunctionExists(const string func, ScriptUnitId_t nid = -2);
    
    ScriptRetCode deleteScriptFunction(const string func, ScriptUnitId_t nid = -2);
    
    ScriptRetCode addScriptVariable(const string var, ScriptUnitId_t nid = -2);
    
    ScriptRetCode scriptVariableExists(const string var, ScriptUnitId_t nid = -2);    
    
    ScriptRetCode deleteScriptVariable(const string var, ScriptUnitId_t nid = -2);
    
    ScriptRetCode getScriptVariable(const string&in varName, ?&ref, ScriptUnitId_t nid = -2);    
 
    void clearEventCache();
    
    int sendGameCmd(const string& message);    
    
    array<int> getRunningScripts();
 
    dictionary@ getScriptDetails(int nid);    
 
 
    
    void loadTerrain(string terrain);
    
    int getLoadedTerrain(string result);
    
    TerrainClass@ getTerrain();
    
    bool getCaelumAvailable();
    
    string getCaelumTime();
    
    void setCaelumTime(float value);
    
    float getGravity();
    
    void setGravity(float value);
    
    float getWaterHeight();
 
    float getGroundHeight(vector3 position);
 
    void setWaterHeight(float value);
    
    void spawnObject(const string objectName, const string instanceName, vector3 pos, vector3 rot, const string eventhandler, bool uniquifyMaterials);
    
    void moveObjectVisuals(const string instanceName, const vector3 pos);
 
    void destroyObject(const string instanceName);
    
    array<TerrainEditorObjectClassPtr@>@ getEditorObjects();
 
    
    bool getMousePositionOnTerrain(vector3 &out);
 
    array<Ogre::MovableObjects@> getMousePointedMovableObjects();
 
 
 
    vector3 getPersonPosition();
 
    void setPersonPosition(vector3 vec);
 
    void movePerson(vector3 relative_movement);
    
    void setPersonRotation(radian &in);
    
    radian getPersonRotation();
 
 
        
    void activateAllVehicles();
 
    void setTrucksForcedAwake(bool forceActive);        
        
    void boostCurrentTruck(float factor);        
 
    BeamClass@ getCurrentTruck();
 
    BeamClass@ getTruckByNum(int truck_number);
 
    array<BeamClass@> getAllTrucks();
 
    int getCurrentTruckNumber();
    
    BeamClass @spawnTruck(stringtruckName, vector3 pos, vector3 rot);
    
    void repairVehicle(string instance, string box, bool keepPosition);
    
    void removeVehicle(string instance, string box);
 
    int getNumTrucksByFlag(int flag);
    
    int getActorNextInstanceId();
    
    BeamClass @getTruckRemotelyReceivingCommands();    
    
    
 
    FreeForceID_t getFreeForceNextId();
 
    FreeBeamGfxID_t getFreeBeamGfxNextId();
 
    
 
    BeamClass@ spawnTruckAI(string truckName, vector3 pos, string truckSectionConfig, string truckSkin, int x);
    array<vector3>@ getWaypoints(int x);
    void addWaypoint(vector3 pos);
    int getAIVehicleCount();
    int getAIVehicleDistance();
    int getAIVehiclePositionScheme();
    int getAIVehicleSpeed();
    Ogre::String getAIVehicleName(int x);
    Ogre::String getAIVehicleSectionConfig(int x);
    std::string getAIVehicleSkin(int x);
    int getAIRepeatTimes();
    int getAIMode();
    VehicleAIClass@ getCurrentTruckAI();
    VehicleAIClass@ getTruckAIByNum(int num);
    
    // AI: set
    void setAIVehicleCount(int count);
    void setAIVehicleDistance(int dist);
    void setAIVehiclePositionScheme(int scheme);
    void setAIVehicleSpeed(int speed);
    void setAIVehicleName(int x, string name);
    void setAIVehicleSectionConfig(int x, string config);
    void setAIVehicleSkin(int x, string skin);
    void setAIRepeatTimes(int times);  
    void setAIMode(int mode);    
 
 
    
    void setCameraPosition(vector3 position);
    
    void setCameraDirection(vector3 direction);
    
    void setCameraRoll(float angle);
 
    void setCameraYaw(float angle);
 
    void setCameraPitch(float angle);
    
    vector3 getCameraPosition();
    
    vector3 getCameraDirection();
    
    void cameraLookAt(vector3 targetPoint);
 
 
 
    float stopTimer();
 
    void startTimer();
 
 
 
    int setMaterialAmbient(const string materialName, float red, float green, float blue);
    int setMaterialDiffuse(const string materialName, float red, float green, float blue, float alpha);
    int setMaterialSpecular(const string materialName, float red, float green, float blue, float alpha);
    int setMaterialEmissive(const string materialName, float red, float green, float blue);
    
    int setMaterialTextureName(const string materialName, int techniqueNum, int passNum, int textureUnitNum, const string textureName);
    int setMaterialTextureRotate(const string materialName, int techniqueNum, int passNum, int textureUnitNum, float rotation);
    int setMaterialTextureScroll(const string materialName, int techniqueNum, int passNum, int textureUnitNum, float sx, float sy);
    int setMaterialTextureScale(const string materialName, int techniqueNum, int passNum, int textureUnitNum, float u, float v);
 
    
 
    array<SoundScriptTemplateClass> getAllSoundScriptTemplates();
    
    SoundScriptTemplateClass getSoundScriptTemplate(const string &in name);
    
    array<SoundScriptInstanceClass> getAllSoundScriptInstances();
    
    SoundClass createSoundFromResource(const string &in filename, const string &in resource_group_name = string());
 
    SoundScriptInstanceClass createSoundScriptInstance(const string &in template_name, int actor_instance_id = -1); 
 
};
 
 
} //namespace Script2Game