GameScript.h

Go to the documentation of this file.

/*
    This source file is part of Rigs of Rods
    Copyright 2005-2012 Pierre-Michel Ricordel
    Copyright 2007-2012 Thomas Fischer
    Copyright 2013-2020 Petr Ohlidal
 
    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/>.
*/
 
 
#pragma once
 
#include "Application.h"
 
#include <angelscript.h>
#include <scriptdictionary/scriptdictionary.h>
 
namespace RoR {
 
 
class GameScript
{
public:
    // PLEASE maintain the same order as in GameScriptAngelscript.cpp!
 
 
    void log(const Ogre::String& msg);
 
    float getTime();
 
    void backToMenu();
    void quitGame();
    float getFPS();
    float getAvgFPS();
    float rangeRandom(float from, float to);
 
    int useOnlineAPI(const Ogre::String& apiquery, const AngelScript::CScriptDictionary& dict, Ogre::String& result);
 
    void openUrlInDefaultBrowser(const std::string& url);
 
    void fetchUrlAsStringAsync(const std::string& url, const std::string& display_filename);
 
    bool pushMessage(MsgType type, AngelScript::CScriptDictionary* dict);
 
    bool checkResourceExists(const std::string& filename, const std::string& resource_group);
 
    bool deleteResource(const std::string& filename, const std::string& resource_group);
 
    std::string loadTextResourceAsString(const std::string& filename, const std::string& resource_group);
 
    bool createTextResourceFromString(const std::string& data, const std::string& filename, const std::string& resource_group, bool overwrite=false);
 
    Ogre::SceneManager* getSceneManager();
 
    AngelScript::CScriptArray* findResourceFileInfo(const std::string& resource_group, const std::string& pattern, bool dirs = false);
 
    Ogre::Image loadImageResource(const std::string& filename, const std::string& resource_group);
 
    bool serializeMeshResource(const std::string& filename, const std::string& resource_group, const Ogre::MeshPtr& mesh);
 
 
 
    void flashMessage(Ogre::String& txt, float time, float charHeight);
 
    void message(Ogre::String& txt, Ogre::String& icon);
 
    int getChatFontSize();
 
    void setChatFontSize(int size);
 
    void showMessageBox(Ogre::String& title, Ogre::String& text, bool use_btn1, Ogre::String& btn1_text, bool allow_close, bool use_btn2, Ogre::String& btn2_text);
 
    void showChooser(const Ogre::String& type, const Ogre::String& instance, const Ogre::String& box);
 
    void updateDirectionArrow(Ogre::String& text, Ogre::Vector3& vec);
 
    void hideDirectionArrow();
 
    bool getScreenPosFromWorldPos(Ogre::Vector3 const& world_pos, Ogre::Vector2& out_screen_pos);
 
    Ogre::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_t addScriptFunction(const Ogre::String& arg, ScriptUnitID_t nid);
 
    ScriptRetCode_t scriptFunctionExists(const Ogre::String& arg, ScriptUnitID_t nid);
 
    ScriptRetCode_t deleteScriptFunction(const Ogre::String& arg, ScriptUnitID_t nid);
 
    ScriptRetCode_t addScriptVariable(const Ogre::String& arg, ScriptUnitID_t nid);
 
    ScriptRetCode_t scriptVariableExists(const Ogre::String& arg, ScriptUnitID_t nid);
 
    ScriptRetCode_t deleteScriptVariable(const Ogre::String& arg, ScriptUnitID_t nid);
 
    ScriptRetCode_t getScriptVariable(const Ogre::String& varName, void *ref, int refTypeId, ScriptUnitID_t nid);
 
    void clearEventCache();
 
    int sendGameCmd(const Ogre::String& message);
 
    AngelScript::CScriptArray* getRunningScripts();
 
    AngelScript::CScriptDictionary* getScriptDetails(ScriptUnitID_t nid);
 
 
    
    void loadTerrain(const Ogre::String& terrain);
 
    int getLoadedTerrain(Ogre::String& result);
 
    bool getCaelumAvailable();
 
    Ogre::String getCaelumTime();
 
    void setCaelumTime(float value);
 
    float getGravity();
 
    void setGravity(float value);
 
    float getGroundHeight(Ogre::Vector3& v);
 
    float getWaterHeight();
 
    void setWaterHeight(float value);
 
    void spawnObject(const Ogre::String& objectName, const Ogre::String& instanceName, const Ogre::Vector3& pos, const Ogre::Vector3& rot, const Ogre::String& eventhandler, bool uniquifyMaterials);
 
    void moveObjectVisuals(const Ogre::String& instanceName, const Ogre::Vector3& pos);
 
    void destroyObject(const Ogre::String& instanceName);
 
    AngelScript::CScriptArray* getEditorObjects();
 
    bool getMousePositionOnTerrain(Ogre::Vector3& out_pos);
 
    AngelScript::CScriptArray* getMousePointedMovableObjects();
 
    TerrainPtr getTerrain();
 
 
 
    Ogre::Vector3 getPersonPosition();
    
    void setPersonPosition(const Ogre::Vector3& vec);
 
    void movePerson(const Ogre::Vector3& vec);
 
    void setPersonRotation(const Ogre::Radian& rot);
 
    Ogre::Radian getPersonRotation();
 
 
 
    void activateAllVehicles();
 
    void setTrucksForcedAwake(bool forceActive);
 
    //anglescript test
    void boostCurrentTruck(float factor);
 
    ActorPtr getCurrentTruck();
 
    ActorPtr getTruckByNum(int num);
 
    AngelScript::CScriptArray* getAllTrucks();
 
    int getCurrentTruckNumber();
 
    ActorPtr spawnTruck(Ogre::String& truckName, Ogre::Vector3& pos, Ogre::Vector3& rot);
 
    void repairVehicle(const Ogre::String& instance, const Ogre::String& box, bool keepPosition);
 
    void removeVehicle(const Ogre::String& instance, const Ogre::String& box);
 
    int getNumTrucksByFlag(int flag);
 
    ActorPtr getTruckRemotelyReceivingCommands();
 
    ActorInstanceID_t getActorNextInstanceId();
 
 
 
    FreeForceID_t getFreeForceNextId();
 
    FreeBeamGfxID_t getFreeBeamGfxNextId();
 
 
 
    ActorPtr spawnTruckAI(Ogre::String& truckName, Ogre::Vector3& pos, Ogre::String& truckSectionConfig, std::string& truckSkin, int x);
    AngelScript::CScriptArray* getWaypoints(int x);
    AngelScript::CScriptArray* getWaypointsSpeed();
    void addWaypoint(const Ogre::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();
    VehicleAIPtr getCurrentTruckAI();
    VehicleAIPtr 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, std::string name);
    void setAIVehicleSectionConfig(int x, std::string config);
    void setAIVehicleSkin(int x, std::string skin);
    void setAIRepeatTimes(int times);
    void setAIMode(int mode);
 
 
 
    void setCameraPosition(const Ogre::Vector3& pos);
 
    void setCameraDirection(const Ogre::Vector3& vec);
 
    void setCameraOrientation(const Ogre::Quaternion& q);
 
    void setCameraRoll(float angle);
 
    void setCameraYaw(float angle);
 
    void setCameraPitch(float angle);
 
    Ogre::Vector3 getCameraPosition();
 
    Ogre::Vector3 getCameraDirection();
 
    Ogre::Quaternion getCameraOrientation();
 
    void cameraLookAt(const Ogre::Vector3& targetPoint);
 
 
 
    void stopTimer();
    void startTimer(int id);
    void setTimeDiff(float diff);
    void setBestLapTime(float time);
 
 
 
    int setMaterialAmbient(const Ogre::String& materialName, float red, float green, float blue);
    int setMaterialDiffuse(const Ogre::String& materialName, float red, float green, float blue, float alpha);
    int setMaterialSpecular(const Ogre::String& materialName, float red, float green, float blue, float alpha);
    int setMaterialEmissive(const Ogre::String& materialName, float red, float green, float blue);
    int setMaterialTextureName(const Ogre::String& materialName, int techniqueNum, int passNum, int textureUnitNum, const Ogre::String& textureName);
    int setMaterialTextureRotate(const Ogre::String& materialName, int techniqueNum, int passNum, int textureUnitNum, float rotation);
    int setMaterialTextureScroll(const Ogre::String& materialName, int techniqueNum, int passNum, int textureUnitNum, float sx, float sy);
    int setMaterialTextureScale(const Ogre::String& materialName, int techniqueNum, int passNum, int textureUnitNum, float u, float v);
 
 
 
    AngelScript::CScriptArray* getAllSoundScriptTemplates();
    SoundScriptTemplatePtr     getSoundScriptTemplate(const std::string& name);
    AngelScript::CScriptArray* getAllSoundScriptInstances();
 
    SoundPtr                   createSoundFromResource(const std::string& filename, const std::string& resource_group_name);
 
    SoundScriptInstancePtr     createSoundScriptInstance(const std::string& template_name, int actor_instance_id /*= SoundScriptInstance::ACTOR_ID_UNKNOWN*/);
 
 
private:
 
    bool HaveSimTerrain(const char* func_name); 
    bool HavePlayerAvatar(const char* func_name); 
    bool HaveMainCamera(const char* func_name); 
    std::string CheckFileAccess(const char* func_name, const std::string& filename, const std::string& resource_group); 
    int getTextureUnitState(Ogre::TextureUnitState** tu, const Ogre::String materialName, int techniqueNum, int passNum, int textureUnitNum);
 
    void logFormat(const char* fmt, ...);
};
 
 
} // namespace RoR