Addons.h
No OneTemporary
Actions

Authored By

Unknown

Size

7 KB

Referenced Files

None

Subscribers

None

Addons.h
View Options

	/*
	* Copyright (C) 2011-2013 Me and My Shadow
	*
	* This file is part of Me and My Shadow.
	*
	* Me and My Shadow is free software: you can redistribute it and/or modify
	* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation, either version 3 of the License, or
	* (at your option) any later version.
	*
	* Me and My Shadow 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 Me and My Shadow. If not, see <http://www.gnu.org/licenses/>.
	*/

	#ifndef ADDONS_H
	#define ADDONS_H

	#include "GameState.h"
	#include "GameObjects.h"
	#include "GUIObject.h"
	#include "GUIListBox.h"
	#include "FileDownload.h"
	#include "ThemeManager.h"
	#include <array>
	#include <vector>
	#include <string>

	class DownloadAnimationOverlay;
	class DownloadImage;

	//The addons menu.
	class Addons : public GameState, public GUIEventCallback {
	friend class DownloadAnimationOverlay;
	friend class DownloadImage;
	private:
	//The minimum addon version that is supported.
	static const int MIN_VERSION=2;
	//The maximum addon version that is supported.
	static const int MAX_VERSION=2;

	//An addon entry.
	struct Addon{
	//The name of the addon.
	std::string name;
	//The type of addon. (Level, Levelpack, Theme)
	std::string type;
	//The link to the addon file.
	std::string file;
	//The name of the author.
	std::string author;

	//The description of the addon.
	std::string description;
	//The license of the addon.
	std::string license;
	//The website of the addon.
	std::string website;

	//Icon for the addon.
	std::string iconMD5;
	//Screenshot for the addon.
	std::string screenshotMD5;

	//The latest version of the addon.
	int version;
	//The version that the user has installed, if installed.
	int installedVersion;

	//Boolean if the addon is installed.
	bool installed;
	//Boolean if the addon is upToDate. (installedVersion==version)
	bool upToDate;

	//Map that contains the content of the addon.
	//NOTE: This is only filled if the addon is installed.
	std::vector<std::pair<std::string,std::string> > content;
	//Array that holds the name of the addons it's dependent on.
	//NOTE: This is only filled if the addon is installed.
	std::vector<std::pair<std::string,std::string> > dependencies;
	};

	//The title.
	TexturePtr title;

	//Placeholder icons for addons in case they don't provide custom icons.
	std::map<std::string, SDL_Surface*> addonIcon;

	//Placeholder screenshot for addons in case they don't provide one.
	SharedTexture screenshot;

	//Map containing a vector of Addons for each addon category.
	std::vector<Addon> addons;

	//String that should contain the error when something fails.
	std::string error;

	//The type of addon that is currently selected.
	std::string type;
	//Pointer to the addon that is selected.
	Addon* selected;

	//The list used for the selecting of the category.
	GUISingleLineListBox* categoryList;
	//Pointer to the description.
	GUIObject* categoryDescription;
	//The list used for listing the addons.
	GUIListBox* list;

	//The walking animation used when downloading.
	ThemeBlockInstance walkingAnimation;

	//Boolean indicating if we are downloading addon list (set to true when the class is created)
	bool isDownloadingAddonList;

	//The currently downloading addon icon
	std::string downloadingAddonIconMD5;

	//The cached image URL, use MD5 as key.
	std::map<std::string, std::string> cachedImageURL;

	public:
	//The file download object.
	FileDownload fileDownload;

	//Constructor.
	Addons(SDL_Renderer& renderer, ImageManager& imageManager);
	//Destructor.
	~Addons();

	//Inherited from GameState.
	void handleEvents(ImageManager&, SDL_Renderer&) override;
	void logic(ImageManager&, SDL_Renderer&) override;
	void render(ImageManager&, SDL_Renderer& renderer) override;
	void resize(ImageManager &imageManager, SDL_Renderer& renderer) override;

	//Method used for GUI event handling.
	//name: The name of the callback.
	//obj: Pointer to the GUIObject that caused the event.
	//eventType: The type of event: click, change, etc..
	void GUIEventCallback_OnEvent(ImageManager& imageManager, SDL_Renderer& renderer, std::string name,GUIObject* obj,int eventType);

	private:
	//Method that will create the GUI.
	void createGUI(SDL_Renderer &renderer, ImageManager &imageManager);

	//Method that loads the downloaded addons list. NOTE: Called after the downloading is finished!
	//Returns: True if the file is loaded successfuly.
	bool loadAddonsList(SDL_Renderer& renderer, ImageManager& imageManager);

	void fillAddonList(TreeStorageNode &objAddons, TreeStorageNode &objInstalledAddons, SDL_Renderer& renderer, ImageManager& imageManager);
	//Put all the addons of a given type in a vector.
	//type: The type the addons must be.
	//Returns: Vector containing the addons.
	void addonsToList(const std::string &type, SDL_Renderer &renderer, ImageManager &imageManager, bool recreate);

	//Method that will save the installed addons to the installed_addons file.
	//Returns: True if the file is saved successfuly.
	bool saveInstalledAddons();

	//Method for loading an addon icon image and downloading if it isn't cached.
	//md5sum: The md5sum used for caching.
	//Returns: Pointer to the loaded image. NULL means load failed or it is still downloading.
	//In the second case, when the download finished the addonsToList() will be called again to update the list.
	SDL_Surface* loadAddonIconImage(const std::string& md5sum, ImageManager& imageManager);

	//Method that will open a GUIOverlay with the an overview of the selected addon.
	void showAddon(ImageManager& imageManager, SDL_Renderer& renderer);

	//This method will remove the addon based on the content vector.
	//NOTE It doesn't check if the addon is installed or not.
	//addon: The addon to remove.
	void removeAddon(ImageManager& imageManager,SDL_Renderer &renderer, Addon* addon);
	//This method will install the addon by downloading, extracting and reading.
	//NOTE It doesn't check if the addon is installed or not.
	//addon: The addon to install.
	//update: True means call removeAddon() first.
	//(WARNING: No sanity check!!! It is caller's responsibility to check if the addon is actually installed!!!)
	FileDownload::DownloadStatus installAddon(ImageManager& imageManager, SDL_Renderer &renderer, Addon* addon, bool update = false);

	//This method only download the addon.
	//addon: The addon to install.
	FileDownload::DownloadStatus downloadAddon(ImageManager& imageManager, SDL_Renderer &renderer, Addon* addon);

	//This method will install the addon from the downloaded zip file.
	//NOTE It doesn't check if the addon is installed or not.
	//addon: The addon to install.
	void installAddonFromFile(ImageManager& imageManager, SDL_Renderer &renderer, Addon* addon);

	void renderDownloadingAnimation(ImageManager &imageManager, SDL_Renderer& renderer);
	};
	#endif

File Metadata

Mime Type: text/x-c++
Expires: Sat, Nov 14, 11:12 PM (1 d, 11 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 120074
Default Alt Text: Addons.h (7 KB)

Addons.hNo OneTemporaryActions

Addons.hView Options

File Metadata

Event Timeline

Addons.h
No OneTemporary
Actions

Addons.h
View Options